[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [Nbd] [PATCH] docs/proto.md: Clarify SHOULD / MUST / MAY etc



On 04/06/2016 10:58 AM, Alex Bligh wrote:
> * Clarify that SHOULD / MUST / MAY etc. when in capitals have an
>   RFC 2119 meaning using the wording within that RFC.
> 
> * Put the above terms in bold.
> 
> * Fix some lowercase use of these words which actually were
>   meant to be uppercase.
> 
> * Fix some lowercase 'should' which clearly meant 'MUST'; where
>   it's not obvious, I've made them 'SHOULD' or left them as is.
> 
> Signed-off-by: Alex Bligh <alex@...872...>
> ---
>  doc/proto.md | 410 ++++++++++++++++++++++++++++++-----------------------------
>  1 file changed, 208 insertions(+), 202 deletions(-)
> 
> diff --git a/doc/proto.md b/doc/proto.md
> index 4d63b23..7cc1101 100644
> --- a/doc/proto.md
> +++ b/doc/proto.md
> @@ -25,6 +25,12 @@ comments) constant names, `0xdeadbeef` is used for literal hex numbers
>  (which are always sent in network byte order), and (brackets) are used
>  for comments. Anything else is a description of the data that is sent.
>  
> +The key words "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**",
> +"**SHALL NOT**", "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**",
> +"**MAY**", and "**OPTIONAL**" in this document are to be interpreted as
> +described in RFC 2119. The same words in lower case carry their

Worth making RFC 2119 a link to https://www.ietf.org/rfc/rfc2119.txt?

Other than that, this looks fine; getting it in sooner, rather than
later, will avoid having to rebase it on all the other changes floating
around.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


Reply to: