Java Packaging Guide
Alistair Bush <[email protected]>
| Newsgroups | gmane.linux.gentoo.java |
|---|---|
| Message-ID | <[email protected]> |
After updating the documentation within java-utils-2.eclass. I noticed that our Java Packaging Guide, while documenting the functions, does not actually document our parameters ( --build-only, --into, etc ). This patch documents the parameters available to be used by our query functions ( jarfrom, getjars and getjar ). It is formatted as a table with the columns Parameter, Description and Function(s). Currently the desciption is taken directly from the java-utils-2.eclass. I realise that we do not want to over burden a reader with information, but I believe this is info should still be available within the doc. Does anyone disagree? I will assume silence is acceptance and will commit it after a couple of days. Speak up if you have complaints, suggestions, etc! Alistair Bush
document-query-function-params.patch
(text/plain, 1 KB)
--- java-devel.xml 2007-10-06 23:26:53.000000000 +1300 +++ java-devel.xml 2007-10-06 23:26:31.000000000 +1300 @@ -806,6 +806,38 @@ </li> </ul> +<p> + The query functions accept a range of additional arguments that control + their behavour. +</p> +<table> +<tr> + <th>Parameter</th> + <th>Description</th> + <th>Function(s)</th> +</tr> +<tr> + <ti>--build-only</ti> + <ti>Makes the jar(s) not added into package.env DEPEND line.</ti> + <ti>java-pkg_jarfrom, java-pkg_getjars, java-pkg_getjar</ti> +</tr> +<tr> + <ti>--with-dependencies</ti> + <ti>Get jars also from requested package's dependencies transitively.</ti> + <ti>java-pkg_jarfrom, java-pkg_getjars</ti> +</tr> +<tr> + <ti>--into $dir</ti> + <ti>Symlink jar(s) into $dir (must exist)</ti> + <ti>java-pkg_jarfrom</ti> +</tr> +<tr> + <ti>--virtual</ti> + <ti>Packages passed to this function are to be handled as virtuals + and will not have individual jar dependencies recorded.</ti> + <ti>java-pkg_jarfrom</ti> +</tr> +</table> </body> </section> <section id="func_other">