Bug#647570: debian-policy: Conformance of Chapter 5 to RFC 2119.
On Fri, Nov 04, 2011 at 09:55:45AM +0900, Charles Plessy wrote:
> Package: debian-policy
> Version: 3.9.2.0
> Severity: wishlist
>
> Dear all,
>
> following our discussion at the end of October about the vocabulary used in the
> Policy, (20111025143614.GB14464@merveille.plessy.net), here is a first pass on
> Chapter 5, to use the vocabulary of RFC 2119 (http://www.ietf.org/rfc/rfc2119.txt)
> where applicable.
>
> I am presenting my proposition as a patch for the words that change, and as a
> serie of extracts centered on the words that do not change.
>
> In most cases the change is a capitalisation, but in a few cases the words
> themselves change, where for instance ‘may (not)’ becomes ‘MUST (NOT)’. I
> focused on the key words defined by the RFC, with the exception of ‘mandatory’,
> which I propose to change to ‘REQUIRED’ as it was used in the context other
> ‘RECOMMENDED’ key words. I also propose to change a ‘must never’ to ‘MUST NOT’.
>
> I also made sure that ‘MUST NOT’ and ‘SHOULD NOT’ are never interrupted by a
> new line, to facilitate searches in the source document.
I would suggest we use entities instead of hard-coding 'MUST NOT/SHOULD NOT'.
This way it will be easier to generate policy document with the lower case
variant for people who cannot read uppercase words.
Cheers,
--
Bill. <ballombe@debian.org>
Imagine a large red swirl here.
Reply to: