[gentoo-dev] [PATCH v2] GLEP 42 update

[Ulrich Mueller]

>>>>> On Mon, 27 Nov 2017, Ulrich Müller wrote:

> Currently it is required that every news item is accompanied by a
> detached OpenPGP signature. To my knowledge, verification of these
> signatures was never implemented. With Git commit signing and after
> full-tree verification is implemented, these detached signatures
> will become fully redundant. In addition, we noticed that several of
> the signatures have a bad format (e.g., are not detached signatures
> at all). Therefore the first patch drops the requirement for
> detached OpenPGP signatures.

> The second patch updates the GLEP from ISO 639 to IETF language
> codes (BCP 47), in order to make it consistent with usage in the
> L10N USE_EXPAND variable. This will make no difference for most
> common languages. Please note that a BCP 47 language tag can in
> principle be longer than two letters, and can contain characters
> [A-Za-z0-9-]. (Since there are currently no translations of news
> items, all this is rather academic, though.)

> Finally (also in the second patch) a note is added clarifying
> what "very short" means in a filename context. Technically, the
> short-name is needed only to distinguish between multiple news
> items posted at the same day. However, there seems to be a tendency
> to repeat half of the news item's content in its filename. ;-)

Updated version below (as a single patch), including corrections from
mailing list and IRC. If there are no further comments, I plan to
submit this for approval in the next Council meeting.

Full commit log: https://gitweb.gentoo.org/data/glep.git/log/?h=glep42-update
Rendered version: https://dev.gentoo.org/~ulm/scratch/glep-0042.html

Ulrich


diff --git a/glep-0042.rst b/glep-0042.rst
index c6b41e9..416bd18 100644
--- a/glep-0042.rst
+++ b/glep-0042.rst
@@ -7,12 +7,12 @@ Author: Ciaran McCreesh <ciaranm@g.o>,
         Ulrich Müller <ulm@g.o>
 Type: Standards Track
 Status: Final
-Version: 3
+Version: 4
 Created: 2005-10-31
-Last-Modified: 2016-03-18
+Last-Modified: 2017-11-29
 Post-History: 2005-11-01, 2005-11-05, 2005-11-07, 2005-12-11, 2005-12-13,
               2005-12-18, 2006-01-05, 2006-03-02, 2006-03-06, 2006-06-12,
-              2006-09-05, 2016-03-10
+              2006-09-05, 2016-03-10, 2017-11-27
 Content-Type: text/x-rst
 ---
 
@@ -179,7 +179,9 @@ form ``yyyy-mm-dd-short-name``, where ``yyyy`` is the year (e.g. ``2005``),
 ``mm`` is the month (``01`` through ``12``) and dd is the day of the month
 (``01`` through ``31``). The ``short-name`` is a very short name describing the
 news item (e.g. ``yoursql-updates``), consisting only of the characters ``a-z``,
-``0-9``, ``+`` (plus), ``-`` (hyphen) and ``_`` (underscore).
+``0-9``, ``+`` (plus), ``-`` (hyphen) and ``_`` (underscore). While there is no
+hard restriction on the length of ``short-name``, limiting it to 20 characters
+is strongly recommended.
 
 News Item Directories
 ---------------------
@@ -190,9 +192,9 @@ news item's identifier.
 The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which
 contains the text of the news item, in English, in the format described below.
 
-If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt``
-(where ``xx`` is the ISO 639 [#iso-639]_ two letter language code, and the date
-remains the same as the original news item) will also be provided. However, only
+Any translations of a news item will be provided in additional files. Their
+name ``yyyy-mm-dd-short-name.lang.txt`` is obtained from the original filename
+by replacing ``en`` with another IETF language tag [#bcp-47]_. However, only
 the English version of a news item is authoritative.  This anglocentricity is
 justified by precedent [#glep-34]_.
 
@@ -203,19 +205,16 @@ A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for
 compatibility with and for the same reasons as existing Gentoo documentation
 [#docs-policy]_ and the tree [#glep-31]_.
 
-News items must be signed with a detached GPG signature.::
-
-    gpg --armour --detach-sign ????-??-??-*.??.txt
-
-This GLEP does not specify the type or strength of signature to be used, nor
-does it discuss how, if at all, a centralised keychain will be provided. These
-issues should be handled as part of the signing policy discussions.
-
 A news item file's content will consist of an RFC 822 style header [#rfc-822]_
 followed by the main body of the message as plain text. This GLEP defines
 various optional and mandatory headers. Future GLEPs may propose new headers —
 tools handling these news items must ignore any unrecognised header.
 
+.. Note:: A previous version of this GLEP had required that news items must
+   be signed with a detached OpenPGP signature. This was deemed no longer
+   necessary after moving news items to a Git repository with commit signing,
+   and deployment of full-tree verification per GLEP 74 [#glep-74]_.
+
 News Item Headers
 '''''''''''''''''
 
@@ -478,6 +477,8 @@ Example Files
 References
 ==========
 
+.. [#bcp-47] BCP 47: "Tags for identifying languages",
+     https://tools.ietf.org/rfc/bcp/bcp47.txt
 .. [#bug-11359] Bugzilla Bug 11359
    "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging",
    https://bugs.gentoo.org/show_bug.cgi?id=11359
@@ -500,7 +501,9 @@ References
      https://www.gentoo.org/glep/glep-0034.html
 .. [#glep-45] GLEP 45: "GLEP date format", Henrik Brix Andersen,
      https://www.gentoo.org/glep/glep-0045.html
-.. [#iso-639] ISO 639 "Code for the representation of names of languages"
+.. [#glep-74] GLEP 74: "Full-tree verification using Manifest files",
+     Michał Górny, Robin Hugh Johnson, Ulrich Müller,
+     https://www.gentoo.org/glep/glep-0074.html
 .. [#ramereth-repo] "Re: [gentoo-dev] GLEP ??: Critical News Reporting", Lance
      Albertson,
      https://archives.gentoo.org/gentoo-dev/message/4204839d4091758c3bad1dbd18ed16f7