From a7db242673f202eb96b9c6924f30cbf6bb9a01aa Mon Sep 17 00:00:00 2001 From: Michał Górny Date: Fri, 15 Sep 2017 08:47:03 +0200 Subject: glep-0001: Attempt a more logical ordering of GLEP headers Attempt to reorder headers so that they are more logically ordered, to improve the chance that people will actually remember the order. The order is as follows: 1. basic title page data (number, title, author), 2. type and status (which looks somewhat subordinate to type), 3. version (next to the dates) -- more frequently updated, 4. all three dates, in time order -- Created, Last-Modified, Posted, 5. Content-Type -- last non-optional header that never changes, 6. optional GLEP-ref headers -- Requires, Replaces and Replaced-To. --- glep-0001.txt | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/glep-0001.txt b/glep-0001.txt index 5521760..4938695 100644 --- a/glep-0001.txt +++ b/glep-0001.txt @@ -245,32 +245,21 @@ All other headers are required. --- GLEP: - Version: [.] - Last-Modified: Title: Author: + Type: Status: - Type: - Content-Type: + Version: [.] Created: + Last-Modified: Post-History: + Content-Type: * Requires: * Replaces: * Replaced-By: --- -The Version field specifies the current version of the GLEP. The Version -consists of a major version, optionally followed by a minor version (if -non-zero). Every GLEP starts at version 1 which is successively incremented -as changes are merged to the GLEP. - -The major version number should be incremented (and minor reset to zero) -whenever the meaning of the GLEP changes. The minor version number should -be incremented for changes that do not affect the basic meaning (e.g. -clarifications, reference implementation updates). Editorial changes should -be merged without increasing the version. - The Author header lists the names, and optionally the email addresses of all the authors/owners of the GLEP. Anybody who submits changes to the GLEP should be added to this field.The format of the Author header @@ -290,16 +279,26 @@ following RFC 2822 continuation line conventions. The Type header specifies the type of GLEP: Informational or Standards Track. +The Version field specifies the current version of the GLEP. The Version +consists of a major version, optionally followed by a minor version (if +non-zero). Every GLEP starts at version 1 which is successively incremented +as changes are merged to the GLEP. + +The major version number should be incremented (and minor reset to zero) +whenever the meaning of the GLEP changes. The minor version number should +be incremented for changes that do not affect the basic meaning (e.g. +clarifications, reference implementation updates). Editorial changes should +be merged without increasing the version. + +The Created header records the date that the GLEP was assigned a number, +Last-Modified specifies the date that the GLEP was last updated in the master +branch, while Post-History is used to record the dates of when new versions +of the GLEP are posted to the appropriate mailing list. All three headers +should be in ISO 8601 ``yyyy-mm-dd`` format, e.g. 2001-08-14. + The format of a GLEP is specified with a Content-Type header, which must be "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 [#GLEP2]_). -The Last-Modified header specifies the date that the GLEP was last updated -in the master branch. -The Created header records the date that the GLEP was assigned a number, while -Post-History is used to record the dates of when new versions of the GLEP are -posted to gentoo-dev. All three headers should be in ISO 8601 ``yyyy-mm-dd`` -format, e.g. 2001-08-14. - GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP depends on. -- cgit v1.2.3-65-gdbad