Re: RFC 2119 terms, ALL CAPS vs lower case

Marshall Eubanks <marshall.eubanks@gmail.com> Fri, 18 May 2012 13:28 UTC

Return-Path: <marshall.eubanks@gmail.com>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6C71B21F8658 for <ietf@ietfa.amsl.com>; Fri, 18 May 2012 06:28:37 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -103.653
X-Spam-Level:
X-Spam-Status: No, score=-103.653 tagged_above=-999 required=5 tests=[AWL=-0.054, BAYES_00=-2.599, RCVD_IN_DNSWL_LOW=-1, USER_IN_WHITELIST=-100]
Received: from mail.ietf.org ([12.22.58.30]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id oHLUpKL4K+jE for <ietf@ietfa.amsl.com>; Fri, 18 May 2012 06:28:36 -0700 (PDT)
Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com [209.85.217.172]) by ietfa.amsl.com (Postfix) with ESMTP id 7EAF121F8633 for <ietf@ietf.org>; Fri, 18 May 2012 06:28:36 -0700 (PDT)
Received: by lbbgo11 with SMTP id go11so2391520lbb.31 for <ietf@ietf.org>; Fri, 18 May 2012 06:28:35 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type; bh=3n+IvTr0bpQ5oO0gllTVCreWSYvoxnHTEzDzP/QWWOM=; b=0rY0/35u1Urs+EfGHOaWsgx0Lv4t1Xwk/GZ0q+CKt+HzExFdfswFqvyzE8LxztWIKD J2qGXmxcV/D1ynxoLV5r4ymjLiG6BdqzlGFOQEs7TcA64ooGlxuekZjsgp2emUo325Jj MPFk+ziE5h/Dk0UD/Pg2Q/UDG3QX7ZAGptSO7yFaR0OPpLEvLrpDdrhUBvm1yR4jS1r2 RJueFzqpZKCQ0pStHJ3ElZurSBFf/nlAfkGEVb/D1BeHsCPgzGmOzdRy/SlKqgV3DpFo TvPBFjvME+XnMXNgsF8MlLJrp5RmK34YrIKb8mnzq69Cz5dv99gMMEB5DsWlgwEH6KST jc4A==
MIME-Version: 1.0
Received: by 10.112.28.10 with SMTP id x10mr4854680lbg.41.1337347715423; Fri, 18 May 2012 06:28:35 -0700 (PDT)
Received: by 10.112.56.13 with HTTP; Fri, 18 May 2012 06:28:35 -0700 (PDT)
In-Reply-To: <4FB5D8E0.8060306@isdg.net>
References: <562A61B995B24BD854A4D154@192.168.0.2> <m262bwchr9.wl%randy@psg.com> <08ab01cd3372$65934110$30b9c330$@olddog.co.uk> <tslaa18w21n.fsf@mit.edu> <4FB3E99D.1040606@stpeter.im> <4FB3EDB8.60809@gmail.com> <m2mx57c2g5.wl%randy@psg.com> <22965.1337200180.525898@puncture> <006601cd3451$2aaa94b0$7fffbe10$@asgard.org> <4FB5D8E0.8060306@isdg.net>
Date: Fri, 18 May 2012 09:28:35 -0400
Message-ID: <CAJNg7V+M0a1kzgjVH7QJ1_9UUzh5_5CUbQmoVRLkJ8PxYrEBhQ@mail.gmail.com>
Subject: Re: RFC 2119 terms, ALL CAPS vs lower case
From: Marshall Eubanks <marshall.eubanks@gmail.com>
To: Hector Santos <hsantos@isdg.net>
Content-Type: text/plain; charset="ISO-8859-1"
Cc: IETF-Discussion <ietf@ietf.org>
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/ietf>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 18 May 2012 13:28:37 -0000

On Fri, May 18, 2012 at 1:06 AM, Hector Santos <hsantos@isdg.net> wrote:
> Lee Howard wrote:
>>
>>
>>> -----Original Message-----
>>> From: ietf-bounces@ietf.org [mailto:ietf-bounces@ietf.org] On Behalf Of
>>
>> Dave Cridland
>>>
>>> Consider:
>>>
>>> "An octet may contain 0-255".
>>> "An octet contains 0-255".
>>> "An octet might contain 0-255" - or it might not?
>>> "The Foo octet MUST lie between 0 and 127 inclusive; that is, the highest
>>
>> bit MUST NOT
>>>
>>> be set."
>>> "A valid Foo octet lies between 0 and 127 inclusive; that is, the highest
>>
>> bit is never set."
>>
>> We do not improve clarity by making sentences harder to read.
>
>
> Or colorizing it.

I find this morning a message on the URN WG list
by Alfred Hines on RFC 6329, which has a new (AFAIK) convention on
normative language

3.  Conventions Used in This Document

   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 [RFC2119].

   The lowercase forms with an initial capital "Must", "Must Not",
   "Shall", "Shall Not", "Should", "Should Not", "May", and "Optional"
   in this document are to be interpreted in the sense defined in
   [RFC2119], but are used where the normative behavior is defined in
   documents published by SDOs other than the IETF.


I am not sure this is in the direction of greater clarity. Should
there be a need to
overlay different degrees of normativeness onto a text, XML would
probably be better bet.
Whether the previous sentence is normative or not is left as an
exercise for the reader.

Regards
Marshall


>
>
>> We should avoid rfc2119 language where possible, to be clear, but not at
>> the
>> expense of clarity.
>
>
> +1, I think this is more specific to documents and not RFC2119. I don't
> think we can generalize RFC2119.
>
>
> --
> HLS
>
>