[gentoo-dev] [RFC] GLEP 67 minor wording cleanup update

[gentoo-dev] [RFC] GLEP 67 minor wording cleanup update

[Michał Górny]

[-- Attachment #1.1: Type: text/plain, Size: 601 bytes --]

Hello, everyone.

It seems that I had this in queue for some time already. I'd like to
update GLEP 67 [1] to the updated version on my wiki copy [2].

The changes are:

a. explicit dependency on GLEP 39 [3] was added (it defines projects
in general),

b. XML descriptions were clarified using 'exactly one' and 'at most
one' qualifiers.

I'm attaching a diff. Please review.

[1]:https://wiki.gentoo.org/wiki/GLEP:67
[2]:https://wiki.gentoo.org/wiki/User:MGorny/GLEP:67
[3]:https://wiki.gentoo.org/wiki/GLEP:39

-- 
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: glep67.diff --]
[-- Type: text/x-patch, Size: 2652 bytes --]

--- 1	2016-05-29 13:26:34.486191149 +0200
+++ 2	2016-05-29 13:26:41.254747492 +0200
@@ -4,6 +4,7 @@
 |Type=Standards Track
 |Status=Final
 |Author=Michał Górny <mgorny@gentoo.org>
+|Requires=GLEP:39,
 }}
 ==Abstract==
 Within this GLEP, the issues with the current package maintainer description system are explained, and a new system that aims to solve those issues is proposed. The current complex structure is replaced with two well-defined maintainer types — people and projects. Herds are removed in favor of projects, and project member listings are provided in XML format. Maintainer listings in ''metadata.xml'' become uniform, and can be used directly to assign bugs.
@@ -77,10 +78,10 @@
 
 The project structure is exported from wiki.gentoo.org into a ''projects.xml'' file. The file consists of root ''<projects/>'' element which contains one or more ''<project/>'' element. Each ''<project/>'' element contains the following sub-elements:
 
-* ''<email/>'' element stating the project contact e-mail (must be registered on bugs.gentoo.org),
-* ''<name/>'' element stating the human-readable project name,
-* ''<url/>'' element stating the project homepage URL,
-* ''<description/>'' element shortly describing the project,
+* exactly one ''<email/>'' element stating the project contact e-mail (must be registered on bugs.gentoo.org, and unique throughout the projects),
+* exactly one ''<name/>'' element stating the human-readable project name (must be unique throughout the projects),
+* exactly one ''<url/>'' element stating the project homepage URL (must be unique throughout the projects),
+* at most one ''<description/>'' element shortly describing the project,
 * zero or more ''<subproject/>'' elements listing subprojects of the particular project,
 * zero or more ''<member/>'' elements listing direct project members.
 
@@ -89,9 +90,9 @@
 * optional ''inherit-members=""'' attribute whose non-empty value indicates that subproject members are to be considered members of the parent project as well.
 
 Each ''<member/>'' has the following sub-elements:
-* ''<email/>'' stating the member's e-mail address,
-* optional ''<name/>'' stating the member's human-readable name,
-* optional ''<role/>'' stating the member's role in team.
+* exactly one ''<email/>'' stating the member's e-mail address,
+* at most one ''<name/>'' stating the member's human-readable name,
+* at most one ''<role/>'' stating the member's role in team.
 
 In addition, ''<member/>'' can have optional ''is-lead=""'' attribute whose non-empty value indicates that the particular member is the project's lead.
 

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 949 bytes --]