Re: [gentoo-dev] [PATCH v1 3/3] ebuild-writing/misc-files/metadata: rewrite the section per GLEP 67 #572144

[Göktürk Yüksek]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA512

Göktürk Yüksek:
> +flag name="multislot" +  Allow concurrent
> installation of pkgsys-boot/grub:0/pkg and +
> pkgsys-boot/grub:2/pkg by renaming all programs. +
> /flag

Please do not merge. I just realized that the slot operators should be
outside the tag as in "sys-boot/grub:2". Will fix and resubmi
t.

- --
gokturk

-BEGIN PGP SIGNATURE-

iQEcBAEBCgAGBQJXF/SvAAoJEIT4AuXAiM4z7EUH/R+QfIIOZljx4Pf7/093zhAF
jOjV689/UYDW8ZPvOCJA2JPg+UJMhqr2mBaflIcztO/SxGNPeeIlGXip3D7gCb5h
jcv4uyprJ7kWtbNcEOmvL3TwqjDiuHAwZtpVHUFnrryIGT8uv3kE6d5aUK1SHUQG
X0/fl/40QmlNHwFhpPsHa5aQbe1eLNCozI3DjzejbC3fBa3uc+15xow+G2Ox2tfz
EGlsYs3/nUVyW10mlJUBnx23agvZMQStnzwnmzYzgHjOvVSr7gXlWJkMqL7o3i1U
1PRrUooZCZTn0oejC4GC07wTiv+41mDnHtYMrBLJooArfGNWrRCICMpKARlSggM=
=Vcqu
-END PGP SIGNATURE-

[gentoo-dev] [PATCH v1 3/3] ebuild-writing/misc-files/metadata: rewrite the section per GLEP 67 #572144

[Göktürk Yüksek]

A major rewrite of the section. Here is a brief summary of changes:
- Remove the information about the  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 #549490 obsolete.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=572144
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=549490
Signed-off-by: Göktürk Yüksek 
---
 ebuild-writing/misc-files/metadata/text.xml | 408 
 1 file changed, 227 insertions(+), 181 deletions(-)

diff --git a/ebuild-writing/misc-files/metadata/text.xml 
b/ebuild-writing/misc-files/metadata/text.xml
index 2324f53..9d0dc19 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -10,20 +10,13 @@ package or category.
 
 
 
-Package Metadata
-
-
-For packages, metadata.xml 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:
-
-
-
+Syntax
 
 
 
-A metadata.xml file can contain a number of tags:
+A metadata file follows the syntax defined in
+https://www.gentoo.org/dtd/metadata.dtd;>
+metadata.dtd and can contain a number of tags:
 
 
 
@@ -39,13 +32,10 @@ A metadata.xml file can contain a number of 
tags:
 This is the root element of the metadata.xml file for
 packages. It has no attributes. The following subtags are
 allowed:
-herd,
 maintainer,
 longdescription,
 use, and
 upstream.
-There should be at least one herd or
-maintainer subtag.
   
 
 
@@ -62,26 +52,21 @@ A metadata.xml file can contain a number of 
tags:
 
 
   
-herd
-  
-  
-If a package is maintained by one or more herds, names of these herds
-can be specified with the herd tag. The names
-used in this tag must be the same as specified in the https://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plainrev=HEAD;>herds.xml
-file.
-  
-
-
-  
 maintainer
   
   
-Besides being part of a herd, a package can also be maintained directly. 
-The maintainers of a package can be specified with the 
-maintainer tag. This tag has one required subtag: 
+This tag specifies the persons and/or projects responsible for
+the maintenance of a package. A package may contain zero or more
+maintainer tags. The type attribute must
+be specified and can be either "person" or
+"project". There is one required subtag:
 email. It has two optional subtags:
-name, and description.
+name and
+description. Unless specified otherwise, the
+maintainer who is listed in the metadata first shall be the
+assignee for the bugs for that package as per
+https://wiki.gentoo.org/wiki/GLEP:67#Bug_assignment;>
+GLEP 67.
   
 
 
@@ -108,7 +93,9 @@ A metadata.xml file can contain a number of 
tags:
   longdescription
   
 This tag contains a description of the package. This is to augment the 
-DESCRIPTION field in the ebuilds themselves. This tag has two optional
+DESCRIPTION field in the ebuilds themselves. If a long description
+in any language is provided, an English long description must be
+present. This tag has two optional
 subtags: pkg and cat.
   
 
@@ -207,8 +194,7 @@ A metadata.xml file can contain a number of 
tags:
 
 
 
-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:
 
 
 
@@ -235,7 +221,7 @@ optional:
 
   restrict
   
-herd, maintainer, 
+maintainer,
 longdescription, flag
   
   
@@ -244,12 +230,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;.
-
-For example, in the sys-libs/db package, 
-restrict="gt;=sys-libs/db-3.2.9-r5"  on the
-maintainer tag shows that I'm currently maintaining all
-versions greater then 3.2.9-r5.
+"" need to be specified by "lt;" and "gt;".
   
 
 
@@ -286,208 +267,273 @@ optional:
 Developers should email the gentoo-dev mailing list before using a new 
type value. 
   
 
+
+  type
+  
+maintainer
+  
+  
+Defines the type of the maintainer for a package. There are