Gentoo Archives: gentoo-commits

From: "André Erdmann" <dywi@×××××××.de>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/R_overlay:master commit in: doc/html/
Date: Fri, 02 Aug 2013 14:41:32
Message-Id: 1375453779.edd0452a932e4fb0e063fd3c3aff11826bca6cfe.dywi@gentoo
1 commit: edd0452a932e4fb0e063fd3c3aff11826bca6cfe
2 Author: André Erdmann <dywi <AT> mailerd <DOT> de>
3 AuthorDate: Fri Aug 2 14:29:39 2013 +0000
4 Commit: André Erdmann <dywi <AT> mailerd <DOT> de>
5 CommitDate: Fri Aug 2 14:29:39 2013 +0000
6 URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=edd0452a
7
8 update doc/html/usage.html
9
10 ---
11 doc/html/usage.html | 469 +++++++++++++++++++++++++++++++++++++---------------
12 1 file changed, 335 insertions(+), 134 deletions(-)
13
14 diff --git a/doc/html/usage.html b/doc/html/usage.html
15 index 2dbe25f..16fbbe9 100644
16 --- a/doc/html/usage.html
17 +++ b/doc/html/usage.html
18 @@ -329,141 +329,147 @@ ul.auto-toc {
19 <div class="contents topic" id="contents">
20 <p class="topic-title first">Contents</p>
21 <ul class="auto-toc simple">
22 -<li><a class="reference internal" href="#introduction" id="id5">1&nbsp;&nbsp;&nbsp;Introduction</a></li>
23 -<li><a class="reference internal" href="#installation" id="id6">2&nbsp;&nbsp;&nbsp;Installation</a><ul class="auto-toc">
24 -<li><a class="reference internal" href="#prerequisites" id="id7">2.1&nbsp;&nbsp;&nbsp;Prerequisites</a></li>
25 -<li><a class="reference internal" href="#via-emerge-gentoo" id="id8">2.2&nbsp;&nbsp;&nbsp;via emerge (Gentoo)</a></li>
26 -<li><a class="reference internal" href="#manual-installation" id="id9">2.3&nbsp;&nbsp;&nbsp;Manual Installation</a></li>
27 -<li><a class="reference internal" href="#using-roverlay-without-installation" id="id10">2.4&nbsp;&nbsp;&nbsp;Using <em>roverlay</em> without installation</a></li>
28 +<li><a class="reference internal" href="#introduction" id="id6">1&nbsp;&nbsp;&nbsp;Introduction</a></li>
29 +<li><a class="reference internal" href="#installation" id="id7">2&nbsp;&nbsp;&nbsp;Installation</a><ul class="auto-toc">
30 +<li><a class="reference internal" href="#prerequisites" id="id8">2.1&nbsp;&nbsp;&nbsp;Prerequisites</a></li>
31 +<li><a class="reference internal" href="#via-emerge-gentoo" id="id9">2.2&nbsp;&nbsp;&nbsp;via emerge (Gentoo)</a></li>
32 +<li><a class="reference internal" href="#manual-installation" id="id10">2.3&nbsp;&nbsp;&nbsp;Manual Installation</a></li>
33 +<li><a class="reference internal" href="#using-roverlay-without-installation" id="id11">2.4&nbsp;&nbsp;&nbsp;Using <em>roverlay</em> without installation</a></li>
34 </ul>
35 </li>
36 -<li><a class="reference internal" href="#running-roverlay" id="id11">3&nbsp;&nbsp;&nbsp;Running Roverlay</a><ul class="auto-toc">
37 -<li><a class="reference internal" href="#required-configuration-steps" id="id12">3.1&nbsp;&nbsp;&nbsp;Required configuration steps</a><ul class="auto-toc">
38 -<li><a class="reference internal" href="#extended-configuration-where-to-go-from-here" id="id13">3.1.1&nbsp;&nbsp;&nbsp;Extended Configuration / Where to go from here?</a></li>
39 +<li><a class="reference internal" href="#running-roverlay" id="id12">3&nbsp;&nbsp;&nbsp;Running Roverlay</a><ul class="auto-toc">
40 +<li><a class="reference internal" href="#required-configuration-steps" id="id13">3.1&nbsp;&nbsp;&nbsp;Required configuration steps</a><ul class="auto-toc">
41 +<li><a class="reference internal" href="#extended-configuration-where-to-go-from-here" id="id14">3.1.1&nbsp;&nbsp;&nbsp;Extended Configuration / Where to go from here?</a></li>
42 </ul>
43 </li>
44 -<li><a class="reference internal" href="#running-it" id="id14">3.2&nbsp;&nbsp;&nbsp;Running it</a></li>
45 -<li><a class="reference internal" href="#providing-a-package-mirror" id="id15">3.3&nbsp;&nbsp;&nbsp;Providing a package mirror</a></li>
46 +<li><a class="reference internal" href="#running-it" id="id15">3.2&nbsp;&nbsp;&nbsp;Running it</a></li>
47 +<li><a class="reference internal" href="#providing-a-package-mirror" id="id16">3.3&nbsp;&nbsp;&nbsp;Providing a package mirror</a></li>
48 +<li><a class="reference internal" href="#roverlay-helpers" id="id17">3.4&nbsp;&nbsp;&nbsp;roverlay helpers</a></li>
49 </ul>
50 </li>
51 -<li><a class="reference internal" href="#basic-implementation-overview" id="id16">4&nbsp;&nbsp;&nbsp;Basic Implementation Overview</a><ul class="auto-toc">
52 -<li><a class="reference internal" href="#how-roverlay-works" id="id17">4.1&nbsp;&nbsp;&nbsp;How <em>roverlay</em> works</a></li>
53 -<li><a class="reference internal" href="#expected-overlay-result-structure-of-the-generated-overlay" id="id18">4.2&nbsp;&nbsp;&nbsp;Expected Overlay Result / Structure of the generated overlay</a><ul class="auto-toc">
54 -<li><a class="reference internal" href="#expected-ebuild-result" id="id19">4.2.1&nbsp;&nbsp;&nbsp;Expected Ebuild Result</a></li>
55 -<li><a class="reference internal" href="#expected-metadata-xml-result" id="id20">4.2.2&nbsp;&nbsp;&nbsp;Expected <em>metadata.xml</em> Result</a></li>
56 +<li><a class="reference internal" href="#basic-implementation-overview" id="id18">4&nbsp;&nbsp;&nbsp;Basic Implementation Overview</a><ul class="auto-toc">
57 +<li><a class="reference internal" href="#how-roverlay-works" id="id19">4.1&nbsp;&nbsp;&nbsp;How <em>roverlay</em> works</a></li>
58 +<li><a class="reference internal" href="#expected-overlay-result-structure-of-the-generated-overlay" id="id20">4.2&nbsp;&nbsp;&nbsp;Expected Overlay Result / Structure of the generated overlay</a><ul class="auto-toc">
59 +<li><a class="reference internal" href="#expected-ebuild-result" id="id21">4.2.1&nbsp;&nbsp;&nbsp;Expected Ebuild Result</a></li>
60 +<li><a class="reference internal" href="#expected-metadata-xml-result" id="id22">4.2.2&nbsp;&nbsp;&nbsp;Expected <em>metadata.xml</em> Result</a></li>
61 </ul>
62 </li>
63 </ul>
64 </li>
65 -<li><a class="reference internal" href="#repositories-getting-packages" id="id21">5&nbsp;&nbsp;&nbsp;Repositories / Getting Packages</a><ul class="auto-toc">
66 -<li><a class="reference internal" href="#a-word-about-repo-config-files" id="id22">5.1&nbsp;&nbsp;&nbsp;A word about repo config files</a></li>
67 -<li><a class="reference internal" href="#rsync-repos" id="id23">5.2&nbsp;&nbsp;&nbsp;Rsync repos</a></li>
68 -<li><a class="reference internal" href="#getting-packages-from-a-repository-that-supports-http-only" id="id24">5.3&nbsp;&nbsp;&nbsp;Getting packages from a repository that supports http only</a></li>
69 -<li><a class="reference internal" href="#getting-packages-from-several-remotes-using-http-and-a-package-list" id="id25">5.4&nbsp;&nbsp;&nbsp;Getting packages from several remotes using http and a package list</a></li>
70 -<li><a class="reference internal" href="#using-local-directories" id="id26">5.5&nbsp;&nbsp;&nbsp;Using local directories</a></li>
71 -<li><a class="reference internal" href="#distmap" id="id27">5.6&nbsp;&nbsp;&nbsp;distmap</a></li>
72 +<li><a class="reference internal" href="#repositories-getting-packages" id="id23">5&nbsp;&nbsp;&nbsp;Repositories / Getting Packages</a><ul class="auto-toc">
73 +<li><a class="reference internal" href="#a-word-about-repo-config-files" id="id24">5.1&nbsp;&nbsp;&nbsp;A word about repo config files</a></li>
74 +<li><a class="reference internal" href="#rsync-repos" id="id25">5.2&nbsp;&nbsp;&nbsp;Rsync repos</a></li>
75 +<li><a class="reference internal" href="#getting-packages-from-a-repository-that-supports-http-only" id="id26">5.3&nbsp;&nbsp;&nbsp;Getting packages from a repository that supports http only</a></li>
76 +<li><a class="reference internal" href="#getting-packages-from-several-remotes-using-http-and-a-package-list" id="id27">5.4&nbsp;&nbsp;&nbsp;Getting packages from several remotes using http and a package list</a></li>
77 +<li><a class="reference internal" href="#using-local-directories" id="id28">5.5&nbsp;&nbsp;&nbsp;Using local directories</a></li>
78 +<li><a class="reference internal" href="#distmap" id="id29">5.6&nbsp;&nbsp;&nbsp;distmap</a></li>
79 </ul>
80 </li>
81 -<li><a class="reference internal" href="#additions-directory" id="id28">6&nbsp;&nbsp;&nbsp;Additions Directory</a><ul class="auto-toc">
82 -<li><a class="reference internal" href="#patching-ebuilds" id="id29">6.1&nbsp;&nbsp;&nbsp;Patching ebuilds</a></li>
83 -<li><a class="reference internal" href="#importing-ebuilds" id="id30">6.2&nbsp;&nbsp;&nbsp;Importing ebuilds</a></li>
84 +<li><a class="reference internal" href="#additions-directory" id="id30">6&nbsp;&nbsp;&nbsp;Additions Directory</a><ul class="auto-toc">
85 +<li><a class="reference internal" href="#patching-ebuilds" id="id31">6.1&nbsp;&nbsp;&nbsp;Patching ebuilds</a></li>
86 +<li><a class="reference internal" href="#importing-ebuilds" id="id32">6.2&nbsp;&nbsp;&nbsp;Importing ebuilds</a></li>
87 </ul>
88 </li>
89 -<li><a class="reference internal" href="#dependency-rules" id="id31">7&nbsp;&nbsp;&nbsp;Dependency Rules</a><ul class="auto-toc">
90 -<li><a class="reference internal" href="#simple-dependency-rules" id="id32">7.1&nbsp;&nbsp;&nbsp;Simple Dependency Rules</a><ul class="auto-toc">
91 -<li><a class="reference internal" href="#rule-variants" id="id33">7.1.1&nbsp;&nbsp;&nbsp;Rule Variants</a></li>
92 -<li><a class="reference internal" href="#rule-types" id="id34">7.1.2&nbsp;&nbsp;&nbsp;Rule types</a></li>
93 -<li><a class="reference internal" href="#rule-file-examples" id="id35">7.1.3&nbsp;&nbsp;&nbsp;Rule File Examples</a></li>
94 -<li><a class="reference internal" href="#rule-file-syntax" id="id36">7.1.4&nbsp;&nbsp;&nbsp;Rule File Syntax</a></li>
95 +<li><a class="reference internal" href="#dependency-rules" id="id33">7&nbsp;&nbsp;&nbsp;Dependency Rules</a><ul class="auto-toc">
96 +<li><a class="reference internal" href="#simple-dependency-rules" id="id34">7.1&nbsp;&nbsp;&nbsp;Simple Dependency Rules</a><ul class="auto-toc">
97 +<li><a class="reference internal" href="#rule-variants" id="id35">7.1.1&nbsp;&nbsp;&nbsp;Rule Variants</a></li>
98 +<li><a class="reference internal" href="#rule-types" id="id36">7.1.2&nbsp;&nbsp;&nbsp;Rule types</a></li>
99 +<li><a class="reference internal" href="#rule-file-examples" id="id37">7.1.3&nbsp;&nbsp;&nbsp;Rule File Examples</a></li>
100 +<li><a class="reference internal" href="#rule-file-syntax" id="id38">7.1.4&nbsp;&nbsp;&nbsp;Rule File Syntax</a></li>
101 </ul>
102 </li>
103 </ul>
104 </li>
105 -<li><a class="reference internal" href="#package-rules" id="id37">8&nbsp;&nbsp;&nbsp;Package Rules</a><ul class="auto-toc">
106 -<li><a class="reference internal" href="#package-rule-file-syntax" id="id38">8.1&nbsp;&nbsp;&nbsp;Package Rule File Syntax</a><ul class="auto-toc">
107 -<li><a class="reference internal" href="#match-blocks" id="id39">8.1.1&nbsp;&nbsp;&nbsp;Match Blocks</a><ul class="auto-toc">
108 -<li><a class="reference internal" href="#extended-match-block-syntax" id="id40">8.1.1.1&nbsp;&nbsp;&nbsp;Extended Match Block Syntax</a></li>
109 +<li><a class="reference internal" href="#package-rules" id="id39">8&nbsp;&nbsp;&nbsp;Package Rules</a><ul class="auto-toc">
110 +<li><a class="reference internal" href="#package-rule-file-syntax" id="id40">8.1&nbsp;&nbsp;&nbsp;Package Rule File Syntax</a><ul class="auto-toc">
111 +<li><a class="reference internal" href="#match-blocks" id="id41">8.1.1&nbsp;&nbsp;&nbsp;Match Blocks</a><ul class="auto-toc">
112 +<li><a class="reference internal" href="#extended-match-block-syntax" id="id42">8.1.1.1&nbsp;&nbsp;&nbsp;Extended Match Block Syntax</a></li>
113 </ul>
114 </li>
115 -<li><a class="reference internal" href="#action-blocks" id="id41">8.1.2&nbsp;&nbsp;&nbsp;Action Blocks</a><ul class="auto-toc">
116 -<li><a class="reference internal" href="#extended-action-block-syntax" id="id42">8.1.2.1&nbsp;&nbsp;&nbsp;Extended Action Block Syntax</a></li>
117 +<li><a class="reference internal" href="#action-blocks" id="id43">8.1.2&nbsp;&nbsp;&nbsp;Action Blocks</a><ul class="auto-toc">
118 +<li><a class="reference internal" href="#extended-action-block-syntax" id="id44">8.1.2.1&nbsp;&nbsp;&nbsp;Extended Action Block Syntax</a></li>
119 </ul>
120 </li>
121 -<li><a class="reference internal" href="#package-rule-examples" id="id43">8.1.3&nbsp;&nbsp;&nbsp;Package Rule Examples</a></li>
122 +<li><a class="reference internal" href="#package-rule-examples" id="id45">8.1.3&nbsp;&nbsp;&nbsp;Package Rule Examples</a></li>
123 </ul>
124 </li>
125 </ul>
126 </li>
127 -<li><a class="reference internal" href="#event-hooks" id="id44">9&nbsp;&nbsp;&nbsp;Event Hooks</a><ul class="auto-toc">
128 -<li><a class="reference internal" href="#default-event-script" id="id45">9.1&nbsp;&nbsp;&nbsp;Default event script</a><ul class="auto-toc">
129 -<li><a class="reference internal" href="#activating-a-hook-script" id="id46">9.1.1&nbsp;&nbsp;&nbsp;Activating a hook script</a></li>
130 -<li><a class="reference internal" href="#adding-a-new-hook-script" id="id47">9.1.2&nbsp;&nbsp;&nbsp;Adding a new hook script</a></li>
131 +<li><a class="reference internal" href="#event-hooks" id="id46">9&nbsp;&nbsp;&nbsp;Event Hooks</a><ul class="auto-toc">
132 +<li><a class="reference internal" href="#default-event-script" id="id47">9.1&nbsp;&nbsp;&nbsp;Default event script</a><ul class="auto-toc">
133 +<li><a class="reference internal" href="#activating-a-hook-script" id="id48">9.1.1&nbsp;&nbsp;&nbsp;Activating a hook script</a></li>
134 +<li><a class="reference internal" href="#adding-a-new-hook-script" id="id49">9.1.2&nbsp;&nbsp;&nbsp;Adding a new hook script</a></li>
135 </ul>
136 </li>
137 -<li><a class="reference internal" href="#event-policy" id="id48">9.2&nbsp;&nbsp;&nbsp;Event Policy</a></li>
138 -<li><a class="reference internal" href="#hook-environment" id="id49">9.3&nbsp;&nbsp;&nbsp;Hook Environment</a></li>
139 -<li><a class="reference internal" href="#adding-a-function-file" id="id50">9.4&nbsp;&nbsp;&nbsp;Adding a function file</a></li>
140 -<li><a class="reference internal" href="#adding-a-hook-event" id="id51">9.5&nbsp;&nbsp;&nbsp;Adding a hook event</a></li>
141 +<li><a class="reference internal" href="#event-policy" id="id50">9.2&nbsp;&nbsp;&nbsp;Event Policy</a></li>
142 +<li><a class="reference internal" href="#hook-environment" id="id51">9.3&nbsp;&nbsp;&nbsp;Hook Environment</a></li>
143 +<li><a class="reference internal" href="#adding-a-function-file" id="id52">9.4&nbsp;&nbsp;&nbsp;Adding a function file</a></li>
144 +<li><a class="reference internal" href="#hook-event-table" id="id53">9.5&nbsp;&nbsp;&nbsp;Hook event table</a></li>
145 +<li><a class="reference internal" href="#adding-a-hook-event" id="id54">9.6&nbsp;&nbsp;&nbsp;Adding a hook event</a></li>
146 </ul>
147 </li>
148 -<li><a class="reference internal" href="#configuration-reference" id="id52">10&nbsp;&nbsp;&nbsp;Configuration Reference</a><ul class="auto-toc">
149 -<li><a class="reference internal" href="#misc-options" id="id53">10.1&nbsp;&nbsp;&nbsp;misc options</a></li>
150 -<li><a class="reference internal" href="#overlay-options" id="id54">10.2&nbsp;&nbsp;&nbsp;overlay options</a></li>
151 -<li><a class="reference internal" href="#other-config-files" id="id55">10.3&nbsp;&nbsp;&nbsp;other config files</a></li>
152 -<li><a class="reference internal" href="#shell-environment-hooks" id="id56">10.4&nbsp;&nbsp;&nbsp;shell environment / hooks</a></li>
153 -<li><a class="reference internal" href="#logging" id="id57">10.5&nbsp;&nbsp;&nbsp;logging</a><ul class="auto-toc">
154 -<li><a class="reference internal" href="#console-logging" id="id58">10.5.1&nbsp;&nbsp;&nbsp;console logging</a></li>
155 -<li><a class="reference internal" href="#file-logging" id="id59">10.5.2&nbsp;&nbsp;&nbsp;file logging</a></li>
156 +<li><a class="reference internal" href="#configuration-reference" id="id55">10&nbsp;&nbsp;&nbsp;Configuration Reference</a><ul class="auto-toc">
157 +<li><a class="reference internal" href="#misc-options" id="id56">10.1&nbsp;&nbsp;&nbsp;misc options</a></li>
158 +<li><a class="reference internal" href="#overlay-options" id="id57">10.2&nbsp;&nbsp;&nbsp;overlay options</a></li>
159 +<li><a class="reference internal" href="#other-config-files" id="id58">10.3&nbsp;&nbsp;&nbsp;other config files</a></li>
160 +<li><a class="reference internal" href="#shell-environment-hooks" id="id59">10.4&nbsp;&nbsp;&nbsp;shell environment / hooks</a></li>
161 +<li><a class="reference internal" href="#logging" id="id60">10.5&nbsp;&nbsp;&nbsp;logging</a><ul class="auto-toc">
162 +<li><a class="reference internal" href="#console-logging" id="id61">10.5.1&nbsp;&nbsp;&nbsp;console logging</a></li>
163 +<li><a class="reference internal" href="#file-logging" id="id62">10.5.2&nbsp;&nbsp;&nbsp;file logging</a></li>
164 </ul>
165 </li>
166 -<li><a class="reference internal" href="#options-for-debugging-manual-dependency-rule-creation-and-testing" id="id60">10.6&nbsp;&nbsp;&nbsp;options for debugging, manual dependency rule creation and testing</a></li>
167 +<li><a class="reference internal" href="#options-for-debugging-manual-dependency-rule-creation-and-testing" id="id63">10.6&nbsp;&nbsp;&nbsp;options for debugging, manual dependency rule creation and testing</a></li>
168 </ul>
169 </li>
170 -<li><a class="reference internal" href="#id3" id="id61">11&nbsp;&nbsp;&nbsp;Other config files</a><ul class="auto-toc">
171 -<li><a class="reference internal" href="#use-expand-flag-rename-file" id="id62">11.1&nbsp;&nbsp;&nbsp;USE_EXPAND flag rename file</a></li>
172 -<li><a class="reference internal" href="#field-definition-config" id="id63">11.2&nbsp;&nbsp;&nbsp;Field Definition Config</a><ul class="auto-toc">
173 -<li><a class="reference internal" href="#example-the-default-field-definition-file" id="id64">11.2.1&nbsp;&nbsp;&nbsp;Example: The default field definition file</a></li>
174 +<li><a class="reference internal" href="#id3" id="id64">11&nbsp;&nbsp;&nbsp;Other config files</a><ul class="auto-toc">
175 +<li><a class="reference internal" href="#use-expand-flag-rename-file" id="id65">11.1&nbsp;&nbsp;&nbsp;USE_EXPAND flag rename file</a></li>
176 +<li><a class="reference internal" href="#field-definition-config" id="id66">11.2&nbsp;&nbsp;&nbsp;Field Definition Config</a><ul class="auto-toc">
177 +<li><a class="reference internal" href="#example-the-default-field-definition-file" id="id67">11.2.1&nbsp;&nbsp;&nbsp;Example: The default field definition file</a></li>
178 </ul>
179 </li>
180 </ul>
181 </li>
182 -<li><a class="reference internal" href="#dependency-resolution-console" id="id65">12&nbsp;&nbsp;&nbsp;Dependency Resolution Console</a></li>
183 -<li><a class="reference internal" href="#roverlay-interface" id="id66">13&nbsp;&nbsp;&nbsp;Roverlay Interface</a><ul class="auto-toc">
184 -<li><a class="reference internal" href="#depres-interface" id="id67">13.1&nbsp;&nbsp;&nbsp;DepRes Interface</a></li>
185 +<li><a class="reference internal" href="#id5" id="id68">12&nbsp;&nbsp;&nbsp;Roverlay Console</a><ul class="auto-toc">
186 +<li><a class="reference internal" href="#dependency-resolution-console" id="id69">12.1&nbsp;&nbsp;&nbsp;Dependency Resolution Console</a></li>
187 </ul>
188 </li>
189 -<li><a class="reference internal" href="#implementation-overview" id="id68">14&nbsp;&nbsp;&nbsp;Implementation Overview</a><ul class="auto-toc">
190 -<li><a class="reference internal" href="#packageinfo" id="id69">14.1&nbsp;&nbsp;&nbsp;PackageInfo</a></li>
191 -<li><a class="reference internal" href="#repository-management" id="id70">14.2&nbsp;&nbsp;&nbsp;Repository Management</a><ul class="auto-toc">
192 -<li><a class="reference internal" href="#repository" id="id71">14.2.1&nbsp;&nbsp;&nbsp;Repository</a><ul class="auto-toc">
193 -<li><a class="reference internal" href="#adding-new-repository-types" id="id72">14.2.1.1&nbsp;&nbsp;&nbsp;Adding new repository types</a></li>
194 +<li><a class="reference internal" href="#roverlay-interface" id="id70">13&nbsp;&nbsp;&nbsp;Roverlay Interface</a><ul class="auto-toc">
195 +<li><a class="reference internal" href="#depres-interface" id="id71">13.1&nbsp;&nbsp;&nbsp;DepRes Interface</a></li>
196 +<li><a class="reference internal" href="#remote-interface" id="id72">13.2&nbsp;&nbsp;&nbsp;Remote Interface</a></li>
197 </ul>
198 </li>
199 +<li><a class="reference internal" href="#implementation-overview" id="id73">14&nbsp;&nbsp;&nbsp;Implementation Overview</a><ul class="auto-toc">
200 +<li><a class="reference internal" href="#packageinfo" id="id74">14.1&nbsp;&nbsp;&nbsp;PackageInfo</a></li>
201 +<li><a class="reference internal" href="#repository-management" id="id75">14.2&nbsp;&nbsp;&nbsp;Repository Management</a><ul class="auto-toc">
202 +<li><a class="reference internal" href="#repository" id="id76">14.2.1&nbsp;&nbsp;&nbsp;Repository</a><ul class="auto-toc">
203 +<li><a class="reference internal" href="#adding-new-repository-types" id="id77">14.2.1.1&nbsp;&nbsp;&nbsp;Adding new repository types</a></li>
204 </ul>
205 </li>
206 -<li><a class="reference internal" href="#overlay" id="id73">14.3&nbsp;&nbsp;&nbsp;Overlay</a><ul class="auto-toc">
207 -<li><a class="reference internal" href="#metadata-creation" id="id74">14.3.1&nbsp;&nbsp;&nbsp;Metadata Creation</a></li>
208 -<li><a class="reference internal" href="#manifest-creation" id="id75">14.3.2&nbsp;&nbsp;&nbsp;Manifest Creation</a></li>
209 </ul>
210 </li>
211 -<li><a class="reference internal" href="#ebuild-creation" id="id76">14.4&nbsp;&nbsp;&nbsp;Ebuild Creation</a><ul class="auto-toc">
212 -<li><a class="reference internal" href="#ebuild-variables" id="id77">14.4.1&nbsp;&nbsp;&nbsp;Ebuild Variables</a></li>
213 +<li><a class="reference internal" href="#overlay" id="id78">14.3&nbsp;&nbsp;&nbsp;Overlay</a><ul class="auto-toc">
214 +<li><a class="reference internal" href="#metadata-creation" id="id79">14.3.1&nbsp;&nbsp;&nbsp;Metadata Creation</a></li>
215 +<li><a class="reference internal" href="#manifest-creation" id="id80">14.3.2&nbsp;&nbsp;&nbsp;Manifest Creation</a></li>
216 </ul>
217 </li>
218 -<li><a class="reference internal" href="#overlay-creation" id="id78">14.5&nbsp;&nbsp;&nbsp;Overlay Creation</a><ul class="auto-toc">
219 -<li><a class="reference internal" href="#selfdep-validation" id="id79">14.5.1&nbsp;&nbsp;&nbsp;Selfdep Validation</a></li>
220 +<li><a class="reference internal" href="#ebuild-creation" id="id81">14.4&nbsp;&nbsp;&nbsp;Ebuild Creation</a><ul class="auto-toc">
221 +<li><a class="reference internal" href="#ebuild-variables" id="id82">14.4.1&nbsp;&nbsp;&nbsp;Ebuild Variables</a></li>
222 </ul>
223 </li>
224 -<li><a class="reference internal" href="#dependency-resolution" id="id80">14.6&nbsp;&nbsp;&nbsp;Dependency Resolution</a><ul class="auto-toc">
225 -<li><a class="reference internal" href="#dependency-types" id="id81">14.6.1&nbsp;&nbsp;&nbsp;Dependency types</a><ul class="auto-toc">
226 -<li><a class="reference internal" href="#description-file-dependency-fields" id="id82">14.6.1.1&nbsp;&nbsp;&nbsp;DESCRIPTION file dependency fields</a></li>
227 +<li><a class="reference internal" href="#overlay-creation" id="id83">14.5&nbsp;&nbsp;&nbsp;Overlay Creation</a><ul class="auto-toc">
228 +<li><a class="reference internal" href="#selfdep-validation" id="id84">14.5.1&nbsp;&nbsp;&nbsp;Selfdep Validation</a></li>
229 </ul>
230 </li>
231 -<li><a class="reference internal" href="#dependency-environments" id="id83">14.6.2&nbsp;&nbsp;&nbsp;Dependency Environments</a></li>
232 -<li><a class="reference internal" href="#ebuildjob-channel" id="id84">14.6.3&nbsp;&nbsp;&nbsp;EbuildJob Channel</a></li>
233 -<li><a class="reference internal" href="#dependency-rule-pools" id="id85">14.6.4&nbsp;&nbsp;&nbsp;Dependency Rule Pools</a></li>
234 -<li><a class="reference internal" href="#dependency-resolver-modules" id="id86">14.6.5&nbsp;&nbsp;&nbsp;Dependency Resolver Modules</a></li>
235 -<li><a class="reference internal" href="#dependency-resolver" id="id87">14.6.6&nbsp;&nbsp;&nbsp;Dependency Resolver</a></li>
236 +<li><a class="reference internal" href="#dependency-resolution" id="id85">14.6&nbsp;&nbsp;&nbsp;Dependency Resolution</a><ul class="auto-toc">
237 +<li><a class="reference internal" href="#dependency-types" id="id86">14.6.1&nbsp;&nbsp;&nbsp;Dependency types</a><ul class="auto-toc">
238 +<li><a class="reference internal" href="#description-file-dependency-fields" id="id87">14.6.1.1&nbsp;&nbsp;&nbsp;DESCRIPTION file dependency fields</a></li>
239 +</ul>
240 +</li>
241 +<li><a class="reference internal" href="#dependency-environments" id="id88">14.6.2&nbsp;&nbsp;&nbsp;Dependency Environments</a></li>
242 +<li><a class="reference internal" href="#ebuildjob-channel" id="id89">14.6.3&nbsp;&nbsp;&nbsp;EbuildJob Channel</a></li>
243 +<li><a class="reference internal" href="#dependency-rule-pools" id="id90">14.6.4&nbsp;&nbsp;&nbsp;Dependency Rule Pools</a></li>
244 +<li><a class="reference internal" href="#dependency-resolver-modules" id="id91">14.6.5&nbsp;&nbsp;&nbsp;Dependency Resolver Modules</a></li>
245 +<li><a class="reference internal" href="#dependency-resolver" id="id92">14.6.6&nbsp;&nbsp;&nbsp;Dependency Resolver</a></li>
246 </ul>
247 </li>
248 </ul>
249 @@ -848,6 +854,9 @@ This also tries to recreate the distmap.</td></tr>
250 <kbd><span class="option">--no-incremental</span></kbd></td>
251 </tr>
252 <tr><td>&nbsp;</td><td>Force recreation of existing ebuilds</td></tr>
253 +<tr><td class="option-group">
254 +<kbd><span class="option">--no-revbump</span></kbd></td>
255 +<td>Disable revbump checks in incremental overlay creation mode</td></tr>
256 <tr><td class="option-group" colspan="2">
257 <kbd><span class="option">--immediate-ebuild-writes</span></kbd></td>
258 </tr>
259 @@ -897,6 +906,9 @@ an overlay that is not suitable for production usage.</p>
260 <kbd><span class="option">--no-write</span></kbd></td>
261 <td>Disable overlay writing</td></tr>
262 <tr><td class="option-group">
263 +<kbd><span class="option">--dump-stats</span></kbd></td>
264 +<td>Print all stats</td></tr>
265 +<tr><td class="option-group">
266 <kbd><span class="option">--show</span></kbd></td>
267 <td>Print all ebuilds and metadata to console</td></tr>
268 <tr><td class="option-group" colspan="2">
269 @@ -956,6 +968,35 @@ to symbolic links if hard links are not supported. This should be fine in
270 most cases, but fine-tuning can be done via <a class="reference internal" href="#overlay-distdir-strategy">OVERLAY_DISTDIR_STRATEGY</a> and
271 <a class="reference internal" href="#overlay-distdir-flat">OVERLAY_DISTDIR_FLAT</a>.</p>
272 </div>
273 +<div class="section" id="roverlay-helpers">
274 +<h2><a class="toc-backref" href="#contents">3.4&nbsp;&nbsp;&nbsp;roverlay helpers</a></h2>
275 +<p>An installation of roverlay includes some helper programs:</p>
276 +<dl class="docutils">
277 +<dt><em>roverlay-sh</em></dt>
278 +<dd><p class="first">a wrapper around /bin/sh that runs a shell or shell script in roverlay's
279 +<a class="reference internal" href="#hook-environment">hook environment</a>.</p>
280 +<p>roverlay-related scripts can use it to automatically inherit roverlay's
281 +config and <tt class="docutils literal">$FUNCTIONS</tt> file:</p>
282 +<pre class="code sh literal-block">
283 +<span class="comment">#!/usr/bin/roverlay-sh
284 +</span>
285 +<span class="comment"># reset DEBUG, VERBOSE, QUIET
286 +</span><span class="name variable">DEBUG</span><span class="operator">=</span>n; <span class="name variable">QUIET</span><span class="operator">=</span>n; <span class="name variable">VERBOSE</span><span class="operator">=</span>y
287 +
288 +<span class="comment"># load the functions file (optional)
289 +</span>. <span class="literal string double">&quot;${FUNCTIONS?}&quot;</span> <span class="operator">||</span> <span class="name builtin">exit</span>
290 +
291 +<span class="comment"># script body
292 +</span><span class="name builtin">true</span>
293 +</pre>
294 +<p class="last">&lt;&lt;TODO: maybe there's a better place for the details&gt;&gt;</p>
295 +</dd>
296 +<dt><em>name_is_todo--roverlay_creation_helper</em></dt>
297 +<dd>&lt;&lt;TODO&gt;&gt;
298 +Safely runs overlay creation &lt;&lt;and $$afterwards&gt;&gt;.
299 +Suitable for being run as cron job.</dd>
300 +</dl>
301 +</div>
302 </div>
303 <div class="section" id="basic-implementation-overview">
304 <h1><a class="toc-backref" href="#contents">4&nbsp;&nbsp;&nbsp;Basic Implementation Overview</a></h1>
305 @@ -1792,7 +1833,7 @@ as <em>sci-R/zoo</em>. This rule can be written as a single word, <em>zoo</em>.<
306 Each package rule consists of conditions, e.g. <em>package name contains amd64</em>,
307 and actions, e.g. <em>set KEYWORDS=&quot;-x86 amd64&quot;</em>.
308 The actions of a rule will only be applied if a package meets all conditions,
309 -otherwise the rule does nothing.
310 +otherwise the rule applies alternative actions (if defined) or does nothing.
311 Moreover, rules can contain further rules which will only take effect if all
312 enclosing rules match a given package.</p>
313 <div class="section" id="package-rule-file-syntax">
314 @@ -1800,10 +1841,13 @@ enclosing rules match a given package.</p>
315 <p>As stated above, each rule has two parts, a <em>match block</em> that lists the
316 rule's conditions and an <em>action block</em> that defines which actions and
317 nested rules are applied to a package if the rule matches it, i.e. if all
318 -conditions are met.</p>
319 +conditions are met. A rule can also contain an <em>alternative action block</em>
320 +whose actions are applied to a package if the rule does not match it.</p>
321 <p>A rule file contains zero or more package rules.
322 -Each rule has to declare one <em>match</em> and one <em>action statement</em> at least.
323 -The basic syntax for a rule with 1..m <em>match</em> and 1..n <em>action statements</em> is</p>
324 +Each rule has to declare one <em>match</em> and one
325 +<em>[alternative] action statement</em> at least.
326 +The basic syntax for a rule with 1..m <em>match</em>, 1..n <em>action statements</em> and
327 +1..k <em>alternative action statements</em> is</p>
328 <pre class="code literal-block">
329 MATCH:
330 &lt;match statement 1&gt;
331 @@ -1815,13 +1859,20 @@ ACTION:
332 &lt;action statement 2&gt;
333 ...
334 &lt;action statement n&gt;
335 +ELSE:
336 + &lt;alternative action statement 1&gt;
337 + &lt;alternative action statement 2&gt;
338 + ...
339 + &lt;alternative action statement k&gt;
340 END;
341 </pre>
342 <p>A rule is introduced by the <tt class="docutils literal">MATCH:</tt> keyword, which starts the
343 <em>match block</em> and is followed by one or more <em>match statements</em>, one per line.
344 The <em>match block</em> ends with the <tt class="docutils literal">ACTION:</tt> keyword, which also starts the
345 <em>action block</em> and is followed by one or more <em>action statements</em>
346 -(again, one per line). Finally, the rule is terminated by the <tt class="docutils literal">END;</tt> keyword.</p>
347 +(again, one per line). The <em>alternative action block</em> introduced by the
348 +<tt class="docutils literal">ELSE:</tt> keyword is optional and lists <em>action statements</em>.
349 +Finally, the rule is terminated by the <tt class="docutils literal">END;</tt> keyword.</p>
350 <p>Indention is purely optional, leading and ending whitespace will be discarded.
351 Lines starting with <tt class="docutils literal">#</tt> or <tt class="docutils literal">;</tt> are considered to be comments and will be
352 ignored.</p>
353 @@ -2119,6 +2170,15 @@ statements</td>
354 <tr><td>rename_&lt;key&gt;</td>
355 <td>1</td>
356 </tr>
357 +<tr><td>null</td>
358 +<td rowspan="2"><em>n/a</em></td>
359 +<td rowspan="2">none</td>
360 +<td rowspan="2">does nothing
361 +(can be used for
362 +readability)</td>
363 +</tr>
364 +<tr><td>pass</td>
365 +</tr>
366 </tbody>
367 </table>
368 <p>The two-arg form of the set/rename keywords expect a &lt;key&gt; as first and
369 @@ -2190,6 +2250,19 @@ ACTION:
370 END;
371 # top-level rule, action block continues
372 ...
373 +ELSE:
374 + # top-level rule, alternative action block
375 + ...
376 + MATCH:
377 + # (alternative) nested rule, match block
378 + ...
379 + ACTION:
380 + # (alternative) nested rule, action block
381 + ...
382 + ELSE:
383 + # (alternative) nested rule, alternative action block
384 + ...
385 + END;
386 END;
387 </pre>
388 <p>Rules can be nested indefinitely, whitespace indention is optional.
389 @@ -2201,13 +2274,19 @@ checks necessary for a given package.</p>
390 <div class="section" id="package-rule-examples">
391 <h3><a class="toc-backref" href="#contents">8.1.3&nbsp;&nbsp;&nbsp;Package Rule Examples</a></h3>
392 <p>A rule that ignores the 'yaqcaffy' package from CRAN, which is also available
393 -from BIOC:</p>
394 +from BIOC. Additionally, it sets the category for all non-ignored packages
395 +from CRAN to sci-CRAN:</p>
396 <pre class="code literal-block">
397 MATCH:
398 - repo == CRAN
399 - package_name == yaqcaffy
400 + repo CRAN
401 ACTION:
402 - do-not-process
403 + MATCH:
404 + package_name == yaqcaffy
405 + ACTION:
406 + do-not-process
407 + ELSE:
408 + set category sci-CRAN
409 + END;
410 END;
411 </pre>
412 <p>A more complex example that sets the <tt class="docutils literal">KEYWORDS</tt> ebuild variable for
413 @@ -2219,11 +2298,12 @@ MATCH:
414 * package_name ~ x86_64
415 * package_name ~ amd64
416 ACTION:
417 - keywords &quot;-x86 amd64&quot;
418 MATCH:
419 repo == BIOC/experiment
420 ACTION:
421 keywords &quot;-x86 ~amd64&quot;
422 + ELSE:
423 + keywords &quot;-x86 amd64&quot;
424 END;
425 END;
426 </pre>
427 @@ -2258,6 +2338,13 @@ ACTION:
428 rename_destfile s=^=R-package/=
429 END;
430 </pre>
431 +<div class="hint">
432 +<p class="first admonition-title">Hint</p>
433 +<p class="last"><tt class="docutils literal">roverlay <span class="pre">[--nosync]</span> <span class="pre">[--dump-file</span> &lt;file&gt;] apply_rules</tt> can be used to
434 +test rules. It applies the rules to all packages without running overlay
435 +creation. Furthermore, <tt class="docutils literal">roverlay <span class="pre">--ppr</span></tt> parses the package rules,
436 +prints them and exits afterwards.</p>
437 +</div>
438 </div>
439 </div>
440 </div>
441 @@ -2389,16 +2476,30 @@ the config file. An empty string sets the policy to <em>deny all</em>.</p>
442 <td>event</td>
443 <td>event that caused the script to run</td>
444 </tr>
445 +<tr><td>HAS_CHANGES</td>
446 +<td><em>internal</em></td>
447 +<td>a shbool (<tt class="docutils literal">y</tt> or <tt class="docutils literal">n</tt>) that
448 +indicates whether the overlay has
449 +any changes</td>
450 +</tr>
451 +<tr><td>OVERLAY_NAME</td>
452 +<td>config</td>
453 +<td>name of the overlay</td>
454 +</tr>
455 <tr><td>OVERLAY</td>
456 <td>config</td>
457 -<td rowspan="3">overlay directory (<a class="reference internal" href="#overlay-dir">OVERLAY_DIR</a>),
458 -initial working directory</td>
459 +<td rowspan="2">overlay directory (<a class="reference internal" href="#overlay-dir">OVERLAY_DIR</a>),</td>
460 </tr>
461 <tr><td>S</td>
462 <td><em>$OVERLAY</em></td>
463 </tr>
464 <tr><td>PWD</td>
465 -<td><em>$OVERLAY</em></td>
466 +<td><em>$OVERLAY</em>
467 +<em>$ROVERLAY_PHASE</em></td>
468 +<td><p class="first">initial working directory</p>
469 +<p class="last">depends on $ROVERLAY_PHASE (usually set
470 +to $OVERLAY or left unchanged)</p>
471 +</td>
472 </tr>
473 <tr><td>DISTROOT</td>
474 <td>config</td>
475 @@ -2421,6 +2522,11 @@ initial working directory</td>
476 <tr><td>FILESDIR</td>
477 <td><em>$ADDITIONS_DIR</em></td>
478 </tr>
479 +<tr><td>WORKDIR</td>
480 +<td>config</td>
481 +<td>directory for work data
482 +(<a class="reference internal" href="#cachedir">CACHEDIR</a>)</td>
483 +</tr>
484 <tr><td>SHLIB</td>
485 <td><em>$ADDITIONS_DIR</em>,
486 <em>installed?</em></td>
487 @@ -2434,6 +2540,30 @@ function files
488 <td>file with essential shell functions
489 (optional, only set if it exists)</td>
490 </tr>
491 +<tr><td>DATADIR</td>
492 +<td><em>installed?</em></td>
493 +<td>location of installed data files
494 +(directory, usually
495 +<em>/usr/share/roverlay</em>)</td>
496 +</tr>
497 +<tr><td>ROVERLAY_HELPER_EXE</td>
498 +<td>sys.argv</td>
499 +<td>path to the roverlay executable that
500 +created the hook environment
501 +(usually <em>/usr/bin/roverlay</em> or
502 +<em>/usr/bin/roverlay-sh</em>)</td>
503 +</tr>
504 +<tr><td>ROVERLAY_EXE</td>
505 +<td>guessed,
506 +<em>$ROVERLAY_HELPER_EXE</em></td>
507 +<td>guessed path to the roverlay &quot;main&quot;
508 +executable (which creates the overlay)</td>
509 +</tr>
510 +<tr><td>STATS_DB</td>
511 +<td>config</td>
512 +<td>stats database file
513 +(optional, only set if configured)</td>
514 +</tr>
515 <tr><td>DEBUG</td>
516 <td>log level</td>
517 <td><em>shbool</em> (<tt class="docutils literal">y</tt> or <tt class="docutils literal">n</tt>) that
518 @@ -2628,8 +2758,39 @@ They should, however, not execute any code directly.</p>
519 </pre>
520 <p>Shell function files should be put into <tt class="docutils literal"><span class="pre">&lt;ADDITIONS_DIR&gt;/shlib</span></tt>.</p>
521 </div>
522 +<div class="section" id="hook-event-table">
523 +<h2><a class="toc-backref" href="#contents">9.5&nbsp;&nbsp;&nbsp;Hook event table</a></h2>
524 +<p>The following table lists all known events (<tt class="docutils literal">ROVERLAY_PHASE</tt>):</p>
525 +<table border="1" class="docutils">
526 +<colgroup>
527 +<col width="25%" />
528 +<col width="36%" />
529 +<col width="39%" />
530 +</colgroup>
531 +<thead valign="bottom">
532 +<tr><th class="head">name</th>
533 +<th class="head">initial working directory</th>
534 +<th class="head">description</th>
535 +</tr>
536 +</thead>
537 +<tbody valign="top">
538 +<tr><td>overlay_success</td>
539 +<td><em>$OVERLAY</em></td>
540 +<td>overlay creation succeeded</td>
541 +</tr>
542 +<tr><td>db_written</td>
543 +<td><em>$OVERLAY</em></td>
544 +<td>stats database file written</td>
545 +</tr>
546 +<tr><td>user</td>
547 +<td>unchanged</td>
548 +<td>user-triggered event</td>
549 +</tr>
550 +</tbody>
551 +</table>
552 +</div>
553 <div class="section" id="adding-a-hook-event">
554 -<h2><a class="toc-backref" href="#contents">9.5&nbsp;&nbsp;&nbsp;Adding a hook event</a></h2>
555 +<h2><a class="toc-backref" href="#contents">9.6&nbsp;&nbsp;&nbsp;Adding a hook event</a></h2>
556 <p>Adding a new event has to be done in <em>roverlay's</em> source code and is a rather
557 trivial task. The <tt class="docutils literal">roverlay.hook</tt> module implements a function for running
558 the event script:</p>
559 @@ -2940,6 +3101,13 @@ writing.</p>
560 </div>
561 </dd>
562 </dl>
563 +<dl class="docutils" id="overlay-masters">
564 +<dt>OVERLAY_MASTERS</dt>
565 +<dd><p class="first">A list of repo names that are used as 'masters' attribute when generating
566 +<tt class="docutils literal"><span class="pre">&lt;overlay&gt;/metadata/layout.conf</span></tt>.</p>
567 +<p class="last">Defaults to &quot;gentoo&quot;.</p>
568 +</dd>
569 +</dl>
570 <dl class="docutils" id="overlay-name">
571 <dt>OVERLAY_NAME</dt>
572 <dd><p class="first">Sets the name of the created overlay that will be written into
573 @@ -3277,9 +3445,9 @@ as flag.</dd>
574 <dl class="docutils" id="field-flag-joinvalues">
575 <dt>joinValues</dt>
576 <dd>Declares that a field's value is one string even if it spans over
577 -multiple lines.
578 -The lines will be joined with a single space character ' '.
579 -The default behavior is to merge lines.</dd>
580 +multiple lines. The lines will be joined with a single space
581 +character ' '. The default behavior is to merge lines.
582 +This flag can be used in conjunction with any &quot;is list&quot; flag.</dd>
583 </dl>
584 <dl class="docutils" id="field-flag-islist">
585 <dt>isList</dt>
586 @@ -3350,17 +3518,31 @@ such a field is found.</dd>
587 <span class="keyword">[OS_Type]</span>
588 <span class="name attribute">alias_nocase</span> <span class="operator">=</span> <span class="literal string">OS_TYPE</span>
589 <span class="name attribute">allowed_values</span> <span class="operator">=</span> <span class="literal string">unix</span>
590 +
591 +<span class="keyword">[License]</span>
592 +<span class="name attribute">alias_nocase</span> <span class="operator">=</span> <span class="literal string">License, Licence, Lisence</span>
593 +<span class="error">isLicense</span>
594 </pre>
595 </div>
596 </div>
597 </div>
598 +<div class="section" id="id5">
599 +<span id="roverlay-console"></span><h1><a class="toc-backref" href="#contents">12&nbsp;&nbsp;&nbsp;Roverlay Console</a></h1>
600 +<p>&lt;&lt;section is TODO&gt;&gt;</p>
601 +<p>&lt;&lt;links to depres console chapter may need to be fixed&gt;&gt;</p>
602 +<p>&lt;&lt;basic commands, table&gt;&gt;</p>
603 +<p>&lt;&lt;note regarding python -OO and missing help texts&gt;&gt;</p>
604 <div class="section" id="dependency-resolution-console">
605 -<span id="depres-console"></span><h1><a class="toc-backref" href="#contents">12&nbsp;&nbsp;&nbsp;Dependency Resolution Console</a></h1>
606 +<span id="depres-console"></span><h2><a class="toc-backref" href="#contents">12.1&nbsp;&nbsp;&nbsp;Dependency Resolution Console</a></h2>
607 +<div class="warning">
608 +<p class="first admonition-title">Warning</p>
609 +<p class="last">This section is out-of-date.</p>
610 +</div>
611 <p>As previously stated, the <em>DepRes Console</em> is only meant for <strong>testing</strong>.
612 It is an interactive console with the following features:</p>
613 <ul class="simple">
614 <li>resolve dependencies</li>
615 -<li>create new dependency rules (<strong>only single line rules</strong>)</li>
616 +<li>create new dependency rules</li>
617 <li>create dependency rules for each R package found in a directory</li>
618 <li>load rules from files</li>
619 <li>save rules to a file</li>
620 @@ -3371,6 +3553,7 @@ to create or remove them easily at runtime.</p>
621 <p>Running <tt class="docutils literal">roverlay depres_console</tt> will print a welcome message that
622 lists all available commands and a few usage hints.</p>
623 <p>For reference, these commands are currently available:</p>
624 +<p>&lt;&lt;TODO: rewrite/update command table, it's out-of-date&gt;&gt;</p>
625 <table border="1" class="docutils">
626 <colgroup>
627 <col width="29%" />
628 @@ -3383,13 +3566,9 @@ lists all available commands and a few usage hints.</p>
629 </thead>
630 <tbody valign="top">
631 <tr><td>help,
632 -h</td>
633 +h, ?</td>
634 <td>lists all commands</td>
635 </tr>
636 -<tr><td>help --list,
637 -h --list</td>
638 -<td>lists all help topics for which help is available</td>
639 -</tr>
640 <tr><td>help <em>&lt;cmd&gt;</em>,
641 h <em>&lt;cmd&gt;</em></td>
642 <td>prints a command-specific help message</td>
643 @@ -3404,65 +3583,78 @@ lc</td>
644 <td>loads the rule files listed in the config file
645 into a new <em>rule pool</em></td>
646 </tr>
647 -<tr><td>addrule <em>&lt;rule&gt;</em>
648 +<tr><td>add_rule <em>&lt;rule&gt;</em>
649 + <em>&lt;rule&gt;</em></td>
650 <td>creates a new rule and adds it to the topmost,
651 i.e. latest <em>rule pool</em>. This command uses
652 -<a class="reference internal" href="#rule-file-syntax">Rule File Syntax</a>, but multi line rules are
653 -not supported.</td>
654 +<a class="reference internal" href="#rule-file-syntax">Rule File Syntax</a>. Multi line rules are
655 +supported.</td>
656 </tr>
657 <tr><td>add_pool,
658 &lt;&lt;</td>
659 <td>creates a new <em>rule pool</em></td>
660 </tr>
661 -<tr><td>unwind,
662 +<tr><td>unwind_pool,
663 &gt;&gt;</td>
664 <td>removes the topmost <em>rule pool</em> and all of its
665 rules</td>
666 </tr>
667 <tr><td>resolve <em>&lt;dep&gt;</em>,
668 -? <em>&lt;dep&gt;</em></td>
669 +?? <em>&lt;dep&gt;</em></td>
670 <td>tries to resolve the given dependency string and
671 prints the result</td>
672 </tr>
673 +<tr><td>!</td>
674 +<td>enter the resolve <em>command chroot</em>
675 +all input will be prefixed with &quot;resolve&quot;</td>
676 +</tr>
677 +<tr><td>!!</td>
678 +<td>leave any <em>command chroot</em></td>
679 +</tr>
680 <tr><td>print, p</td>
681 <td>prints the rules of the topmost <em>rule pool</em></td>
682 </tr>
683 -<tr><td>print all, p all</td>
684 +<tr><td>print --all|-a</td>
685 <td>prints the rules of all <em>rule pools</em></td>
686 </tr>
687 +<tr><td>print &lt;id&gt; [&lt;id&gt;..]</td>
688 +<td>prints the rules of a specific <em>rule pool</em></td>
689 +</tr>
690 <tr><td>write <em>&lt;file&gt;</em>,
691 w <em>&lt;file&gt;</em></td>
692 <td>writes the rules of the topmost <em>rule pool</em> into
693 -<em>&lt;file&gt;</em></td>
694 +<em>&lt;file&gt;</em>. See write --help for advanced usage.</td>
695 </tr>
696 <tr><td>cd <em>&lt;dir&gt;</em></td>
697 -<td>changes the working directory, also creates it if
698 -necessary</td>
699 +<td>changes the working directory
700 +This is a virtual command. &lt;&lt;TODO:EXPLAIN&gt;&gt;</td>
701 +</tr>
702 +<tr><td>set VAR=VALUE</td>
703 +<td>set variables</td>
704 </tr>
705 -<tr><td>scandir <em>&lt;dir&gt;</em>,
706 -sd <em>&lt;dir&gt;</em></td>
707 -<td>creates dependency rules for each R package found
708 -in <em>&lt;dir&gt;</em></td>
709 +<tr><td>unset VAR</td>
710 +<td>unset variables</td>
711 </tr>
712 -<tr><td>set, unset</td>
713 -<td>prints the status of currently (in)active modes</td>
714 +<tr><td>declare</td>
715 +<td>show declared variables</td>
716 </tr>
717 -<tr><td>set <em>&lt;mode&gt;</em>,
718 -unset <em>&lt;mode&gt;</em></td>
719 -<td>sets or unsets <em>&lt;mode&gt;</em>. There is only one mode to
720 -control, the <em>shlex mode</em> which controls how
721 -command arguments are parsed</td>
722 +<tr><td>alias</td>
723 +<td>show command aliases</td>
724 </tr>
725 -<tr><td>mkhelp</td>
726 -<td>verifies that each accessible command has a help
727 -message</td>
728 +<tr><td>unalias</td>
729 +<td>reserved for future usage</td>
730 </tr>
731 <tr><td>exit, qq, q</td>
732 <td>exits the <em>DepRes Console</em></td>
733 </tr>
734 </tbody>
735 </table>
736 +<div class="note">
737 +<p class="first admonition-title">Note</p>
738 +<p class="last">Some commands also offer more detailed help via <tt class="docutils literal">&lt;command&gt; <span class="pre">--help</span></tt>.</p>
739 +</div>
740 +<p>&lt;&lt;TODO&gt;&gt;</p>
741 +<p>&lt;&lt;Example Session is out-of-date&gt;&gt;</p>
742 <dl class="docutils">
743 <dt>Example Session:</dt>
744 <dd><pre class="code first last literal-block">
745 @@ -3512,6 +3704,7 @@ cmd % exit
746 </dd>
747 </dl>
748 </div>
749 +</div>
750 <div class="section" id="roverlay-interface">
751 <h1><a class="toc-backref" href="#contents">13&nbsp;&nbsp;&nbsp;Roverlay Interface</a></h1>
752 <p>Roverlay provides an API for accessing its functionality independently of
753 @@ -3547,6 +3740,10 @@ initialization</td>
754 <td>roverlay.interface.depres</td>
755 <td>dependency resolution</td>
756 </tr>
757 +<tr><td>RemoteInterface</td>
758 +<td>roverlay.interface.remote</td>
759 +<td>remote interaction (sync)</td>
760 +</tr>
761 </tbody>
762 </table>
763 <p>For extending the API, roverlay provides the abstract <em>RoverlayInterface</em> and
764 @@ -3572,9 +3769,13 @@ and <em>cannot_resolve()</em></li>
765 also possible</li>
766 </ul>
767 <p>Refer to in-code documentation on how to use this interface.
768 -See the dependency resolution test suite for a usage example
769 -(<tt class="docutils literal">tests.depres</tt>, not part of the roverlay installation).
770 -(The depres console is also a candidate for using this interface in future.)</p>
771 +See the dependency resolution test suite (<tt class="docutils literal">tests.depres</tt>, not part of the
772 +roverlay installation) and the dependency resolution console
773 +for usage examples.</p>
774 +</div>
775 +<div class="section" id="remote-interface">
776 +<h2><a class="toc-backref" href="#contents">13.2&nbsp;&nbsp;&nbsp;Remote Interface</a></h2>
777 +<p>&lt;&lt;TODO; this interface isn't mature enough yet (it will likely change in future)&gt;&gt;</p>
778 </div>
779 </div>
780 <div class="section" id="implementation-overview">
781 @@ -4114,7 +4315,7 @@ becomes &quot;loop until resolver closes&quot;.</p>
782 </div>
783 <div class="footer">
784 <hr class="footer" />
785 -Generated on: 2013-07-23.
786 +Generated on: 2013-08-02.
787
788 </div>
789 </body>