From: "Michał Górny" <mgorny@gentoo.org>
To: gentoo-project@lists.gentoo.org
Cc: "Michał Górny" <mgorny@gentoo.org>
Subject: [gentoo-project] [PATCH 20/18] glep-0001: Attempt a more logical ordering of GLEP headers
Date: Fri, 15 Sep 2017 08:51:10 +0200 [thread overview]
Message-ID: <20170915065110.7798-1-mgorny@gentoo.org> (raw)
In-Reply-To: <20170914190326.12168-1-mgorny@gentoo.org>
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 78e76ce..6d4610e 100644
--- a/glep-0001.txt
+++ b/glep-0001.txt
@@ -244,32 +244,21 @@ Headers marked with "*" are optional. All other headers are required.
---
GLEP: <glep number>
- Version: <major>[.<minor>]
- Last-Modified: <date of last update>
Title: <glep title>
Author: <list of authors' real names and optionally, email addrs>
+ Type: <Informational | Standards Track>
Status: <Draft | Active | Accepted | Deferred | Withdrawn | Rejected |
Final | Replaced | Moribund>
- Type: <Informational | Standards Track>
- Content-Type: <text/x-rst>
+ Version: <major>[.<minor>]
Created: <date created on>
+ Last-Modified: <date of last update>
Post-History: <dates of postings to mailing lists>
+ Content-Type: <text/x-rst>
* Requires: <glep numbers>
* Replaces: <glep number>
* Replaced-By: <glep number>
---
-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
@@ -289,16 +278,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.
--
2.14.1
prev parent reply other threads:[~2017-09-15 6:51 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-14 19:03 [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 01/18] glep-0001: Update for the git workflow Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 02/18] glep-0001: Revert back to ReST markup Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 03/18] glep-0001: Restore most of old GLEP headers Michał Górny
2017-09-16 13:34 ` Kristian Fiskerstrand
2017-09-16 13:35 ` Kristian Fiskerstrand
2017-09-14 19:03 ` [gentoo-project] [PATCH 04/18] glep-0001: Reform Last-Updated to be updated manually Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 05/18] glep-0001: Provide a meaningful versioning for GLEPs Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 06/18] glep-0001: Clarify the process on updating Replaced-By Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 07/18] glep-0001: Replace dates with ISO 8601 Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 08/18] glep-0001: Require .rst suffix for interoperability Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 09/18] glep-0001: Require --- around preamble " Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 10/18] glep-0001: Add 'Withdrawn' status to workflow Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 11/18] glep-0001: Add a "Moribund" status for obsolete GLEPs Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 12/18] glep-0001: Sync the RFC no to 2822 between sections Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 13/18] glep-0001: Do not require a specific header order Michał Górny
2017-09-15 8:13 ` Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 14/18] glep-0001: Make Content-Type obligatory Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 15/18] glep-0001: Add myself as co-author Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 16/18] glep-0002: Revert to ReST version Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 17/18] glep-0002: Update headers per GLEP 1 changes (example) Michał Górny
2017-09-14 19:03 ` [gentoo-project] [PATCH 18/18] glep-0045: Mark Final since GLEP 1 now uses ISO 8601 dates Michał Górny
2017-09-14 21:58 ` [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow Daniel Campbell
2017-09-14 23:28 ` Robin H. Johnson
2017-09-15 0:23 ` Daniel Campbell
2017-09-15 6:31 ` Michał Górny
2017-09-15 6:45 ` Daniel Campbell
2017-09-15 6:54 ` Michał Górny
2017-09-15 7:04 ` Daniel Campbell
2017-09-15 7:15 ` Michał Górny
2017-09-15 8:23 ` Ulrich Mueller
2017-09-15 14:13 ` Alec Warner
2017-09-15 16:23 ` Michael Orlitzky
2017-09-14 22:42 ` [gentoo-project] [PATCH 19/18] glep-0001: Require YAML conformance from the preamble Michał Górny
2017-09-14 23:31 ` [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow Robin H. Johnson
2017-09-15 6:40 ` GLEP non-compliance report (was: [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow) Michał Górny
2017-09-15 6:51 ` Michał Górny [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170915065110.7798-1-mgorny@gentoo.org \
--to=mgorny@gentoo.org \
--cc=gentoo-project@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox