1 |
Attempt to reorder headers so that they are more logically ordered, |
2 |
to improve the chance that people will actually remember the order. |
3 |
|
4 |
The order is as follows: |
5 |
|
6 |
1. basic title page data (number, title, author), |
7 |
2. type and status (which looks somewhat subordinate to type), |
8 |
3. version (next to the dates) -- more frequently updated, |
9 |
4. all three dates, in time order -- Created, Last-Modified, Posted, |
10 |
5. Content-Type -- last non-optional header that never changes, |
11 |
6. optional GLEP-ref headers -- Requires, Replaces and Replaced-To. |
12 |
--- |
13 |
glep-0001.txt | 43 +++++++++++++++++++++---------------------- |
14 |
1 file changed, 21 insertions(+), 22 deletions(-) |
15 |
|
16 |
diff --git a/glep-0001.txt b/glep-0001.txt |
17 |
index 78e76ce..6d4610e 100644 |
18 |
--- a/glep-0001.txt |
19 |
+++ b/glep-0001.txt |
20 |
@@ -244,32 +244,21 @@ Headers marked with "*" are optional. All other headers are required. |
21 |
|
22 |
--- |
23 |
GLEP: <glep number> |
24 |
- Version: <major>[.<minor>] |
25 |
- Last-Modified: <date of last update> |
26 |
Title: <glep title> |
27 |
Author: <list of authors' real names and optionally, email addrs> |
28 |
+ Type: <Informational | Standards Track> |
29 |
Status: <Draft | Active | Accepted | Deferred | Withdrawn | Rejected | |
30 |
Final | Replaced | Moribund> |
31 |
- Type: <Informational | Standards Track> |
32 |
- Content-Type: <text/x-rst> |
33 |
+ Version: <major>[.<minor>] |
34 |
Created: <date created on> |
35 |
+ Last-Modified: <date of last update> |
36 |
Post-History: <dates of postings to mailing lists> |
37 |
+ Content-Type: <text/x-rst> |
38 |
* Requires: <glep numbers> |
39 |
* Replaces: <glep number> |
40 |
* Replaced-By: <glep number> |
41 |
--- |
42 |
|
43 |
-The Version field specifies the current version of the GLEP. The Version |
44 |
-consists of a major version, optionally followed by a minor version (if |
45 |
-non-zero). Every GLEP starts at version 1 which is successively incremented |
46 |
-as changes are merged to the GLEP. |
47 |
- |
48 |
-The major version number should be incremented (and minor reset to zero) |
49 |
-whenever the meaning of the GLEP changes. The minor version number should |
50 |
-be incremented for changes that do not affect the basic meaning (e.g. |
51 |
-clarifications, reference implementation updates). Editorial changes should |
52 |
-be merged without increasing the version. |
53 |
- |
54 |
The Author header lists the names, and optionally the email addresses |
55 |
of all the authors/owners of the GLEP. Anybody who submits changes to |
56 |
the GLEP should be added to this field.The format of the Author header |
57 |
@@ -289,16 +278,26 @@ following RFC 2822 continuation line conventions. |
58 |
The Type header specifies the type of GLEP: Informational or Standards |
59 |
Track. |
60 |
|
61 |
+The Version field specifies the current version of the GLEP. The Version |
62 |
+consists of a major version, optionally followed by a minor version (if |
63 |
+non-zero). Every GLEP starts at version 1 which is successively incremented |
64 |
+as changes are merged to the GLEP. |
65 |
+ |
66 |
+The major version number should be incremented (and minor reset to zero) |
67 |
+whenever the meaning of the GLEP changes. The minor version number should |
68 |
+be incremented for changes that do not affect the basic meaning (e.g. |
69 |
+clarifications, reference implementation updates). Editorial changes should |
70 |
+be merged without increasing the version. |
71 |
+ |
72 |
+The Created header records the date that the GLEP was assigned a number, |
73 |
+Last-Modified specifies the date that the GLEP was last updated in the master |
74 |
+branch, while Post-History is used to record the dates of when new versions |
75 |
+of the GLEP are posted to the appropriate mailing list. All three headers |
76 |
+should be in ISO 8601 ``yyyy-mm-dd`` format, e.g. 2001-08-14. |
77 |
+ |
78 |
The format of a GLEP is specified with a Content-Type header, which |
79 |
must be "text/x-rst" for ReStructuredText GLEPs (see GLEP 2 [#GLEP2]_). |
80 |
|
81 |
-The Last-Modified header specifies the date that the GLEP was last updated |
82 |
-in the master branch. |
83 |
-The Created header records the date that the GLEP was assigned a number, while |
84 |
-Post-History is used to record the dates of when new versions of the GLEP are |
85 |
-posted to gentoo-dev. All three headers should be in ISO 8601 ``yyyy-mm-dd`` |
86 |
-format, e.g. 2001-08-14. |
87 |
- |
88 |
GLEPs may have a Requires header, indicating the GLEP numbers that this GLEP |
89 |
depends on. |
90 |
|
91 |
-- |
92 |
2.14.1 |