diff options
author | 2010-08-22 17:33:13 +0300 | |
---|---|---|
committer | 2010-08-22 17:33:13 +0300 | |
commit | 4573f550d43dc998dfe48b1fee2ba6c7ef96d155 (patch) | |
tree | 98a490b4634d4a310812358c803fe6aad293a376 | |
parent | Merge branch 'docbook' of ineluttabile.it:devmanual into docbook (diff) | |
download | devmanual-4573f550d43dc998dfe48b1fee2ba6c7ef96d155.tar.gz devmanual-4573f550d43dc998dfe48b1fee2ba6c7ef96d155.tar.bz2 devmanual-4573f550d43dc998dfe48b1fee2ba6c7ef96d155.zip |
Backported few commits from master branch
*d86265fccfaf319b2b8dd153de05add52e790ad0
*e60c27df75e9c2bbec09d3d25df02650fd736c9a
*6cc24b2dabd9076873b8a2b96a33c8e302047501
*34b719b0129f8e2b6d5eb9de81267d0235e44756
*d0796a09b342a17cc9b4f5a1b06f1ec772b2de10
*aef7f7a9ad7bab337dbd8c8fd4e886a51ee799b8
-rw-r--r-- | content/ebuild-writing/eapi.xmli | 7 | ||||
-rw-r--r-- | content/ebuild-writing/misc-files/metadata.xmli | 81 | ||||
-rw-r--r-- | content/general-concepts/ebuild-revisions.xmli | 5 | ||||
-rw-r--r-- | main.docbook | 12 | ||||
-rw-r--r-- | text.xml | 2 |
5 files changed, 68 insertions, 39 deletions
diff --git a/content/ebuild-writing/eapi.xmli b/content/ebuild-writing/eapi.xmli index 6e61591..45e0e46 100644 --- a/content/ebuild-writing/eapi.xmli +++ b/content/ebuild-writing/eapi.xmli @@ -11,7 +11,12 @@ <section> <title>Usage of EAPIs</title> - + <important> + An overview about the important features of each EAPI is provided in the + appendix of the Package Manager Specification. The two-page leaflet + can be printed out, consulted for reference and is available + as <command>app-doc/pms</command> in the main tree. + </important> <para> If <varname>EAPI</varname> is undefined in an ebuild, then <code>EAPI="0"</code> is selected. If you want to override the <varname>EAPI</varname> variable, you have to specify it at the top of the ebuild: diff --git a/content/ebuild-writing/misc-files/metadata.xmli b/content/ebuild-writing/misc-files/metadata.xmli index c222382..b32379f 100644 --- a/content/ebuild-writing/misc-files/metadata.xmli +++ b/content/ebuild-writing/misc-files/metadata.xmli @@ -9,6 +9,50 @@ The <filename>metadata.xml</filename> file is used to specify additional data about a package or category. </para> + <section> + <title>Package Metadata</title> + + <para> + For packages, <filename>metadata.xml</filename> can specify a long description and maintainer information. If a + long description in any language is provided, an English long description must be present. A typical example might + look like: + </para> + + <programlisting language="sgml"><![CDATA[ + <?xml version="1.0" encoding="UTF-8"?> + <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> + <pkgmetadata> + <herd>freedesktop</herd> + <maintainer> + <email>dang@gentoo.org</email> + <name>Daneel Grynewwicz</name> + </maintainer> + <longdescription lang="en"> + HAL provides a view of the various hardware attached to a + system. + In addition to this, HAL keeps detailed metadata for each + piece of hardware and provide hooks such that system- and + desktop-level software can react to changes in the + hardware configuration in order to maintain system policy. + </longdescription> + <flag name="laptop">Adds support for power management scripts + (<pkg>sys-power/pm-utils</pkg>) </flag> + <flag anme="selinux"> Installs SELinux policies and links HAL to the SELinux libraries</flag> + </pkgmetadata> +]]></programlisting> + + <para> + All new packages <emphasis>must</emphasis> include a <filename>metadata.xml</filename> file which specifies at + <emphasis>least</emphasis> a herd. If no herd is suitable, <literal>no-herd</literal> should be used, and at least + one maintainer must be listed — however, if at all possible, find a herd willing to be listed. If a package has no maintainer, <command>maintainer-needed@gentoo.org</command> should be listed as the maintainer. + </para> + + <para> + Commits of package metadata files are handled by <command>repoman</command>. You should ensure that you have + <package>dev-libs/libxml2</package> installed so that the XML can be validated. + </para> + </section> + <section xml:id="ebuild-writing.misc-files.metadata.category-metadata"> <title>Category Metadata</title> @@ -51,41 +95,4 @@ cvs commit -m "Adding category metadata.xml for my-category" metadata.xml ]]></programlisting> </section> - <section> - <title>Package Metadata</title> - - <para> - For packages, <filename>metadata.xml</filename> can specify a long description and maintainer information. If a - long description in any language is provided, an English long description must be present. A typical example might - look like: - </para> - - <programlisting language="sgml"><![CDATA[ - <?xml version="1.0" encoding="UTF-8"?> - <!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> - <pkgmetadata> - <herd>vim</herd> - <maintainer> - <email>ciaranm@gentoo.org</email> - <name>Ciaran McCreesh</name> - </maintainer> - <longdescription lang="en"> - This package provides Vim syntax highlighting for Cfengine configuration - files, and automatic filetype detection for these files based upon - filename. - </longdescription> - </pkgmetadata> -]]></programlisting> - - <para> - All new packages <emphasis>must</emphasis> include a <filename>metadata.xml</filename> file which specifies at - <emphasis>least</emphasis> a herd. If no herd is suitable, <literal>no-herd</literal> should be used, and at least - one maintainer must be listed — however, if at all possible, find a herd willing to be listed. - </para> - - <para> - Commits of package metadata files are handled by <command>repoman</command>. You should ensure that you have - <package>dev-libs/libxml2</package> installed so that the XML can be validated. - </para> - </section> </section> diff --git a/content/general-concepts/ebuild-revisions.xmli b/content/general-concepts/ebuild-revisions.xmli index 0402a6c..0c2f6f0 100644 --- a/content/general-concepts/ebuild-revisions.xmli +++ b/content/general-concepts/ebuild-revisions.xmli @@ -23,6 +23,11 @@ not affect the installed package for users who already managed to compile it. Small documentation fixes are also usually not grounds for a new revision. </para> + <important> + For ebuilds marked stable on at least one arch, only trivial edits can be made + without a bump (e.g. typo fixes in elog messages). Even simple changes may + result in a breakage. <emphasis role="strong">Modifying stable ebuilds should be avoided.</emphasis> + </important> <para> When doing a revision bump, the usual rules about dropping to <literal>~arch</literal> apply. diff --git a/main.docbook b/main.docbook index 1244bf3..bfeb81b 100644 --- a/main.docbook +++ b/main.docbook @@ -104,6 +104,18 @@ <surname>Loeser</surname> </personname> </author> + <author> + <personname> + <firstname>Petteri</firstname> + <surname>Räty</surname> + </personname> + </author> + <author> + <personname> + <firstname>Markos</firstname> + <surname>Chandras</surname> + </personname> + </author> <legalnotice> <para> @@ -18,7 +18,7 @@ detailed, up to date technical content. Tom Martin, Paul Varner, Ilya Volynets-Evenbakh, Diego Pettenò, Fernando J. Pereda, Simon Stelling, Alin Dobre, Joseph Jezak, Tim Yamin, Mark Loeser - </p> + </p> </dd> </dl> <p> |