| 1 |
Author: zmedico |
| 2 |
Date: 2008-09-26 00:16:29 +0000 (Fri, 26 Sep 2008) |
| 3 |
New Revision: 11551 |
| 4 |
|
| 5 |
Modified: |
| 6 |
main/trunk/doc/package/ebuild/eapi/2.docbook |
| 7 |
Log: |
| 8 |
Rename the EAPI 2 docs and to indicate that they are no longer a draft, and |
| 9 |
remove the EAPI 2_pre* docs. |
| 10 |
|
| 11 |
|
| 12 |
Modified: main/trunk/doc/package/ebuild/eapi/2.docbook |
| 13 |
=================================================================== |
| 14 |
--- main/trunk/doc/package/ebuild/eapi/2.docbook 2008-09-26 00:09:06 UTC (rev 11550) |
| 15 |
+++ main/trunk/doc/package/ebuild/eapi/2.docbook 2008-09-26 00:16:29 UTC (rev 11551) |
| 16 |
@@ -1,289 +1,10 @@ |
| 17 |
-<section id='package-ebuild-eapi-2_pre1'> |
| 18 |
- <title>EAPI 2_pre1</title> |
| 19 |
+<section id='package-ebuild-eapi-2'> |
| 20 |
+ <title>EAPI 2</title> |
| 21 |
<section id='package-ebuild-eapi-2-helpers'> |
| 22 |
<title>Helpers</title> |
| 23 |
<section id='package-ebuild-eapi-2-helpers-doman'> |
| 24 |
<title>doman</title> |
| 25 |
- <para> |
| 26 |
- Language codes in file names are now used for path translation. |
| 27 |
- </para> |
| 28 |
- <table><title>Man Page Path Translation</title> |
| 29 |
- <tgroup cols='2' align='left' > |
| 30 |
- <colspec colname='source'/> |
| 31 |
- <colspec colname='destination'/> |
| 32 |
- <thead> |
| 33 |
- <row> |
| 34 |
- <entry>Source</entry> |
| 35 |
- <entry>Destination</entry> |
| 36 |
- </row> |
| 37 |
- </thead> |
| 38 |
- <tbody> |
| 39 |
- <row> |
| 40 |
- <entry>foo.1</entry> |
| 41 |
- <entry>/usr/share/man/man1/foo.1</entry> |
| 42 |
- </row> |
| 43 |
- <row> |
| 44 |
- <entry>foo.lang.1</entry> |
| 45 |
- <entry>/usr/share/man/lang/man1/foo.1</entry> |
| 46 |
- </row> |
| 47 |
- </tbody> |
| 48 |
- </tgroup> |
| 49 |
- </table> |
| 50 |
- </section> |
| 51 |
- </section> |
| 52 |
- <section id='package-ebuild-eapi-2-use-deps'> |
| 53 |
- <title>USE Dependencies</title> |
| 54 |
- <section id='package-ebuild-eapi-2-use-deps-unconditional'> |
| 55 |
- <title>Unconditional USE Dependencies</title> |
| 56 |
- <table><title>Syntax Examples</title> |
| 57 |
- <tgroup cols='2' align='left' > |
| 58 |
- <colspec colname='example'/> |
| 59 |
- <colspec colname='meaning'/> |
| 60 |
- <thead> |
| 61 |
- <row> |
| 62 |
- <entry>Example</entry> |
| 63 |
- <entry>Meaning</entry> |
| 64 |
- </row> |
| 65 |
- </thead> |
| 66 |
- <tbody> |
| 67 |
- <row> |
| 68 |
- <entry>foo[bar]</entry> |
| 69 |
- <entry>foo must have bar enabled</entry> |
| 70 |
- </row> |
| 71 |
- <row> |
| 72 |
- <entry>foo[bar,baz]</entry> |
| 73 |
- <entry>foo must have both bar and baz enabled</entry> |
| 74 |
- </row> |
| 75 |
- <row> |
| 76 |
- <entry>foo[-bar,baz]</entry> |
| 77 |
- <entry>foo must have bar disabled and baz enabled</entry> |
| 78 |
- </row> |
| 79 |
- </tbody> |
| 80 |
- </tgroup> |
| 81 |
- </table> |
| 82 |
- </section> |
| 83 |
- <section id='package-ebuild-eapi-2-use-deps-conditional'> |
| 84 |
- <title>Conditional USE Dependencies</title> |
| 85 |
- <table><title>Syntax Examples</title> |
| 86 |
- <tgroup cols='2' align='left' > |
| 87 |
- <colspec colname='compact'/> |
| 88 |
- <colspec colname='expanded'/> |
| 89 |
- <thead> |
| 90 |
- <row> |
| 91 |
- <entry>Compact Form</entry> |
| 92 |
- <entry>Equivalent Expanded Form</entry> |
| 93 |
- </row> |
| 94 |
- </thead> |
| 95 |
- <tbody> |
| 96 |
- <row> |
| 97 |
- <entry>foo[bar?]</entry> |
| 98 |
- <entry>bar? ( foo[bar] ) !bar? ( foo )</entry> |
| 99 |
- </row> |
| 100 |
- <row> |
| 101 |
- <entry>foo[!bar?]</entry> |
| 102 |
- <entry>bar? ( foo ) !bar? ( foo[-bar] )</entry> |
| 103 |
- </row> |
| 104 |
- <row> |
| 105 |
- <entry>foo[bar=]</entry> |
| 106 |
- <entry>bar? ( foo[bar] ) !bar? ( foo[-bar] )</entry> |
| 107 |
- </row> |
| 108 |
- <row> |
| 109 |
- <entry>foo[!bar=]</entry> |
| 110 |
- <entry>bar? ( foo[-bar] ) !bar? ( foo[bar] )</entry> |
| 111 |
- </row> |
| 112 |
- </tbody> |
| 113 |
- </tgroup> |
| 114 |
- </table> |
| 115 |
- </section> |
| 116 |
- </section> |
| 117 |
-</section> |
| 118 |
-<section id='package-ebuild-eapi-2_pre2'> |
| 119 |
- <title>EAPI 2_pre2</title> |
| 120 |
- <section id='package-ebuild-eapi-2-phases'> |
| 121 |
- <title>Phases</title> |
| 122 |
- <section id='package-ebuild-eapi-2-phases-src-configure'> |
| 123 |
- <title>New src_configure Phase Function</title> |
| 124 |
- <para> |
| 125 |
- The configure portion of the src_compile function has been |
| 126 |
- split into a separate function which is named src_configure. The |
| 127 |
- src_configure function is called in-between the src_unpack and |
| 128 |
- src_compile functions. |
| 129 |
- </para> |
| 130 |
- <programlisting> |
| 131 |
-src_configure() { |
| 132 |
- if [[ -x ${ECONF_SOURCE:-.}/configure ]] ; then |
| 133 |
- econf |
| 134 |
- fi |
| 135 |
-} |
| 136 |
- |
| 137 |
-src_compile() { |
| 138 |
- if [ -f Makefile ] || [ -f GNUmakefile ] || [ -f makefile ] ; then |
| 139 |
- emake || die "emake failed" |
| 140 |
- fi |
| 141 |
-} |
| 142 |
- </programlisting> |
| 143 |
- <table><title>Execution Order of Phase Functions</title> |
| 144 |
- <tgroup cols='1' align='left' > |
| 145 |
- <colspec colname='name'/> |
| 146 |
- <thead> |
| 147 |
- <row> |
| 148 |
- <entry>Phase Function Name</entry> |
| 149 |
- </row> |
| 150 |
- </thead> |
| 151 |
- <tbody> |
| 152 |
- <row> |
| 153 |
- <entry>pkg_setup</entry> |
| 154 |
- </row> |
| 155 |
- <row> |
| 156 |
- <entry>src_unpack</entry> |
| 157 |
- </row> |
| 158 |
- <row> |
| 159 |
- <entry>src_configure</entry> |
| 160 |
- </row> |
| 161 |
- <row> |
| 162 |
- <entry>src_compile</entry> |
| 163 |
- </row> |
| 164 |
- <row> |
| 165 |
- <entry>src_test</entry> |
| 166 |
- </row> |
| 167 |
- <row> |
| 168 |
- <entry>src_install</entry> |
| 169 |
- </row> |
| 170 |
- <row> |
| 171 |
- <entry>pkg_preinst</entry> |
| 172 |
- </row> |
| 173 |
- <row> |
| 174 |
- <entry>pkg_postinst</entry> |
| 175 |
- </row> |
| 176 |
- <row> |
| 177 |
- <entry>pkg_prerm</entry> |
| 178 |
- </row> |
| 179 |
- <row> |
| 180 |
- <entry>pkg_postrm</entry> |
| 181 |
- </row> |
| 182 |
- </tbody> |
| 183 |
- </tgroup> |
| 184 |
- </table> |
| 185 |
- </section> |
| 186 |
- <section id='package-ebuild-eapi-2-phases-default-functions'> |
| 187 |
- <title>Default Phase Functions</title> |
| 188 |
- <para> |
| 189 |
- The default pkg_nofetch and src_* phase functions are now |
| 190 |
- accessible via a function having a name |
| 191 |
- that begins with default_ and |
| 192 |
- ends with the respective phase function name. For example, |
| 193 |
- a call to a function with the name default_src_compile is |
| 194 |
- equivalent to a call to the default src_compile |
| 195 |
- implementation. |
| 196 |
- </para> |
| 197 |
- <table><title>Default Phase Functions</title> |
| 198 |
- <tgroup cols='1' align='left' > |
| 199 |
- <colspec colname='name'/> |
| 200 |
- <thead> |
| 201 |
- <row> |
| 202 |
- <entry>Function Name</entry> |
| 203 |
- </row> |
| 204 |
- </thead> |
| 205 |
- <tbody> |
| 206 |
- <row> |
| 207 |
- <entry>default_pkg_nofetch</entry> |
| 208 |
- </row> |
| 209 |
- <row> |
| 210 |
- <entry>default_src_unpack</entry> |
| 211 |
- </row> |
| 212 |
- <row> |
| 213 |
- <entry>default_src_configure</entry> |
| 214 |
- </row> |
| 215 |
- <row> |
| 216 |
- <entry>default_src_compile</entry> |
| 217 |
- </row> |
| 218 |
- <row> |
| 219 |
- <entry>default_src_test</entry> |
| 220 |
- </row> |
| 221 |
- </tbody> |
| 222 |
- </tgroup> |
| 223 |
- </table> |
| 224 |
- </section> |
| 225 |
- <section id='package-ebuild-eapi-2-phases-default-function-alias'> |
| 226 |
- <title>Default Phase Function Alias</title> |
| 227 |
- <para> |
| 228 |
- A function named "default" is redefined for each phase so that it |
| 229 |
- will call the default_* function corresponding to the current phase. |
| 230 |
- For example, a call to the function named "default" during the |
| 231 |
- src_compile phase is equivalent to a call to the function named |
| 232 |
- default_src_compile. |
| 233 |
- </para> |
| 234 |
- </section> |
| 235 |
- </section> |
| 236 |
-</section> |
| 237 |
-<section id='package-ebuild-eapi-2-pre3'> |
| 238 |
- <title>EAPI 2_pre3</title> |
| 239 |
- <section id='package-ebuild-eapi-2-pre3-metadata'> |
| 240 |
- <title>Metadata</title> |
| 241 |
- <section id='package-ebuild-eapi-2-pre3-metadata-dependencies'> |
| 242 |
- <title>Dependencies</title> |
| 243 |
- <section id='package-ebuild-eapi-2-pre3-metadata-dependencies-blocker-atoms'> |
| 244 |
- <title>Blocker Atoms</title> |
| 245 |
- <section id='package-ebuild-eapi-2-pre3-metadata-dependencies-blocker-atoms-new-meaning'> |
| 246 |
- <title>New Meaning for Old Syntax</title> |
| 247 |
- <para> |
| 248 |
- Blocker atoms which use the previously existing !atom syntax now have |
| 249 |
- a slightly different meaning. These blocker atoms indicate that |
| 250 |
- conflicting packages may be temporarily installed simultaneously. When |
| 251 |
- temporary simultaneous installation of conflicting packages occurs, the |
| 252 |
- installation of a newer package may overwrite any colliding files that |
| 253 |
- belong to an older package which is explicitly blocked. When such file |
| 254 |
- collisions occur, the colliding files cease to belong to the older |
| 255 |
- package, and they remain installed after the older package is |
| 256 |
- eventually uninstalled. The older package is uninstalled only after |
| 257 |
- any newer blocking packages have been merged on top of it. |
| 258 |
- </para> |
| 259 |
- </section> |
| 260 |
- <section id='package-ebuild-eapi-2-pre3-metadata-dependencies-blocker-atoms-new-syntax'> |
| 261 |
- <title>New !!atom Syntax</title> |
| 262 |
- <para> |
| 263 |
- A new !!atom syntax is now supported, for use in special cases for which |
| 264 |
- temporary simultaneous installation of conflicting packages should not be |
| 265 |
- allowed. If a given package happens to be blocked my a mixture of atoms |
| 266 |
- consisting of both the !atom and !!atom syntaxes, the !!atom syntax takes |
| 267 |
- precedence over the !atom syntax. |
| 268 |
- </para> |
| 269 |
- </section> |
| 270 |
- </section> |
| 271 |
- </section> |
| 272 |
- <section id='package-ebuild-eapi-2-pre3-metadata-src-uri'> |
| 273 |
- <title>SRC_URI</title> |
| 274 |
- <section id='package-ebuild-eapi-2-pre3-metadata-src-uri-output-file-name-customization'> |
| 275 |
- <title>Customization of Output File Names</title> |
| 276 |
- <para> |
| 277 |
- A new syntax is supported which allows customization of the output |
| 278 |
- file name for a given URI. In order to customize the output file |
| 279 |
- name, a given URI should be followed by a "->" operator which, |
| 280 |
- in turn, should be followed by the desired output file name. As |
| 281 |
- usual, all tokens, including the operator and output file name, |
| 282 |
- should be separated by whitespace. |
| 283 |
- </para> |
| 284 |
- </section> |
| 285 |
- </section> |
| 286 |
- </section> |
| 287 |
- <section id='package-ebuild-eapi-2-pre3-phases'> |
| 288 |
- <title>Phases</title> |
| 289 |
- <section id='package-ebuild-eapi-2-pre3-phases-src-prepare'> |
| 290 |
- <title>New src_prepare Phase Function</title> |
| 291 |
- <para> |
| 292 |
- A new src_prepare function is called after the src_unpack |
| 293 |
- function, with cwd initially set to $S. |
| 294 |
- </para> |
| 295 |
- </section> |
| 296 |
- </section> |
| 297 |
-</section> |
| 298 |
-<section id='package-ebuild-eapi-2-draft'> |
| 299 |
- <title>EAPI 2 Draft</title> |
| 300 |
- <section id='package-ebuild-eapi-2-draft-helpers'> |
| 301 |
- <title>Helpers</title> |
| 302 |
- <section id='package-ebuild-eapi-2-draft-helpers-doman'> |
| 303 |
- <title>doman</title> |
| 304 |
- <section id='package-ebuild-eapi-2-draft-helpers-doman-language-codes'> |
| 305 |
+ <section id='package-ebuild-eapi-2-helpers-doman-language-codes'> |
| 306 |
<title>Recognition of Language Codes in File Names</title> |
| 307 |
<para> |
| 308 |
Language codes in file names are now used for path translation. |
| 309 |
@@ -313,13 +34,13 @@ |
| 310 |
</section> |
| 311 |
</section> |
| 312 |
</section> |
| 313 |
- <section id='package-ebuild-eapi-2-draft-metadata'> |
| 314 |
+ <section id='package-ebuild-eapi-2-metadata'> |
| 315 |
<title>Metadata</title> |
| 316 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies'> |
| 317 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies'> |
| 318 |
<title>Dependencies</title> |
| 319 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-blocker-atoms'> |
| 320 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-blocker-atoms'> |
| 321 |
<title>Blocker Atoms</title> |
| 322 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-blocker-atoms-new-meaning'> |
| 323 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-blocker-atoms-new-meaning'> |
| 324 |
<title>New Meaning for Old Syntax</title> |
| 325 |
<para> |
| 326 |
Blocker atoms which use the previously existing !atom syntax now have |
| 327 |
@@ -334,7 +55,7 @@ |
| 328 |
any newer blocking packages have been merged on top of it. |
| 329 |
</para> |
| 330 |
</section> |
| 331 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-blocker-atoms-new-syntax'> |
| 332 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-blocker-atoms-new-syntax'> |
| 333 |
<title>New !!atom Syntax</title> |
| 334 |
<para> |
| 335 |
A new !!atom syntax is now supported, for use in special cases for which |
| 336 |
@@ -345,9 +66,9 @@ |
| 337 |
</para> |
| 338 |
</section> |
| 339 |
</section> |
| 340 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-use'> |
| 341 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-use'> |
| 342 |
<title>USE Dependencies</title> |
| 343 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-use-unconditional'> |
| 344 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-use-unconditional'> |
| 345 |
<title>Unconditional USE Dependencies</title> |
| 346 |
<table><title>Syntax Examples</title> |
| 347 |
<tgroup cols='2' align='left' > |
| 348 |
@@ -376,7 +97,7 @@ |
| 349 |
</tgroup> |
| 350 |
</table> |
| 351 |
</section> |
| 352 |
- <section id='package-ebuild-eapi-2-draft-metadata-dependencies-use-conditional'> |
| 353 |
+ <section id='package-ebuild-eapi-2-metadata-dependencies-use-conditional'> |
| 354 |
<title>Conditional USE Dependencies</title> |
| 355 |
<table><title>Syntax Examples</title> |
| 356 |
<tgroup cols='2' align='left' > |
| 357 |
@@ -411,9 +132,9 @@ |
| 358 |
</section> |
| 359 |
</section> |
| 360 |
</section> |
| 361 |
- <section id='package-ebuild-eapi-2-draft-metadata-src-uri'> |
| 362 |
+ <section id='package-ebuild-eapi-2-metadata-src-uri'> |
| 363 |
<title>SRC_URI</title> |
| 364 |
- <section id='package-ebuild-eapi-2-draft-metadata-src-uri-output-file-name-customization'> |
| 365 |
+ <section id='package-ebuild-eapi-2-metadata-src-uri-output-file-name-customization'> |
| 366 |
<title>Customization of Output File Names</title> |
| 367 |
<para> |
| 368 |
A new syntax is supported which allows customization of the output |
| 369 |
@@ -426,16 +147,16 @@ |
| 370 |
</section> |
| 371 |
</section> |
| 372 |
</section> |
| 373 |
- <section id='package-ebuild-eapi-2-draft-phases'> |
| 374 |
+ <section id='package-ebuild-eapi-2-phases'> |
| 375 |
<title>Phases</title> |
| 376 |
- <section id='package-ebuild-eapi-2-draft-phases-src-prepare'> |
| 377 |
+ <section id='package-ebuild-eapi-2-phases-src-prepare'> |
| 378 |
<title>New src_prepare Phase Function</title> |
| 379 |
<para> |
| 380 |
A new src_prepare function is called after the src_unpack |
| 381 |
function, with cwd initially set to $S. |
| 382 |
</para> |
| 383 |
</section> |
| 384 |
- <section id='package-ebuild-eapi-2-draft-phases-src-configure'> |
| 385 |
+ <section id='package-ebuild-eapi-2-phases-src-configure'> |
| 386 |
<title>New src_configure Phase Function</title> |
| 387 |
<para> |
| 388 |
The configure portion of the src_compile function has been |
| 389 |
@@ -457,7 +178,7 @@ |
| 390 |
} |
| 391 |
</programlisting> |
| 392 |
</section> |
| 393 |
- <section id='package-ebuild-eapi-2-draft-phases-order'> |
| 394 |
+ <section id='package-ebuild-eapi-2-phases-order'> |
| 395 |
<title>Execution Order of Phase Functions</title> |
| 396 |
<table><title>Execution Order of Phase Functions</title> |
| 397 |
<tgroup cols='1' align='left' > |
| 398 |
@@ -505,7 +226,7 @@ |
| 399 |
</tgroup> |
| 400 |
</table> |
| 401 |
</section> |
| 402 |
- <section id='package-ebuild-eapi-2-draft-phases-default-functions'> |
| 403 |
+ <section id='package-ebuild-eapi-2-phases-default-functions'> |
| 404 |
<title>Default Phase Functions</title> |
| 405 |
<para> |
| 406 |
The default pkg_nofetch and src_* phase functions are now |
| 407 |
@@ -547,7 +268,7 @@ |
| 408 |
</tgroup> |
| 409 |
</table> |
| 410 |
</section> |
| 411 |
- <section id='package-ebuild-eapi-2-draft-phases-default-function-alias'> |
| 412 |
+ <section id='package-ebuild-eapi-2-phases-default-function-alias'> |
| 413 |
<title>Default Phase Function Alias</title> |
| 414 |
<para> |
| 415 |
A function named "default" is redefined for each phase so that it |
Archives