* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2012-11-02 17:49 Markos Chandras
0 siblings, 0 replies; 25+ messages in thread
From: Markos Chandras @ 2012-11-02 17:49 UTC (permalink / raw
To: gentoo-commits
commit: 73fcee4546c673c10c68522359d37c7064a54a3a
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Fri Sep 23 08:54:03 2011 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Fri Nov 2 17:48:52 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=73fcee45
Make <herd/> optional, remove 'no-herd'. Bug #384175
---
ebuild-writing/misc-files/metadata/text.xml | 7 +++----
1 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index aca9a49..1cd4081 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -45,10 +45,9 @@ example might look like:
</codesample>
<p>
-All new packages <b>must</b> include a <c>metadata.xml</c> file which
-specifies at <e>least</e> a herd. If no herd is suitable, <c>no-herd</c>
-should be used, and at least one maintainer must be listed <d/> however,
-if at all possible, find a herd willing to be listed.
+All new packages <b>must</b> include a <c>metadata.xml</c> file. That file
+should specify at least one herd or one maintainer. It is however recommended,
+if at all possible, to find a herd willing to be listed.
</p>
<p>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2012-11-11 19:33 Markos Chandras
0 siblings, 0 replies; 25+ messages in thread
From: Markos Chandras @ 2012-11-11 19:33 UTC (permalink / raw
To: gentoo-commits
commit: 87754bded18b620fd926426acf0733b8f9a8403e
Author: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
AuthorDate: Sat Nov 3 22:20:06 2012 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sun Nov 11 19:32:24 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=87754bde
metadata: Add examples from the devrel handbook
---
ebuild-writing/misc-files/metadata/text.xml | 464 +++++++++++++++++++++++++--
1 files changed, 442 insertions(+), 22 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 1cd4081..5e6cd52 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -19,31 +19,452 @@ provided, an English long description must be present. A typical
example might look like:
</p>
+<subsection>
+<body>
+
+<p>
+A <path>metadata.xml</path> file can contain a number of tags:
+</p>
+
+<table>
+<tr>
+ <th>tag</th>
+ <th>description</th>
+</tr>
+<tr>
+ <ti>
+ <brite><pkgmetadata></brite>
+ </ti>
+ <ti>
+ This is the root element of the <path>metadata.xml</path> file for
+ packages. It has no attributes. The following subtags are
+ allowed:
+ <brite><herd></brite>,
+ <brite><maintainer></brite>,
+ <brite><longdescription></brite>,
+ <brite><use></brite>, and
+ <brite><upstream></brite>.
+ There should be at least one <brite><herd></brite> or
+ <brite><maintainer></brite> subtag.
+ </ti>
+</tr>
+<tr>
+ <ti>
+ <brite><catmetadata></brite>
+ </ti>
+ <ti>
+ This is the root element of the <path>metadata.xml</path> file for
+ categories as per <uri link="/proj/en/glep/glep-0034.html">GLEP 34</uri>.
+ It has no attributes. It contains a number of
+ <brite><longdescription></brite> tags, each for a different
+ language.
+ </ti>
+</tr>
+<tr>
+ <ti>
+ <brite><herd></brite>
+ </ti>
+ <ti>
+ If a package is maintained by one or more herds, names of these herds
+ can be specified with the <brite><herd></brite> tag. The names
+ used in this tag must be the same as specified in the <uri
+ link="http://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&rev=HEAD">herds.xml</uri>
+ file.
+ </ti>
+</tr>
+<tr>
+ <ti>
+ <brite><maintainer></brite>
+ </ti>
+ <ti>
+ Besides being part of a herd, a package can also be maintained directly.
+ The maintainers of a package can be specified with the
+ <brite><maintainer></brite> tag. This tag has one required subtag:
+ <brite><email></brite>. It has two optional subtags:
+ <brite><name></brite>, and <brite><description></brite>.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><email></brite></ti>
+ <ti>
+ This contains the e-mail address of the maintainer. It is required.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><name></brite></ti>
+ <ti>
+ This contains freetext with the name of the maintainer. It is optional.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><description></brite></ti>
+ <ti>
+ The description tag contains a description of the maintainership, or for
+ example a remark that someone interested can take over the maintainership.
+ It is optional.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><longdescription></brite></ti>
+ <ti>
+ This tag contains a description of the package. This is to augment the
+ DESCRIPTION field in the ebuilds themselves. This tag has two optional
+ subtags: <brite><pkg></brite> and <brite><cat></brite>.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><use></brite></ti>
+ <ti>
+ This tag contains descriptions of <uri
+ link="::ebuild-writing/variables#iuse">USE flags</uri>.
+ This tag is optional and, if specified, has one required subtag:
+ <brite><flag></brite>.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><flag></brite></ti>
+ <ti>
+ This tag contains a description of how the named USE flag affects this
+ package. It is required if the <brite><use></brite> tag is specified.
+ It also requires the USE flag to be named in the <c>name</c> attribute.
+ This tag has two optional subtags: <brite><pkg></brite> and
+ <brite><cat></brite>.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><upstream></brite></ti>
+ <ti>
+ This tag contains information about the upstream developers/project.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><maintainer></brite></ti>
+ <ti>
+ Name and e-mail of an upstream maintainer. May appear more than once.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><name></brite></ti>
+ <ti>
+ The name of an upstream maintainer should contain a block of text with upstream's name.
+ This element is mandatory for an upstream maintainer and must appear only once.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><email></brite></ti>
+ <ti>
+ The email address of an upstream may appear only once.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><changelog></brite></ti>
+ <ti>
+ Should contain a URL where the location of the upstream changelog can be found.
+ The URL must be version independent and must point to a changelog which is only
+ updated on new releases of the corresponding package. (This also implies that
+ one can link to an automatically updated changelog in case of vcs snapshots
+ only.)
+ </ti>
+</tr>
+<tr>
+ <ti><brite><doc></brite></ti>
+ <ti>
+ Should contain a URL where the location of the upstream documentation can be
+ found. The link must not point to any third party documentation and must be
+ version independent. If the documentation is available in more than one language,
+ a lang attribute can be used which follows the same rules as the one for
+ longdescription.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><bugs-to></brite></ti>
+ <ti>
+ Should contain a place where bugs can be filed, a URL or an e-mail address prefixed
+ with mailto:.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><remote-id></brite></ti>
+ <ti>
+ Should specify a type of package identification tracker and the identification that
+ corresponds to the package in question. remote-id should make it easier to index
+ information such as its Freshmeat ID or its CPAN name.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><pkg></brite></ti>
+ <ti>
+ This tag contains a valid package name in the format of a DEPEND.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><cat></brite></ti>
+ <ti>
+ This tag contains a valid category name as defined in
+ <path>profiles/categories</path>.
+ </ti>
+</tr>
+</table>
+
+<p>
+There are also some attributes that can be used with these tags. They are all
+optional:
+</p>
+
+<table>
+<tr>
+ <th>attribute</th>
+ <th>tags</th>
+ <th>description</th>
+</tr>
+<tr>
+ <ti>lang</ti>
+ <ti>
+ <brite><description></brite>, <brite><longdescription></brite>,
+ <brite><use></brite>, <brite><doc></brite>
+ </ti>
+ <ti>
+ In every case where a description is required, there must be at
+ <e>least</e> an english description. If an additional description in
+ another language is given, this attribute is used to specify the language
+ used. The format is the two-character language code as defined by the <uri
+ link="http://www.w3.org/WAI/ER/IG/ert/iso639.htm#2letter">ISO-639-1</uri>
+ norm.
+ </ti>
+</tr>
+<tr>
+ <ti>restrict</ti>
+ <ti>
+ <brite><herd></brite>, <brite><maintainer></brite>,
+ <brite><longdescription></brite>, <brite><flag></brite>
+ </ti>
+ <ti>
+ The restrict attribute allows one to restrict the application of certain
+ tags to certain versions of a package. When this attribute is used, a tag
+ without this attribute must also exist. That tag without the restrict
+ attribute will serve as the default. The format of the restrict attribute
+ is that of the DEPEND flag, except that "<" and
+ ">" need to be specified by &lt; and &gt;.<br />
+ <br />
+ For example, in the <c>sys-libs/db</c> package,
+ <c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> on the
+ <brite>maintainer</brite> tag shows that I'm currently maintaining all
+ versions greater then 3.2.9-r5.
+ </ti>
+</tr>
+<tr>
+ <ti>name</ti>
+ <ti>
+ <brite><flag></brite>
+ </ti>
+ <ti>
+ This attribute is required on the <brite><flag></brite> tag. It
+ simply contains the USE flag.
+ <br /><br />
+ For example, in the <c>sys-apps/hal</c> package, <c><flag name='acpi'>
+ Enables ACPI</flag></c>
+ </ti>
+</tr>
+<tr>
+ <ti>status</ti>
+ <ti>
+ <brite><maintainer></brite>
+ </ti>
+ <ti>
+ The upstream maintainer element has a status attribute, which is one of active or inactive.
+ This attribute is not mandatory. The absence of it shall be interpreted as unknown.
+ Please note: This attribute is only allowed in the <upstream> <maintainer> element!
+ </ti>
+</tr>
+<tr>
+ <ti>type</ti>
+ <ti>
+ <brite><remote-id></brite>
+ </ti>
+ <ti>
+ A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd.
+ Developers should email the gentoo-dev mailing list before using a new type value.
+ </ti>
+</tr>
+
+</table>
+
+</body>
+</subsection>
+
+</body>
+</section>
+
+<section>
+<title>Metadata Examples</title>
+<subsection>
+<title>First Example</title>
+<body>
+
+<p>
+In this first example we provide you with the <path>metadata.xml</path> for
+OpenOffice of which the ebuilds are completely managed by a herd called
+<c>openoffice</c>:
+</p>
+
<codesample lang="sgml">
- <?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>Daniel Gryniewicz</name>
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <herd>openoffice</herd>
+ <longdescription>
+ OpenOffice is the opensource version of staroffice.
+ This ebuild allows you to compile it yourself. Unfortunately this
+ compilation can take up to a day depending on the speed of your
+ computer. It will however make a snappier openoffice than the binary
+ version.
+ </longdescription>
+</pkgmetadata>
+</codesample>
+
+<p>
+The <c>openoffice</c> herd is defined in <path>herds.xml</path> by the
+<uri link="/proj/en/metastructure">Gentoo Metastructure Project</uri>:
+</p>
+
+<note>
+This example may be outdated when you read it. It's just an example!
+</note>
+
+<codesample lang="sgml">
+<herd>
+ <name>openoffice</name>
+ <email>openoffice@gentoo.org</email>
+ <description>Openoffice related packages</description>
+ <maintainer><email>pauldv@gentoo.org</email></maintainer>
+ <maintainer><email>suka@gentoo.org</email></maintainer>
+</herd>
+</codesample>
+
+<p>
+If you want to add (or remove) yourself from a herd, edit <path>herds.xml</path>
+located in <path>[gentoo]/xml/htdocs/proj/en/metastructure/herds</path> in Gentoo's CVS repository. Make sure you
+know the e-mail alias the herd listens to (for instance the "sound" herd has
+<mail link="sound@gentoo.org">sound@gentoo.org</mail>) and add yourself to the
+alias (by editing <path>/var/mail/alias/misc/<alias name></path> on
+dev.gentoo.org).
+</p>
+
+</body>
+</subsection>
+<subsection>
+<title>Second Example</title>
+<body>
+
+<p>
+For the second example, we will examine the <path>metadata.xml</path> of
+<c>app-portage/mirrorselect</c>. This ebuild is maintained by the
+<c>tools-portage</c> herd, but has a separate maintainer.
+</p>
+
+<pre caption="Herd & individually maintained package">
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <herd>tools-portage</herd>
+ <maintainer>
+ <email>johnm@gentoo.org</email>
+ <name>John Mylchreest</name>
+ </maintainer>
+ <longdescription>
+ This utility is used to select the fastest mirror (distfiles) and provide a
+ nicer front-end for mirror selection (both rsync + distfiles) to a user.
+ </longdescription>
+</pkgmetadata>
+</pre>
+
+</body>
+</subsection>
+<subsection>
+<title>Third Example</title>
+<body>
+
+<p>
+For the third example, we will describe the <path>metadata.xml</path> of
+<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd
+and contains USE flag descriptions.
+</p>
+
+<codesample lang="sgml">
+<?xml version="1.0" encoding="UTF-8">
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+<herd>gentopia</herd>
+<maintainer>
+ <email>compnerd@gentoo.org</email>
+</maintainer>
+<maintainer>
+ <email>steev@gentoo.org</email>
+</maintainer>
+<use>
+ <flag name='acpi'>Enables HAL to attempt to read from
+ /proc/acpi/event, if unavailable, HAL will read events from
+ <pkg>sys-power/acpid</pkg>. If you need multiple acpi
+ readers, ensure acpid is in your default runlevel along with HAL. This
+ will also enable HAL to read Toshia and IBM acpi events which do not
+ get sent via /proc/acpi/event</flag>
+ <flag name='crypt'>Allows HAL to mount volumes that are encrypted using
+ LUKS. <pkg>sys-fs/cryptsetup-luks</pkg> which has recently been renamed
+ to <pkg>sys-fs/cryptsetup</pkg> allows you to create such encrypted
+ volumes. HAL will be able to handle volumes that are removable or
+ fixed.</flag>
+ <flag name='dell'>Builds an installs the Dell addon, which reads data from
+ the Dell SM BIOS via <pkg>sys-libs/libsmbios</pkg>. It will read your
+ service tag information and your hardware backlight data as well as
+ allow you to modify the backlight settings on a Dell laptop.</flag>
+ <flag name='disk-partition'>Allows HAL to use libparted from
+ <pkg>sys-apps/parted</pkg> to read raw partition data from your disks
+ and process that data. Future versions of HAL (possibly 0.5.11 and
+ higher) will allow you to create, modify, delete and format partitions
+ from a GUI interface agnostic of your desktop environment.</flag>
+ <flag name='doc'>Generates documentation that describes HAL's fdi
+ format.</flag>
+ <flag name='pcmcia'>Allows HAL to process PCMCIA/CardBus slot data which
+ includes inserts and removals and act on these events.</flag>
+ <flag name='selinux'>Installs SELinux policies and links HAL to the SELinux
+ libraries.</flag>
+</use>
+</pkgmetadata>
+</codesample>
+
+</body>
+</subsection>
+<subsection>
+<title>Fourth Example</title>
+<body>
+
+<p>
+This example demonstrates the usage of the upstream element:
+</p>
+
+<codesample lang="sgml">
+<upstream>
+ <maintainer status="inactive">
+ <name>Foo Bar</name>
+ <email>foo@bar.bar</email>
+ </maintainer>
+ <maintainer status="active">
+ <name>Foo Gentoo</name>
+ <email>foo@gentoo.org</email>
</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>
- <use>
- <flag name="laptop">Adds support for power management scripts
- (<pkg>sys-power/pm-utils</pkg>)</flag>
- <flag name="selinux">Installs SELinux policies and links HAL to the SELinux
- libraries.</flag>
- </use>
- </pkgmetadata>
+ <changelog>http://foo.bar/changelog.txt</changelog>
+ <doc lang="en">http://foo.bar/doc/index.html</doc>
+ <doc lang="de">http://foo.bar/doc/index.de.html</doc>
+ <bugs-to>https://bugs.foo.bar</bugs-to>
+ <remote-id type="freshmeat">foobar</remote-id>
+ <remote-id type="sourceforge">foobar</remote-id>
+</upstream>
</codesample>
+</body>
+</subsection>
+
+
<p>
All new packages <b>must</b> include a <c>metadata.xml</c> file. That file
should specify at least one herd or one maintainer. It is however recommended,
@@ -67,7 +488,6 @@ should ensure that you have <c>dev-libs/libxml2</c> installed so that
the XML can be validated.
</p>
-</body>
</section>
<section>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2013-05-12 15:06 Markos Chandras
0 siblings, 0 replies; 25+ messages in thread
From: Markos Chandras @ 2013-05-12 15:06 UTC (permalink / raw
To: gentoo-commits
commit: dbf57aa14ab984bc62cbe3a4cbfc4c448241c33f
Author: Sergey Popov <admin <AT> pinkbyte <DOT> ru>
AuthorDate: Sun May 12 13:48:42 2013 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sun May 12 13:49:28 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=dbf57aa1
Fix for incorrect hyperlink to metastructure project, see https://bugs.gentoo.org/show_bug.cgi?id=455132
---
ebuild-writing/misc-files/metadata/text.xml | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 5e6cd52..675c58c 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -324,7 +324,7 @@ OpenOffice of which the ebuilds are completely managed by a herd called
<p>
The <c>openoffice</c> herd is defined in <path>herds.xml</path> by the
-<uri link="/proj/en/metastructure">Gentoo Metastructure Project</uri>:
+<uri link="http://www.gentoo.org/proj/en/metastructure">Gentoo Metastructure Project</uri>:
</p>
<note>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2014-01-03 18:32 Markos Chandras
0 siblings, 0 replies; 25+ messages in thread
From: Markos Chandras @ 2014-01-03 18:32 UTC (permalink / raw
To: gentoo-commits
commit: 909daf36515b412f1f79f5734e8f82ea3bc10c4e
Author: David Heidelberger <david.heidelberger <AT> ixit <DOT> cz>
AuthorDate: Fri Jan 3 00:27:18 2014 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Fri Jan 3 00:27:18 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=909daf36
metadata: fix important sequence of email and name in maintainer section
---
ebuild-writing/misc-files/metadata/text.xml | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 675c58c..28c7dfc 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -144,16 +144,16 @@ A <path>metadata.xml</path> file can contain a number of tags:
</ti>
</tr>
<tr>
- <ti><brite><name></brite></ti>
+ <ti><brite><email></brite></ti>
<ti>
- The name of an upstream maintainer should contain a block of text with upstream's name.
- This element is mandatory for an upstream maintainer and must appear only once.
+ The email address of an upstream may appear only once and must appear in first place.
</ti>
</tr>
<tr>
- <ti><brite><email></brite></ti>
+ <ti><brite><name></brite></ti>
<ti>
- The email address of an upstream may appear only once.
+ The name of an upstream maintainer should contain a block of text with upstream's name.
+ This element is mandatory for an upstream maintainer and must appear only once.
</ti>
</tr>
<tr>
@@ -445,12 +445,12 @@ This example demonstrates the usage of the upstream element:
<codesample lang="sgml">
<upstream>
<maintainer status="inactive">
- <name>Foo Bar</name>
<email>foo@bar.bar</email>
+ <name>Foo Bar</name>
</maintainer>
<maintainer status="active">
- <name>Foo Gentoo</name>
<email>foo@gentoo.org</email>
+ <name>Foo Gentoo</name>
</maintainer>
<changelog>http://foo.bar/changelog.txt</changelog>
<doc lang="en">http://foo.bar/doc/index.html</doc>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2014-01-19 15:14 Markos Chandras
0 siblings, 0 replies; 25+ messages in thread
From: Markos Chandras @ 2014-01-19 15:14 UTC (permalink / raw
To: gentoo-commits
commit: 3c103d46f60a1579879eb45113f097b6ebb8ee7c
Author: Markus Meier <maekke <AT> gentoo <DOT> org>
AuthorDate: Sun Jan 19 12:56:46 2014 +0000
Commit: Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sun Jan 19 15:13:13 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=3c103d46
ebuild-writing/metadata: Fix second metadata.xml example
use <codesample lang="sgml"> instead of <pre> to get colored output
like the other examples.
X-Gentoo-Bug: 498556
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=498556
---
ebuild-writing/misc-files/metadata/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 28c7dfc..79e3291 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -362,7 +362,7 @@ For the second example, we will examine the <path>metadata.xml</path> of
<c>tools-portage</c> herd, but has a separate maintainer.
</p>
-<pre caption="Herd & individually maintained package">
+<codesample lang="sgml">
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
@@ -376,7 +376,7 @@ For the second example, we will examine the <path>metadata.xml</path> of
nicer front-end for mirror selection (both rsync + distfiles) to a user.
</longdescription>
</pkgmetadata>
-</pre>
+</codesample>
</body>
</subsection>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 3e930ac8b66435a57c5375351e58d61e4491a6b2
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:33 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:19 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3e930ac8
ebuild-writing/misc-files: replace the code for cvs commit with git #558642
Replace "cvs commit" with the equivalent "git add && git commit" version.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-writing/misc-files/metadata/text.xml | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index e506b1c..2de3cf5 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -532,7 +532,21 @@ is currently:
<pre>
xmllint --noout --valid metadata.xml
glep31check metadata.xml
-cvs commit -m "Adding category metadata.xml for my-category" metadata.xml
+git add metadata.xml
+git commit --gpg-sign
+</pre>
+
+<p>
+The commit message should be formatted properly.
+A sample commit is shown below:
+</p>
+
+<pre>
+commit db359439bcd52f5a7f20d2332ab62feb16657504
+Author: Alexis Ballier <aballier@gentoo.org>
+Date: Tue Sep 22 10:47:49 2015 +0200
+
+ dev-ros: Add metadata.xml for the category.
</pre>
</body>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 4688fe60725dcf52e5cd8c4e9574f0f200dbabc8
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri Feb 5 12:50:41 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:22 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4688fe60
ebuild-writing/misc-files/metadata: Don't mention glep31check.
This tool isn't (and never was) in the tree and the sources seem to be
unavailable. Therefore the documentation should not recommend its use.
Bug: 572156
ebuild-writing/misc-files/metadata/text.xml | 1 -
1 file changed, 1 deletion(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 2de3cf5..2324f53 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -531,7 +531,6 @@ is currently:
<pre>
xmllint --noout --valid metadata.xml
-glep31check metadata.xml
git add metadata.xml
git commit --gpg-sign
</pre>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-05-18 5:32 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-05-18 5:32 UTC (permalink / raw
To: gentoo-commits
commit: 1ed9fb686fd3b10ee9a0f7f4b797765073508113
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Apr 28 07:53:34 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Wed May 18 04:39:49 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1ed9fb68
ebuild-writing/misc-files/metadata: add an example for slots and subslots
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-writing/misc-files/metadata/text.xml | 50 +++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 3d135a6..486af11 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -549,6 +549,56 @@ is demonstrated.
</body>
</subsubsection>
+<subsubsection>
+<title>Slots and Subslots</title>
+<body>
+
+<p>
+The main focus of this example is to demonstrate how slots and
+subslots are specified, by examining the metadata of
+<path>media-libs/libpng</path>. There may be multiple reasons for
+slotting depending on the nature of the package. For this particular
+package, it can be seen that the slots are used to provide different
+versions of the library with varying binary compatibility and that
+developers are advised to build against the slot 0. Furthermore,
+different versions of this package with the same subslot provide the
+same Application Binary Interface (ABI), according to the description
+specified in the <c><subslots></c> tag.
+</p>
+
+<codesample lang="sgml">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <maintainer type="project">
+ <email>base-system@gentoo.org</email>
+ <name>Gentoo Base System</name>
+ </maintainer>
+ <use>
+ <flag name="apng">support unofficial APNG (Animated PNG) spec</flag>
+ </use>
+ <upstream>
+ <remote-id type="cpe">cpe:/a:libpng:libpng</remote-id>
+ <remote-id type="sourceforge">apng</remote-id>
+ </upstream>
+ <slots>
+ <slot name="0">
+ For building against. This is the only slot
+ that provides headers and command line tools.
+ </slot>
+ <slot name="1.2">
+ For binary compatibility, provides libpng12.so.0 only.
+ </slot>
+ <slot name="1.5">
+ For binary compatibility, provides libpng15.so.15 only.
+ </slot>
+ <subslots>Reflect ABI compatibility for libpng.so.</subslots>
+ </slots>
+</pkgmetadata>
+</codesample>
+
+</body>
+</subsubsection>
</body>
</subsection>
<subsection>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-05-18 5:32 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-05-18 5:32 UTC (permalink / raw
To: gentoo-commits
commit: ce5c5b320b1d69080c1ee9591c984ad1f28ee49c
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Mon Feb 29 08:18:41 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Wed May 18 04:39:49 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ce5c5b32
ebuild-writing/misc-files/metadata: rewrite the section per GLEP 67 #572144
A major rewrite of the section. Here is a brief summary of changes:
- Remove the information about the <herd> tag per GLEP 67
- Restructure the section in the following order:
- metadata.xml syntax
- package metadata
- metadata examples
- maintainer-needed
- category metadata
- Update the tables for metadata.xml syntax per GLEP 67
- Rewrite the package metadata examples to reflect better on GLEP 67
and enhance with more explanations
- Assign meaningful titles to package metadata examples instead of
using "First Example", "Second Example" etc.
- Add a subsection for handling maintainer-needed in metadata.xml
per GLEP 67 and provide an example
This commit also makes #545272 obsolete.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=572144
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=545272
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-writing/misc-files/metadata/text.xml | 418 ++++++++++++++++------------
1 file changed, 238 insertions(+), 180 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 2324f53..31ec926 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -10,16 +10,7 @@ package or category.
</p>
<section>
-<title>Package Metadata</title>
-<body>
-<p>
-For packages, <c>metadata.xml</c> 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:
-</p>
-
-<subsection>
+<title>Syntax</title>
<body>
<p>
@@ -39,13 +30,10 @@ A <path>metadata.xml</path> file can contain a number of tags:
This is the root element of the <path>metadata.xml</path> file for
packages. It has no attributes. The following subtags are
allowed:
- <brite><herd></brite>,
<brite><maintainer></brite>,
<brite><longdescription></brite>,
<brite><use></brite>, and
<brite><upstream></brite>.
- There should be at least one <brite><herd></brite> or
- <brite><maintainer></brite> subtag.
</ti>
</tr>
<tr>
@@ -62,26 +50,16 @@ A <path>metadata.xml</path> file can contain a number of tags:
</tr>
<tr>
<ti>
- <brite><herd></brite>
- </ti>
- <ti>
- If a package is maintained by one or more herds, names of these herds
- can be specified with the <brite><herd></brite> tag. The names
- used in this tag must be the same as specified in the <uri
- link="https://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plain&rev=HEAD">herds.xml</uri>
- file.
- </ti>
-</tr>
-<tr>
- <ti>
<brite><maintainer></brite>
</ti>
<ti>
- Besides being part of a herd, a package can also be maintained directly.
- The maintainers of a package can be specified with the
- <brite><maintainer></brite> tag. This tag has one required subtag:
+ This tag specifies the persons and/or projects responsible for
+ the maintenance of a package. The <c>type</c> attribute must
+ be specified and can be either <c>"person"</c> or
+ <c>"project"</c>. There is one required subtag:
<brite><email></brite>. It has two optional subtags:
- <brite><name></brite>, and <brite><description></brite>.
+ <brite><name></brite> and
+ <brite><description></brite>.
</ti>
</tr>
<tr>
@@ -207,8 +185,7 @@ A <path>metadata.xml</path> file can contain a number of tags:
</table>
<p>
-There are also some attributes that can be used with these tags. They are all
-optional:
+There are also some attributes that can be used with these tags:
</p>
<table>
@@ -235,7 +212,7 @@ optional:
<tr>
<ti>restrict</ti>
<ti>
- <brite><herd></brite>, <brite><maintainer></brite>,
+ <brite><maintainer></brite>,
<brite><longdescription></brite>, <brite><flag></brite>
</ti>
<ti>
@@ -244,12 +221,7 @@ optional:
without this attribute must also exist. That tag without the restrict
attribute will serve as the default. The format of the restrict attribute
is that of the DEPEND flag, except that "<" and
- ">" need to be specified by &lt; and &gt;.<br />
- <br />
- For example, in the <c>sys-libs/db</c> package,
- <c>restrict="&gt;=sys-libs/db-3.2.9-r5"</c> on the
- <brite>maintainer</brite> tag shows that I'm currently maintaining all
- versions greater then 3.2.9-r5.
+ ">" need to be specified by "&lt;" and "&gt;".
</ti>
</tr>
<tr>
@@ -282,212 +254,298 @@ optional:
<brite><remote-id></brite>
</ti>
<ti>
- A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd.
+ A string identifying the type of upstream source. A list of valid strings are kept in
+ <uri link="https://www.gentoo.org/dtd/metadata.dtd">metadata.dtd</uri>.
Developers should email the gentoo-dev mailing list before using a new type value.
</ti>
</tr>
+<tr>
+ <ti>type</ti>
+ <ti>
+ <brite><maintainer></brite>
+ </ti>
+ <ti>
+ Defines the type of the maintainer for a package. There are only
+ two valid values: <c>"person"</c> and <c>"project"</c>. The latter
+ denotes an official
+ <uri link="::general-concepts/herds-and-projects">
+ Gentoo project</uri>.
+ </ti>
+</tr>
</table>
</body>
-</subsection>
-
-</body>
</section>
-
<section>
-<title>Metadata Examples</title>
-<subsection>
-<title>First Example</title>
+<title>Package Metadata</title>
<body>
-
<p>
-In this first example we provide you with the <path>metadata.xml</path> for
-OpenOffice of which the ebuilds are completely managed by a herd called
-<c>openoffice</c>:
+All packages <b>must</b> include a <c>metadata.xml</c> file which
+provides information about package description, maintainers, local USE
+flags, upstream etc.
</p>
-<codesample lang="sgml">
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
-<pkgmetadata>
- <herd>openoffice</herd>
- <longdescription>
- OpenOffice is the opensource version of staroffice.
- This ebuild allows you to compile it yourself. Unfortunately this
- compilation can take up to a day depending on the speed of your
- computer. It will however make a snappier openoffice than the binary
- version.
- </longdescription>
-</pkgmetadata>
-</codesample>
+<p>
+For developers' convenience, a skeleton file is provided in the
+Gentoo tree with the name
+<uri link="https://gitweb.gentoo.org/repo/gentoo.git/tree/skel.metadata.xml">
+skel.metadata.xml</uri>. The metadata file can also be created
+using the <c>app-portage/metagen</c> tool.
+</p>
<p>
-The <c>openoffice</c> herd is defined in <path>herds.xml</path> by the
-<uri link="https://www.gentoo.org/proj/en/metastructure">Gentoo Metastructure Project</uri>:
+Commits of package metadata files are handled by <c>repoman</c>. In
+order for metadata checks to be performed, <c>dev-libs/libxml2</c>
+must be installed on the system.
</p>
-<note>
-This example may be outdated when you read it. It's just an example!
-</note>
+<p>
+Unless specified otherwise, the maintainer who is listed in the
+metadata first shall be the assignee for the bugs for that package as
+per <uri link="https://wiki.gentoo.org/wiki/GLEP:67#Bug_assignment">
+GLEP 67</uri>.
+</p>
-<codesample lang="sgml">
-<herd>
- <name>openoffice</name>
- <email>openoffice@gentoo.org</email>
- <description>Openoffice related packages</description>
- <maintainer><email>pauldv@gentoo.org</email></maintainer>
- <maintainer><email>suka@gentoo.org</email></maintainer>
-</herd>
-</codesample>
+<subsection>
+<title>Package Metadata Examples</title>
+<body>
<p>
-If you want to add (or remove) yourself from a herd, edit <path>herds.xml</path>
-located in <path>[gentoo]/xml/htdocs/proj/en/metastructure/herds</path> in Gentoo's CVS repository. Make sure you
-know the e-mail alias the herd listens to (for instance the "sound" herd has
-<mail link="sound@gentoo.org">sound@gentoo.org</mail>) and add yourself to the
-alias (by editing <path>/var/mail/alias/misc/<alias name></path> on
-dev.gentoo.org).
+In the following sections, various examples of metadata.xml are
+provided. These examples are based on actual package metadata files to
+keep things as realistic as possible. However, they may not include
+these files verbatim and should be taken as hypothetical examples.
</p>
-</body>
-</subsection>
-<subsection>
-<title>Second Example</title>
+<subsubsection>
+<title>Projects as Maintainers</title>
<body>
<p>
-For the second example, we will examine the <path>metadata.xml</path> of
-<c>app-portage/mirrorselect</c>. This ebuild is maintained by the
-<c>tools-portage</c> herd, but has a separate maintainer.
+For the first example, a package maintained by a single project is
+presented. It is a simplified version of <path>metadata.xml</path> for
+the package <path>app-office/libreoffice</path>. The package
+maintainer is identified by the email address <c>office@gentoo.org</c>
+with the name <c>Gentoo Office Project</c> as specified in the
+optional <name> subtag. It also provides a long package
+description.
</p>
<codesample lang="sgml">
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <herd>tools-portage</herd>
- <maintainer>
- <email>johnm@gentoo.org</email>
- <name>John Mylchreest</name>
+ <maintainer type="project">
+ <email>office@gentoo.org</email>
+ <name>Gentoo Office Project</name>
</maintainer>
<longdescription>
- This utility is used to select the fastest mirror (distfiles) and provide a
- nicer front-end for mirror selection (both rsync + distfiles) to a user.
+ LibreOffice is the successor of OpenOffice.org. This ebuild
+ allows you to compile it yourself. Unfortunately this compilation can
+ take up to a day depending on the speed of your computer. It will
+ however make a snappier LibreOffice than the binary version.
</longdescription>
</pkgmetadata>
</codesample>
-</body>
-</subsection>
-<subsection>
-<title>Third Example</title>
-<body>
-
<p>
-For the third example, we will describe the <path>metadata.xml</path> of
-<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd
-and contains USE flag descriptions.
+The email address <c>office@gentoo.org</c> corresponds to the
+<c>Gentoo Office Project</c> as defined in
+<uri link="https://api.gentoo.org/metastructure/projects.xml">
+projects.xml</uri>. This file lists all the projects in Gentoo and it
+is generated from the
+<uri link="https://wiki.gentoo.org/wiki/Project:Gentoo">
+projects listing</uri> available on the Gentoo Wiki:
</p>
<codesample lang="sgml">
-<?xml version="1.0" encoding="UTF-8">
-<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
-<pkgmetadata>
-<herd>gentopia</herd>
-<maintainer>
- <email>compnerd@gentoo.org</email>
-</maintainer>
-<maintainer>
- <email>steev@gentoo.org</email>
-</maintainer>
-<use>
- <flag name='acpi'>Enables HAL to attempt to read from
- /proc/acpi/event, if unavailable, HAL will read events from
- <pkg>sys-power/acpid</pkg>. If you need multiple acpi
- readers, ensure acpid is in your default runlevel along with HAL. This
- will also enable HAL to read Toshia and IBM acpi events which do not
- get sent via /proc/acpi/event</flag>
- <flag name='crypt'>Allows HAL to mount volumes that are encrypted using
- LUKS. <pkg>sys-fs/cryptsetup-luks</pkg> which has recently been renamed
- to <pkg>sys-fs/cryptsetup</pkg> allows you to create such encrypted
- volumes. HAL will be able to handle volumes that are removable or
- fixed.</flag>
- <flag name='dell'>Builds an installs the Dell addon, which reads data from
- the Dell SM BIOS via <pkg>sys-libs/libsmbios</pkg>. It will read your
- service tag information and your hardware backlight data as well as
- allow you to modify the backlight settings on a Dell laptop.</flag>
- <flag name='disk-partition'>Allows HAL to use libparted from
- <pkg>sys-apps/parted</pkg> to read raw partition data from your disks
- and process that data. Future versions of HAL (possibly 0.5.11 and
- higher) will allow you to create, modify, delete and format partitions
- from a GUI interface agnostic of your desktop environment.</flag>
- <flag name='doc'>Generates documentation that describes HAL's fdi
- format.</flag>
- <flag name='pcmcia'>Allows HAL to process PCMCIA/CardBus slot data which
- includes inserts and removals and act on these events.</flag>
- <flag name='selinux'>Installs SELinux policies and links HAL to the SELinux
- libraries.</flag>
-</use>
-</pkgmetadata>
+<project>
+ <email>office@gentoo.org</email>
+ <name>Gentoo Office Project</name>
+ <url>https://wiki.gentoo.org/wiki/Project:Office</url>
+ <description>
+ The Office project manages the office implementations
+ and related packages in Gentoo.
+ </description>
+ <member>
+ <email>dilfridge@gentoo.org</email>
+ <name>Andreas K. Hüttel</name>
+ <role>member</role>
+ </member>
+ <member>
+ <email>scarabeus@gentoo.org</email>
+ <name>Tomáš Chvátal</name>
+ <role>member</role>
+ </member>
+</project>
</codesample>
</body>
-</subsection>
-<subsection>
-<title>Fourth Example</title>
+</subsubsection>
+<subsubsection>
+<title>Local USE Flag Descriptions</title>
<body>
<p>
-This example demonstrates the usage of the upstream element:
+The second example is formed after the <path>metadata.xml</path> of
+<path>sys-apps/portage</path>. It lists multiple maintainers where one
+is a developer and the other is a project. It illustrates how local
+USE flag descriptions are specified and also contains an upstream
+element. It is also worth pointing out the use of <c>mailto:</c>
+prefix in <bugs-to> tag due to the presence of an email address
+as opposed to a URL. Conversely, email addresses specified in the
+<email> tags require no such prefix.
</p>
<codesample lang="sgml">
-<upstream>
- <maintainer status="inactive">
- <email>foo@bar.bar</email>
- <name>Foo Bar</name>
- </maintainer>
- <maintainer status="active">
- <email>foo@gentoo.org</email>
- <name>Foo Gentoo</name>
- </maintainer>
- <changelog>http://foo.bar/changelog.txt</changelog>
- <doc lang="en">http://foo.bar/doc/index.html</doc>
- <doc lang="de">http://foo.bar/doc/index.de.html</doc>
- <bugs-to>https://bugs.foo.bar</bugs-to>
- <remote-id type="freshmeat">foobar</remote-id>
- <remote-id type="sourceforge">foobar</remote-id>
-</upstream>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <upstream>
+ <bugs-to>mailto:dev-portage@gentoo.org</bugs-to>
+ <changelog>https://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES</changelog>
+ <doc>https://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage</doc>
+ </upstream>
+ <maintainer type="person">
+ <email>larry@gentoo.org</email>
+ <name>Larry the Cow</name>
+ </maintainer>
+ <maintainer type="project">
+ <email>dev-portage@gentoo.org</email>
+ </maintainer>
+ <use>
+ <flag name="epydoc">Build html API documentation with epydoc.</flag>
+ <flag name="ipc">Use inter-process communication between portage and running ebuilds.</flag>
+ <flag name="pypy2_0">Use pypy-c2.0 as Python interpreter.</flag>
+ <flag name="python2">Use python2 as Python interpreter.</flag>
+ <flag name="python3">Use python3 as Python interpreter.</flag>
+ <flag name="xattr">
+ Preserve extended attributes (filesystem-stored metadata) when
+ installing files. Usually only required for hardened systems.
+ </flag>
+ </use>
+</pkgmetadata>
</codesample>
</body>
-</subsection>
-
+</subsubsection>
+<subsubsection>
+<title>Split Maintainership</title>
+<body>
<p>
-All new packages <b>must</b> include a <c>metadata.xml</c> file. That file
-should specify at least one herd or one maintainer. It is however recommended,
-if at all possible, to find a herd willing to be listed.
+This example splits the maintainership based on package versions using
+the attribute <c>restrict</c>. According to the
+<path>metadata.xml</path> of <path>sys-boot/grub</path>, the ebuilds
+for version 2 and above are maintained by floppym@gentoo.org whereas
+earlier versions are maintained by the Gentoo Base System
+project. Note the use of "&gt;" as opposed to ">" in
+<c>restrict</c>.
</p>
<p>
-If a package has no maintainer, <c>maintainer-needed@gentoo.org</c>
-should be listed as the maintainer.
+The example also uses the <c><pkg></c> tag in USE flag
+descriptions. Slot operators are not allowed inside <pkg>,
+therefore the notation <pkg>sys-boot/grub</pkg><c>:2</c>
+is adopted as opposed to
+<pkg>sys-boot/grub<c>:2</c></pkg>.
</p>
<p>
-To easily create <c>metadata.xml </c>files, you can use
-<c>app-portage/metagen</c>. There is also a skeleton file, see
-<c>/usr/portage/skel.metadata.xml</c>.
+Lastly, the <c><remote-id></c> tag in the upstream description
+is demonstrated.
</p>
+<codesample lang="sgml">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <maintainer restrict="&gt;=sys-boot/grub-2" type="person">
+ <email>floppym@gentoo.org</email>
+ </maintainer>
+ <maintainer type="project">
+ <email>base-system@gentoo.org</email>
+ <name>Gentoo Base System</name>
+ </maintainer>
+ <use>
+ <flag name="device-mapper">
+ Enable support for device-mapper from <pkg>sys-fs/lvm2</pkg>
+ </flag>
+ <flag name="efiemu">
+ Build and install the efiemu runtimes
+ </flag>
+ <flag name="fonts">Build and install fonts for the gfxterm module</flag>
+ <flag name="mount">
+ Build and install the grub-mount utility
+ </flag>
+ <flag name="libzfs">
+ Enable support for <pkg>sys-fs/zfs</pkg>
+ </flag>
+ <flag name="multislot">
+ Allow concurrent installation of <pkg>sys-boot/grub</pkg>:0 and
+ <pkg>sys-boot/grub</pkg>:2 by renaming all programs.
+ </flag>
+ <flag name="themes">Build and install GRUB themes (starfield)</flag>
+ <flag name="truetype">
+ Build and install grub-mkfont conversion utility
+ </flag>
+ </use>
+ <upstream>
+ <remote-id type="sourceforge">dejavu</remote-id>
+ </upstream>
+</pkgmetadata>
+</codesample>
+
+</body>
+</subsubsection>
+</body>
+</subsection>
+<subsection>
+<title>Maintainer-Needed</title>
+<body>
+
<p>
-Commits of package metadata files are handled by <c>repoman</c>. You
-should ensure that you have <c>dev-libs/libxml2</c> installed so that
-the XML can be validated.
+Maintainer-needed, or orphaned, packages have no maintainers
+responsible for them. Per
+<uri link="https://wiki.gentoo.org/wiki/GLEP:67#Case_of_maintainer-needed_packages">
+GLEP 67</uri>, these packages must not contain any <maintainer>
+subtags under <pkgmetadata> in their <c>metadata.xml</c>. By
+convention, a comment line containing the string <c>maintainer-needed</c>
+is inserted. Other tags which are relevant to the package may be
+present in the metadata. Bugs for these packages must be assigned to
+<c>maintainer-needed@gentoo.org</c>. The QA team periodically generates the
+<uri link="https://qa-reports.gentoo.org/output/maintainer-needed.html">
+orphaned packages list</uri> along with their corresponding bugs as
+part of the QA reports.
</p>
+<codesample lang="sgml">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <!-- maintainer-needed -->
+ <upstream>
+ <maintainer status="active">
+ <email>rasmus@alum.mit.edu</email>
+ <name>Matt Rasmussen</name>
+ </maintainer>
+ <doc lang="en">http://keepnote.org/manual/</doc>
+ <bugs-to>https://code.google.com/p/keepnote/issues/list</bugs-to>
+ </upstream>
+ <longdescription lang="en">
+ KeepNote is a note taking application. With KeepNote, you can
+ store your class notes, TODO lists, research notes, journal entries,
+ paper outlines, etc in a simple notebook hierarchy with rich-text
+ formatting, images, and more. Using full-text search, you can
+ retrieve any note for later reference.
+ </longdescription>
+</pkgmetadata>
+</codesample>
+
+</body>
+</subsection>
+</body>
</section>
<section>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-05-18 5:32 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-05-18 5:32 UTC (permalink / raw
To: gentoo-commits
commit: a61f033e215514521966959a47913e8c91a6fce8
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Wed Apr 27 06:57:25 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Wed May 18 04:39:49 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a61f033e
ebuild-writing/misc-files/metadata: update wrt slotting and per GLEP 68
Add information about specifying slots and subslots in the
metadata.
Also, update the section according to the specifications in GLEP 68,
clarify some of the tags better, and reorder the tags to improve the
flow of the text.
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-writing/misc-files/metadata/text.xml | 140 ++++++++++++++++++----------
1 file changed, 93 insertions(+), 47 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 31ec926..3d135a6 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -14,7 +14,15 @@ package or category.
<body>
<p>
-A <path>metadata.xml</path> file can contain a number of tags:
+A metadata file follows the syntax defined in
+<uri link="https://wiki.gentoo.org/wiki/GLEP:68">GLEP 68</uri>.
+The character set <b>must</b> be UTF-8 as specified by
+<uri link="https://wiki.gentoo.org/wiki/GLEP:31">GLEP 31</uri>.
+</p>
+
+<p>
+The following table summarizes the tags that may appear in a
+metadata.xml:
</p>
<table>
@@ -24,28 +32,41 @@ A <path>metadata.xml</path> file can contain a number of tags:
</tr>
<tr>
<ti>
+ <brite><catmetadata></brite>
+ </ti>
+ <ti>
+ This is the root element of the <path>metadata.xml</path> file for
+ categories. It has no attributes. It contains a number of
+ <brite><longdescription></brite> tags, each for a different
+ language.
+ </ti>
+</tr>
+<tr>
+ <ti>
<brite><pkgmetadata></brite>
</ti>
<ti>
This is the root element of the <path>metadata.xml</path> file for
packages. It has no attributes. The following subtags are
allowed:
- <brite><maintainer></brite>,
<brite><longdescription></brite>,
+ <brite><maintainer></brite>,
+ <brite><slots></brite>,
<brite><use></brite>, and
<brite><upstream></brite>.
+ While all the subtags are optional, <upstream> may
+ appear at most once.
</ti>
</tr>
<tr>
+ <ti><brite><longdescription></brite></ti>
<ti>
- <brite><catmetadata></brite>
- </ti>
- <ti>
- This is the root element of the <path>metadata.xml</path> file for
- categories as per <uri link="https://wiki.gentoo.org/wiki/GLEP:34">GLEP 34</uri>.
- It has no attributes. It contains a number of
- <brite><longdescription></brite> tags, each for a different
- language.
+ This tag contains a description for a category or a package. For
+ packages, it is used to augment the
+ <uri link="::ebuild-writing/variables#ebuild-defined-variables">
+ DESCRIPTION</uri> field in the ebuilds themselves. This tag has
+ two optional subtags: <brite><pkg></brite> and
+ <brite><cat></brite>.
</ti>
</tr>
<tr>
@@ -83,11 +104,25 @@ A <path>metadata.xml</path> file can contain a number of tags:
</ti>
</tr>
<tr>
- <ti><brite><longdescription></brite></ti>
+ <ti><brite><slots></brite></ti>
+ <ti>
+ This tag describes the
+ <uri link="::general-concepts/slotting">slots</uri> of a package.
+ It has two optional subtags: <slot> and <subslots>.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><slot></brite></ti>
+ <ti>
+ This contains information for a particular slot. The <c>name</c>
+ attribute is mandatory and specifies the name of the slot.
+ </ti>
+</tr>
+<tr>
+ <ti><brite><subslots></brite></ti>
<ti>
- This tag contains a description of the package. This is to augment the
- DESCRIPTION field in the ebuilds themselves. This tag has two optional
- subtags: <brite><pkg></brite> and <brite><cat></brite>.
+ Describes the meaning of subslots for the whole package. This
+ tag may appear at most once.
</ti>
</tr>
<tr>
@@ -113,25 +148,30 @@ A <path>metadata.xml</path> file can contain a number of tags:
<ti><brite><upstream></brite></ti>
<ti>
This tag contains information about the upstream developers/project.
+ It supports multiple optional subtags: <maintainer>,
+ <changelog>, <doc>, <bugs-to>,
+ and <remote-id>.
</ti>
</tr>
<tr>
<ti><brite><maintainer></brite></ti>
<ti>
- Name and e-mail of an upstream maintainer. May appear more than once.
+ Provides information about the upstream maintainer. It requires a
+ <name> subtag to be specified, supports an optional
+ <email> subtag and an optional <c>status</c> attribute.
</ti>
</tr>
<tr>
- <ti><brite><email></brite></ti>
+ <ti><brite><name></brite></ti>
<ti>
- The email address of an upstream may appear only once and must appear in first place.
+ The name of an upstream maintainer should contain a block of text with upstream's name.
+ This element is mandatory for an upstream maintainer and must appear exactly once.
</ti>
</tr>
<tr>
- <ti><brite><name></brite></ti>
+ <ti><brite><email></brite></ti>
<ti>
- The name of an upstream maintainer should contain a block of text with upstream's name.
- This element is mandatory for an upstream maintainer and must appear only once.
+ The email address of an upstream maintainer. May appear only once.
</ti>
</tr>
<tr>
@@ -141,7 +181,7 @@ A <path>metadata.xml</path> file can contain a number of tags:
The URL must be version independent and must point to a changelog which is only
updated on new releases of the corresponding package. (This also implies that
one can link to an automatically updated changelog in case of vcs snapshots
- only.)
+ only). May appear at most once.
</ti>
</tr>
<tr>
@@ -151,14 +191,14 @@ A <path>metadata.xml</path> file can contain a number of tags:
found. The link must not point to any third party documentation and must be
version independent. If the documentation is available in more than one language,
a lang attribute can be used which follows the same rules as the one for
- longdescription.
+ <longdescription>.
</ti>
</tr>
<tr>
<ti><brite><bugs-to></brite></ti>
<ti>
Should contain a place where bugs can be filed, a URL or an e-mail address prefixed
- with mailto:.
+ with <c>mailto:</c>. May appear at most once.
</ti>
</tr>
<tr>
@@ -167,12 +207,14 @@ A <path>metadata.xml</path> file can contain a number of tags:
Should specify a type of package identification tracker and the identification that
corresponds to the package in question. remote-id should make it easier to index
information such as its Freshmeat ID or its CPAN name.
+ It has a mandatory attribute <c>type</c> which identifies the type
+ of upstream source.
</ti>
</tr>
<tr>
<ti><brite><pkg></brite></ti>
<ti>
- This tag contains a valid package name in the format of a DEPEND.
+ This tag contains a valid qualified package name.
</ti>
</tr>
<tr>
@@ -198,6 +240,7 @@ There are also some attributes that can be used with these tags:
<ti>lang</ti>
<ti>
<brite><description></brite>, <brite><longdescription></brite>,
+ <brite><slots></brite>,
<brite><use></brite>, <brite><doc></brite>
</ti>
<ti>
@@ -216,25 +259,29 @@ There are also some attributes that can be used with these tags:
<brite><longdescription></brite>, <brite><flag></brite>
</ti>
<ti>
- The restrict attribute allows one to restrict the application of certain
- tags to certain versions of a package. When this attribute is used, a tag
- without this attribute must also exist. That tag without the restrict
- attribute will serve as the default. The format of the restrict attribute
- is that of the DEPEND flag, except that "<" and
- ">" need to be specified by "&lt;" and "&gt;".
+ The restrict attribute allows one to restrict the application of
+ certain tags to certain versions of a package. When this attribute
+ is used, other tags with or without the restrict attribute must be
+ present to cover all the versions of the package. A tag without
+ the restrict attribute serves as the default. The format of the
+ restrict attribute is that of a EAPI=0 package dependency
+ specification. Due to the limitations of XML, the "<" and
+ ">" need to be specified using "&lt;" and "&gt;".
</ti>
</tr>
<tr>
<ti>name</ti>
<ti>
- <brite><flag></brite>
+ <brite><flag></brite>, <brite><slot></brite>
</ti>
<ti>
- This attribute is required on the <brite><flag></brite> tag. It
- simply contains the USE flag.
- <br /><br />
- For example, in the <c>sys-apps/hal</c> package, <c><flag name='acpi'>
- Enables ACPI</flag></c>
+ When this attribute is required on the <flag> tag, it
+ simply contains the name of the USE flag. For the
+ <slot> tag, it specifies the
+ <uri link="::general-concepts/slotting#slot-names">
+ slot name</uri> to which it applies. A slot name of <c>"*"</c>
+ allows for a single <slot> tag to match all the slots of a
+ package, in which case no other slot tags may be present.
</ti>
</tr>
<tr>
@@ -243,9 +290,12 @@ There are also some attributes that can be used with these tags:
<brite><maintainer></brite>
</ti>
<ti>
- The upstream maintainer element has a status attribute, which is one of active or inactive.
- This attribute is not mandatory. The absence of it shall be interpreted as unknown.
- Please note: This attribute is only allowed in the <upstream> <maintainer> element!
+ The upstream maintainer element has a status attribute, which is
+ one of <c>"active"</c> or <c>"inactive"</c>. This attribute is not
+ mandatory. The absence of it shall be interpreted as
+ <c>"unknown"</c>. Please note that this attribute is only allowed
+ for the <maintainer> subtags of the <upstream>
+ element!
</ti>
</tr>
<tr>
@@ -446,9 +496,9 @@ project. Note the use of "&gt;" as opposed to ">" in
<p>
The example also uses the <c><pkg></c> tag in USE flag
-descriptions. Slot operators are not allowed inside <pkg>,
-therefore the notation <pkg>sys-boot/grub</pkg><c>:2</c>
-is adopted as opposed to
+descriptions. Slot dependency specifiers are not allowed inside
+<pkg>, therefore the notation
+<pkg>sys-boot/grub</pkg><c>:2</c> is adopted as opposed to
<pkg>sys-boot/grub<c>:2</c></pkg>.
</p>
@@ -553,11 +603,7 @@ part of the QA reports.
<body>
<p>
For categories, <c>metadata.xml</c> specifies a long description (in
-English and optionally in other languages). The format is specified
-formally in <uri link="https://wiki.gentoo.org/wiki/GLEP:34">
-GLEP 34</uri>, and the character set <b>must</b> be UTF-8 as specified
-by <uri link="https://wiki.gentoo.org/wiki/GLEP:31">GLEP
-31</uri>. A typical example:
+English and optionally in other languages). A typical example:
</p>
<codesample lang="sgml">
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-05-18 5:32 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-05-18 5:32 UTC (permalink / raw
To: gentoo-commits
commit: d6d3b3a1ef7e1d10bec37cf438722d9784033eeb
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed May 18 05:25:22 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Wed May 18 05:30:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d6d3b3a1
ebuild-writing/misc-files: re-indent the category metadata.xml example
Re-indent the category metadata.xml example so that it's more in line
with the package metadata examples.
Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index ffd2993..e6dd819 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -657,18 +657,18 @@ English and optionally in other languages). A typical example:
</p>
<codesample lang="sgml">
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
- <catmetadata>
- <longdescription lang="en">
- The app-vim category contains plugins and syntax file
- packages for the Vim text editor.
- </longdescription>
- <longdescription lang="de">
- Die Kategorie app-vim enthält Plugins und Syntax-Pakete
- für den Vim Texteditor.
- </longdescription>
- </catmetadata>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<catmetadata>
+ <longdescription lang="en">
+ The app-vim category contains plugins and syntax file
+ packages for the Vim text editor.
+ </longdescription>
+ <longdescription lang="de">
+ Die Kategorie app-vim enthält Plugins und Syntax-Pakete
+ für den Vim Texteditor.
+ </longdescription>
+</catmetadata>
</codesample>
<p>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-05-18 5:32 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-05-18 5:32 UTC (permalink / raw
To: gentoo-commits
commit: f00b95e90d87fc6ffd0fa0f2ba800c4c1799769e
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed May 18 05:20:39 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Wed May 18 05:20:39 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f00b95e9
ebuild-writing/misc-files: do not use https in DOCTYPE for metadata files
libxml2 has no SSL support and therefore cannot fetch the DTD served
over https. See the Gentoo commit:
https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=1bfb585cc60a9e
This partially reverts 5b16122e6786de482bf8a57ae7eebcc8a31d4b17
Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 486af11..ffd2993 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -658,7 +658,7 @@ English and optionally in other languages). A typical example:
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE catmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
+ <!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
<catmetadata>
<longdescription lang="en">
The app-vim category contains plugins and syntax file
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2016-12-11 6:19 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2016-12-11 6:19 UTC (permalink / raw
To: gentoo-commits
commit: 49fb72be41dc38a280c3da6a259dd229b85baf59
Author: Wim Muskee <wimmuskee <AT> gmail <DOT> com>
AuthorDate: Sat Dec 10 10:43:24 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sun Dec 11 05:59:48 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=49fb72be
ebuild-writing/metadata: indentation rules, #591548
ebuild-writing/misc-files/metadata/text.xml | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index e6dd819..ad429a5 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -21,6 +21,21 @@ The character set <b>must</b> be UTF-8 as specified by
</p>
<p>
+Concerning indentation there is no strict rule governing the style and
+width. However the following minimal set of rules need to be followed:
+<ul>
+ <li>
+ Indentation should be consistent, i.e. either spaces or tabs, but
+ not both.
+ </li>
+ <li>
+ Keep the existing style when touching metadata.xml files that
+ belong to other developers.
+ </li>
+</ul>
+</p>
+
+<p>
The following table summarizes the tags that may appear in a
metadata.xml:
</p>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2017-04-13 19:35 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2017-04-13 19:35 UTC (permalink / raw
To: gentoo-commits
commit: 36023f0c54f9974c6ce8f22d34276d725c536767
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Thu Apr 13 15:52:30 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Thu Apr 13 19:34:55 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=36023f0c
ebuild-writing/misc-files/metadata: repoman does not depend on libxml2 anymore
When repoman was a part of sys-apps/portage, it didn't pull in libxml2
in the ebuild. The developers needed to make sure that libxml2 is
installed on the system to perform metadata checks. Now that it's
split into app-portage/repoman, it pulls in dev-python/lxml properly
and this statement is no longer valid.
ebuild-writing/misc-files/metadata/text.xml | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index ad429a5..44a8554 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -360,9 +360,8 @@ using the <c>app-portage/metagen</c> tool.
</p>
<p>
-Commits of package metadata files are handled by <c>repoman</c>. In
-order for metadata checks to be performed, <c>dev-libs/libxml2</c>
-must be installed on the system.
+Commits of package metadata files are handled by <c>repoman</c> as
+part of regular package maintenance.
</p>
<p>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2020-01-14 20:36 Göktürk Yüksek
0 siblings, 0 replies; 25+ messages in thread
From: Göktürk Yüksek @ 2020-01-14 20:36 UTC (permalink / raw
To: gentoo-commits
commit: 7dfbf123c416148170b43bae3bf7634edf08b8f1
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Thu Jan 9 00:57:04 2020 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Jan 14 20:35:58 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7dfbf123
ebuild-writing/.../metadata: clarify that upstream maintainer takes no 'type'
Closes: https://bugs.gentoo.org/703626
Closes: https://github.com/gentoo/devmanual/pull/140
Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 4d2d7cf..54b7bd2 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -174,6 +174,8 @@ metadata.xml:
Provides information about the upstream maintainer. It requires a
<name> subtag to be specified, supports an optional
<email> subtag and an optional <c>status</c> attribute.
+ Note that the <c>type</c> attribute <e>must not</e> be specified
+ for upstream maintainers.
</ti>
</tr>
<tr>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2020-01-23 7:47 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2020-01-23 7:47 UTC (permalink / raw
To: gentoo-commits
commit: 9426f87e1b36af1247d9a97dbbe6311b75f6326b
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Mon Jan 20 16:42:58 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Jan 23 00:01:02 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9426f87e
ebuild-writing/misc-files/metadata: Explain EAPI 0 atom.
Since EAPIs 0 to 2 are no longer mentioned, we need to explain what
an "EAPI=0 package dependency specification" is.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index d7f883a..7756665 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -280,9 +280,10 @@ There are also some attributes that can be used with these tags:
is used, other tags with or without the restrict attribute must be
present to cover all the versions of the package. A tag without
the restrict attribute serves as the default. The format of the
- restrict attribute is that of a EAPI=0 package dependency
- specification. Due to the limitations of XML, the "<" and
- ">" need to be specified using "&lt;" and "&gt;".
+ restrict attribute is that of a EAPI=0 package dependency specification
+ (i.e., USE-conditional or slot dependendencies are not allowed).
+ Since <c><</c> and <c>></c> are special characters in XML,
+ they must be escaped using <c>&lt;</c> and <c>&gt;</c>.
</ti>
</tr>
<tr>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2020-04-20 8:02 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2020-04-20 8:02 UTC (permalink / raw
To: gentoo-commits
commit: e2eb4339f8182dbc17959cf77f59e00afac5f949
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Apr 16 16:40:09 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Apr 16 16:40:09 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e2eb4339
ebuild-writing/misc-files/metadata: Reorder tags.
<maintainer> before <longdescription> seems to be the most common
ordering, in the examples below and in the tree.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index c4aa7bc..db082df 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -65,8 +65,8 @@ metadata.xml:
This is the root element of the <c>metadata.xml</c> file for
packages. It has no attributes. The following subtags are
allowed:
- <c><longdescription></c>,
<c><maintainer></c>,
+ <c><longdescription></c>,
<c><slots></c>,
<c><use></c>, and
<c><upstream></c>.
@@ -74,16 +74,6 @@ metadata.xml:
appear at most once.
</ti>
</tr>
-<tr>
- <ti><c><longdescription></c></ti>
- <ti>
- This tag contains a description for a category or a package. For
- packages, it is used to augment the
- <uri link="::ebuild-writing/variables/#Ebuild-defined Variables">
- DESCRIPTION</uri> field in the ebuilds themselves. This tag has
- two optional subtags: <c><pkg></c> and <c><cat></c>.
- </ti>
-</tr>
<tr>
<ti>
<c><maintainer></c>
@@ -118,6 +108,16 @@ metadata.xml:
It is optional.
</ti>
</tr>
+<tr>
+ <ti><c><longdescription></c></ti>
+ <ti>
+ This tag contains a description for a category or a package.
+ For packages, it is used to augment the
+ <uri link="::ebuild-writing/variables/#Ebuild-defined Variables">
+ DESCRIPTION</uri> field in the ebuilds themselves. This tag has
+ two optional subtags: <c><pkg></c> and <c><cat></c>.
+ </ti>
+</tr>
<tr>
<ti><c><slots></c></ti>
<ti>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2020-04-20 8:02 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2020-04-20 8:02 UTC (permalink / raw
To: gentoo-commits
commit: 026f710748d54e300f25d39dccbf20d15f84e98d
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Apr 16 12:54:52 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Apr 16 16:51:01 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=026f7107
ebuild-writing/misc-files/metadata: Describe stabilize-allarches.
Information taken from metadata.dtd and GLEP 68.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index db082df..abc5a3e 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -67,6 +67,7 @@ metadata.xml:
allowed:
<c><maintainer></c>,
<c><longdescription></c>,
+ <c><stabilize-allarches></c>,
<c><slots></c>,
<c><use></c>, and
<c><upstream></c>.
@@ -118,6 +119,14 @@ metadata.xml:
two optional subtags: <c><pkg></c> and <c><cat></c>.
</ti>
</tr>
+<tr>
+ <ti><c><stabilize-allarches></c></ti>
+ <ti>
+ Indicates an architecture-independent package. An ebuild can be marked
+ stable for all relevant architectures, when it has been tested on only one
+ architecture. This tag must have empty content.
+ </ti>
+</tr>
<tr>
<ti><c><slots></c></ti>
<ti>
@@ -271,8 +280,8 @@ There are also some attributes that can be used with these tags:
<tr>
<ti>restrict</ti>
<ti>
- <c><maintainer></c>,
- <c><longdescription></c>, <c><flag></c>
+ <c><maintainer></c>, <c><longdescription></c>,
+ <c><stabilize-allarches></c>, <c><flag></c>
</ti>
<ti>
The restrict attribute allows one to restrict the application of
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2020-04-20 8:02 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2020-04-20 8:02 UTC (permalink / raw
To: gentoo-commits
commit: 99492cb137c6ec5bb324103413a7848f371790e2
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Apr 16 12:56:42 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Apr 16 16:51:01 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=99492cb1
ebuild-writing/misc-files/metadata: Add example code for m-n detection.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index abc5a3e..6cf7609 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -636,8 +636,16 @@ Maintainer-needed, or orphaned, packages have no maintainers
responsible for them. Per
<uri link="https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages">
GLEP 67</uri>, these packages must not contain any <maintainer>
-subtags under <pkgmetadata> in their <c>metadata.xml</c>. By
-convention, a comment line containing the string <c>maintainer-needed</c>
+subtags under <pkgmetadata> in their <c>metadata.xml</c>. A strict test
+for this condition would be:
+</p>
+
+<pre>
+[[ $(xmllint --xpath "count(/pkgmetadata/maintainer)" metadata.xml) -eq 0 ]]
+</pre>
+
+<p>
+By convention, a comment line containing the string <c>maintainer-needed</c>
is inserted. Other tags which are relevant to the package may be
present in the metadata. Bugs for these packages must be assigned to
<c>maintainer-needed@gentoo.org</c>. The QA team periodically generates the
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2021-09-11 21:59 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2021-09-11 21:59 UTC (permalink / raw
To: gentoo-commits
commit: ee6c5a78e4eb2a2051f0ce6ef9856dd10c3f4b14
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Sep 11 10:44:55 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Sep 11 14:09:23 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ee6c5a78
ebuild-writing/misc-files/metadata: Replace http by https
Bug: https://bugs.gentoo.org/552720
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 0fdf675..eb6551c 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -411,7 +411,7 @@ description.
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
<maintainer type="project">
<email>office@gentoo.org</email>
@@ -477,7 +477,7 @@ as opposed to a URL. Conversely, email addresses specified in the
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
<upstream>
<bugs-to>mailto:dev-portage@gentoo.org</bugs-to>
@@ -536,7 +536,7 @@ is demonstrated.
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
<maintainer restrict="&gt;=sys-boot/grub-2" type="person">
<email>floppym@gentoo.org</email>
@@ -595,7 +595,7 @@ specified in the <c><subslots></c> tag.
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
<maintainer type="project">
<email>base-system@gentoo.org</email>
@@ -656,7 +656,7 @@ part of the QA reports.
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
<!-- maintainer-needed -->
<upstream>
@@ -691,7 +691,7 @@ English and optionally in other languages). A typical example:
<codesample lang="sgml">
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<!DOCTYPE catmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<catmetadata>
<longdescription lang="en">
The app-vim category contains plugins and syntax file
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2022-01-12 6:34 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2022-01-12 6:34 UTC (permalink / raw
To: gentoo-commits
commit: 427ba55ed4af436ebf2a4dc420c5db77f7f3430c
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 12 04:52:02 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 12 06:28:55 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=427ba55e
ebuild-writing/misc-files/metadata: use conventional metadata.xml tag ordering
Matches other examples on the page too.
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index eb6551c..416167c 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -479,11 +479,6 @@ as opposed to a URL. Conversely, email addresses specified in the
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <upstream>
- <bugs-to>mailto:dev-portage@gentoo.org</bugs-to>
- <changelog>https://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES</changelog>
- <doc>https://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage</doc>
- </upstream>
<maintainer type="person">
<email>larry@gentoo.org</email>
<name>Larry the Cow</name>
@@ -502,6 +497,11 @@ as opposed to a URL. Conversely, email addresses specified in the
installing files. Usually only required for hardened systems.
</flag>
</use>
+ <upstream>
+ <bugs-to>mailto:dev-portage@gentoo.org</bugs-to>
+ <changelog>https://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES</changelog>
+ <doc>https://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage</doc>
+ </upstream>
</pkgmetadata>
</codesample>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2022-01-12 6:34 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2022-01-12 6:34 UTC (permalink / raw
To: gentoo-commits
commit: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 12 05:00:05 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 12 06:28:56 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=434e6c60
ebuild-writing/misc-files/metadata: fix formatting, use <c> tags consistently
Signed-off-by: Sam James <sam <AT> gentoo.org>
[Whitespace changes]
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 41 +++++++++++++++--------------
1 file changed, 21 insertions(+), 20 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index 416167c..a961821 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -132,7 +132,8 @@ metadata.xml:
<ti>
This tag describes the
<uri link="::general-concepts/slotting">slots</uri> of a package.
- It has two optional subtags: <slot> and <subslots>.
+ It has two optional subtags:
+ <c><slot></c> and <c><subslots></c>.
</ti>
</tr>
<tr>
@@ -172,17 +173,17 @@ metadata.xml:
<ti><c><upstream></c></ti>
<ti>
This tag contains information about the upstream developers/project.
- It supports multiple optional subtags: <maintainer>,
- <changelog>, <doc>, <bugs-to>,
- and <remote-id>.
+ It supports multiple optional subtags: <c><maintainer></c>,
+ <c><changelog></c>, <c><doc></c>,
+ <c><bugs-to>,</c>, and <c><remote-id></c>.
</ti>
</tr>
<tr>
<ti><c><maintainer></c></ti>
<ti>
Provides information about the upstream maintainer. It requires a
- <name> subtag to be specified, supports an optional
- <email> subtag and an optional <c>status</c> attribute.
+ <c><name></c> subtag to be specified, supports an optional
+ <c><email></c> subtag and an optional <c>status</c> attribute.
Note that the <c>type</c> attribute <e>must not</e> be specified
for upstream maintainers.
</ti>
@@ -217,7 +218,7 @@ metadata.xml:
found. The link must not point to any third party documentation and must be
version independent. If the documentation is available in more than one language,
a lang attribute can be used which follows the same rules as the one for
- <longdescription>.
+ <c><longdescription></c>.
</ti>
</tr>
<tr>
@@ -301,12 +302,12 @@ There are also some attributes that can be used with these tags:
<c><flag></c>, <c><slot></c>
</ti>
<ti>
- When this attribute is required on the <flag> tag, it
+ When this attribute is required on the <c><flag></c> tag, it
simply contains the name of the USE flag. For the
- <slot> tag, it specifies the
+ <c><slot></c> tag, it specifies the
<uri link="::general-concepts/slotting/#Slot Names">
slot name</uri> to which it applies. A slot name of <c>*</c>
- allows for a single <slot> tag to match all the slots of a
+ allows for a single <c><slot></c> tag to match all the slots of a
package, in which case no other slot tags may be present.
</ti>
</tr>
@@ -320,7 +321,7 @@ There are also some attributes that can be used with these tags:
one of <c>"active"</c> or <c>"inactive"</c>. This attribute is not
mandatory. The absence of it shall be interpreted as
<c>"unknown"</c>. Please note that this attribute is only allowed
- for the <maintainer> subtags of the <upstream>
+ for the <c><maintainer></c> subtags of the <c><upstream></c>
element!
</ti>
</tr>
@@ -405,7 +406,7 @@ presented. It is a simplified version of <c>metadata.xml</c> for
the package <c>app-office/libreoffice</c>. The package
maintainer is identified by the email address <c>office@gentoo.org</c>
with the name <c>Gentoo Office Project</c> as specified in the
-optional <name> subtag. It also provides a long package
+optional <c><name></c> subtag. It also provides a long package
description.
</p>
@@ -470,9 +471,9 @@ The second example is formed after the <c>metadata.xml</c> of
is a developer and the other is a project. It illustrates how local
USE flag descriptions are specified and also contains an upstream
element. It is also worth pointing out the use of <c>mailto:</c>
-prefix in <bugs-to> tag due to the presence of an email address
+prefix in <c><bugs-to></c> tag due to the presence of an email address
as opposed to a URL. Conversely, email addresses specified in the
-<email> tags require no such prefix.
+<c><email></c> tags require no such prefix.
</p>
<codesample lang="sgml">
@@ -524,9 +525,9 @@ project. Note the use of "&gt;" as opposed to ">" in
<p>
The example also uses the <c><pkg></c> tag in USE flag
descriptions. Slot dependency specifiers are not allowed inside
-<pkg>, therefore the notation
-<pkg>sys-boot/grub</pkg><c>:2</c> is adopted as opposed to
-<pkg>sys-boot/grub<c>:2</c></pkg>.
+<c><pkg></c>, therefore the notation
+<c><pkg>sys-boot/grub</pkg>:2</c> is adopted as opposed to
+<c><pkg>sys-boot/grub:2</pkg></c>.
</p>
<p>
@@ -635,9 +636,9 @@ specified in the <c><subslots></c> tag.
Maintainer-needed, or orphaned, packages have no maintainers
responsible for them. Per
<uri link="https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages">
-GLEP 67</uri>, these packages must not contain any <maintainer>
-subtags under <pkgmetadata> in their <c>metadata.xml</c>. A strict test
-for this condition would be:
+GLEP 67</uri>, these packages must not contain any <c><maintainer></c>
+subtags under <c><pkgmetadata></c> in their <c>metadata.xml</c>. A strict
+test for this condition would be:
</p>
<pre>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2022-01-12 6:34 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2022-01-12 6:34 UTC (permalink / raw
To: gentoo-commits
commit: a93ddfdf28dd37d25e4967c8c97b5bc93be70d15
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 12 05:01:04 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 12 06:28:56 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a93ddfdf
ebuild-writing/misc-files/metadata: minor phrasing tweak
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index a961821..2bc6100 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -633,8 +633,8 @@ specified in the <c><subslots></c> tag.
<body>
<p>
-Maintainer-needed, or orphaned, packages have no maintainers
-responsible for them. Per
+Maintainer-needed ("orphaned") packages have no maintainers responsible for
+them. Per
<uri link="https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages">
GLEP 67</uri>, these packages must not contain any <c><maintainer></c>
subtags under <c><pkgmetadata></c> in their <c>metadata.xml</c>. A strict
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2022-05-27 9:04 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2022-05-27 9:04 UTC (permalink / raw
To: gentoo-commits
commit: 389882dac0cb2e2a174cf70fdad778b71a4538d3
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun May 22 06:24:57 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri May 27 09:02:31 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=389882da
ebuild-writing/misc-files/metadata: Language tags can be BCP 47
This corresponds to the update of GLEP 68.
Bug: https://bugs.gentoo.org/578294
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index e24be93..bcc43f4 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -273,9 +273,9 @@ There are also some attributes that can be used with these tags:
In every case where a description is required, there must be at
<e>least</e> an english description. If an additional description in
another language is given, this attribute is used to specify the language
- used. The format is the two-character language code as defined by the <uri
- link="https://www.w3.org/WAI/ER/IG/ert/iso639.htm#2letter">ISO-639-1</uri>
- norm.
+ used. The format is an IETF language tag as defined by the
+ <uri link="https://tools.ietf.org/rfc/bcp/bcp47.txt">BCP 47</uri>
+ specification. Most often, this will be a two-character language code.
</ti>
</tr>
<tr>
^ permalink raw reply related [flat|nested] 25+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
@ 2022-06-01 20:39 Ulrich Müller
0 siblings, 0 replies; 25+ messages in thread
From: Ulrich Müller @ 2022-06-01 20:39 UTC (permalink / raw
To: gentoo-commits
commit: f599228d19e81efb54e606c52a1562b857d71929
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri May 27 10:15:49 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri May 27 10:15:49 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f599228d
ebuild-writing/misc-files/metadata: Update restrict attribute
The description currently says:
"When this attribute is used, other tags with or without the restrict
attribute must be present to cover all the versions of the package.
A tag without the restrict attribute serves as the default."
However, this is not reflected by the specification in GLEP 68.
It appears to have originated from the old DevRel Handbook where it
had been added in 2004:
https://gitweb.gentoo.org/archive/proj/gentoo.git/tree/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?id=26d18f5f20f00e538b7af0d5a795008f3426d243#n135
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index bcc43f4..9c6bd76 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -285,15 +285,12 @@ There are also some attributes that can be used with these tags:
<c><stabilize-allarches></c>, <c><flag></c>
</ti>
<ti>
- The restrict attribute allows one to restrict the application of
- certain tags to certain versions of a package. When this attribute
- is used, other tags with or without the restrict attribute must be
- present to cover all the versions of the package. A tag without
- the restrict attribute serves as the default. The format of the
- restrict attribute is that of a EAPI=0 package dependency specification
- (i.e., USE-conditional or slot dependendencies are not allowed).
- Since <c><</c> and <c>></c> are special characters in XML,
- they must be escaped using <c>&lt;</c> and <c>&gt;</c>.
+ The restrict attribute allows one to restrict the application of certain
+ tags to certain versions of a package. The format of the restrict attribute
+ is that of a EAPI 0 package dependency specification (i.e. USE-conditional
+ or slot dependendencies are not allowed). Since <c><</c> and <c>></c>
+ are special characters in XML, they must be escaped using <c>&lt;</c>
+ and <c>&gt;</c>.
</ti>
</tr>
<tr>
^ permalink raw reply related [flat|nested] 25+ messages in thread
end of thread, other threads:[~2022-06-01 20:39 UTC | newest]
Thread overview: 25+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-05-18 5:32 [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/ Göktürk Yüksek
-- strict thread matches above, loose matches on Subject: below --
2022-06-01 20:39 Ulrich Müller
2022-05-27 9:04 Ulrich Müller
2022-01-12 6:34 Ulrich Müller
2022-01-12 6:34 Ulrich Müller
2022-01-12 6:34 Ulrich Müller
2021-09-11 21:59 Ulrich Müller
2020-04-20 8:02 Ulrich Müller
2020-04-20 8:02 Ulrich Müller
2020-04-20 8:02 Ulrich Müller
2020-01-23 7:47 Ulrich Müller
2020-01-14 20:36 Göktürk Yüksek
2017-04-13 19:35 Göktürk Yüksek
2016-12-11 6:19 Göktürk Yüksek
2016-05-18 5:32 Göktürk Yüksek
2016-05-18 5:32 Göktürk Yüksek
2016-05-18 5:32 Göktürk Yüksek
2016-05-18 5:32 Göktürk Yüksek
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2014-01-19 15:14 Markos Chandras
2014-01-03 18:32 Markos Chandras
2013-05-12 15:06 Markos Chandras
2012-11-11 19:33 Markos Chandras
2012-11-02 17:49 Markos Chandras
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox