Gentoo Archives: gentoo-project

From: "Michał Górny" <mgorny@g.o>
To: gentoo-project@l.g.o
Subject: GLEP non-compliance report (was: [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow)
Date: Fri, 15 Sep 2017 06:40:57
Message-Id: 1505457651.2185.11.camel@gentoo.org
In Reply to: [gentoo-project] [RFC] GLEP 1/2 updates for the new old-school GLEP workflow by "Michał Górny"
1 W dniu czw, 14.09.2017 o godzinie 21∶03 +0200, użytkownik Michał Górny
2 napisał:
3 > 3. The complete set of GLEP headers is restored, and they are updated
4 > for the modern workflow:
5 >
6 > - Last-Updated needs to be set manually,
7 > - Version is updated manually and is semantic,
8 > - all dates use ISO 8601 (GLEP 45).
9 >
10 > 4. Two minor changes are made for better interoperability (i.e. less
11 > custom code and better support for external tools):
12 >
13 > - source files are renamed from .txt to .rst,
14 > - headers are surrounded by '---' to be compatible with YAML Front
15 > Matter.
16 >
17 > 5. GLEP workflow is updated to account for additional statuses in use:
18 >
19 > - 'Withdrawn' when author withdraws the GLEP (used in 4 GLEPs),
20 > - 'Moribund' when GLEP is obsoleted without a replacement
21 > (historically used in 1 GLEP but the need was discussed recently).
22
23 And here's a small report on what doesn't match the spec besides
24 the obvious changes (date format, ---).
25
26 Strict violations:
27
28 1. GLEPs 57..61 (@robbat2) used 'Updated' header with a list of dates
29 that's not allowed by the spec.
30
31 2. GLEPs 59..61 (@robbat2) used 'Updates: 44', probably to indicate that
32 they extend the format specified in GLEP 44.
33
34 3. GLEPs 31, 33, 40, 57 used 'Approved' header with a date.
35
36 4. GLEP 21 used 'Discussed-To' header for gentoo-portage-dev@ (probably
37 a typo of 'Discussions-To'.
38
39 5. GLEP 11 used 'Discussions-To: gentoo-dev@...'. This header was
40 explicitly removed from GLEP 1 as not very useful, and was probably used
41 contrary to the original use anyway.
42
43 6. GLEP 4 used 'Editor' header.
44
45 7. GLEPs 10, 12 were missing 'Content-Type'.
46
47 8. GLEP 15 used 'Status: Approved', probably 'Accepted' was meant.
48
49
50 YAML violations not strictly required by the spec:
51
52 a. most of GLEPs copied <tab> between 'Author:' and the name
53 from GLEP 2; I've replaced all of that with spaces.
54
55 b. GLEPs 28 and 30 use quoted word in the beginning of the title which
56 confuses the YAML parser. It could be solved by adding extra quoting
57 around the whole line or using fancy quotes (“”) instead of plain "".
58
59 --
60 Best regards,
61 Michał Górny