public inbox for gentoo-project@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Michał Górny" <mgorny@gentoo.org>
To: gentoo-project@lists.gentoo.org
Cc: "Michał Górny" <mgorny@gentoo.org>
Subject: [gentoo-project] [PATCH 19/18] glep-0001: Require YAML conformance from the preamble
Date: Fri, 15 Sep 2017 00:42:17 +0200	[thread overview]
Message-ID: <20170914224217.4549-1-mgorny@gentoo.org> (raw)
In-Reply-To: <20170914190326.12168-1-mgorny@gentoo.org>

Most of the GLEP headers can be parsed by a standard YAML parsers. There
are currently two exceptions to that (due to title starting with "),
and they are easy enough to fix. Therefore, require conformance with
YAML to make sure we do not have to reinvent header parsing.
---
 glep-0001.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/glep-0001.txt b/glep-0001.txt
index 2112d41..78e76ce 100644
--- a/glep-0001.txt
+++ b/glep-0001.txt
@@ -236,8 +236,9 @@ GLEP Header
 
 Every GLEP has certain attributes associated with it. When a GLEP is sent
 to the mailing lists for discussion, it should begin with an RFC 2822 style
-header preamble between two triple-dashed lines.  Headers marked with "*" are
-optional. All other headers are required.
+header preamble between two triple-dashed lines. For interoperability,
+the header preamble should also conform to the YAML standard [#YAML]_.
+Headers marked with "*" are optional. All other headers are required.
 
 ::
 
@@ -379,6 +380,8 @@ References and Footnotes
 
 .. [#GLEP2] http://glep.gentoo.org/glep-0002.html
 
+.. [#YAML] http://yaml.org/
+
 
 Copyright
 =========
-- 
2.14.1



  parent reply	other threads:[~2017-09-14 22:42 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 ` Michał Górny [this message]
2017-09-14 23:31 ` 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 ` [gentoo-project] [PATCH 20/18] glep-0001: Attempt a more logical ordering of GLEP headers Michał Górny

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=20170914224217.4549-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