Re: RFC 2119 terms, ALL CAPS vs lower case

Ralph Droms <rdroms.ietf@gmail.com> Fri, 18 May 2012 16:41 UTC

Return-Path: <rdroms.ietf@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 5631C21F867A for <ietf@ietfa.amsl.com>; Fri, 18 May 2012 09:41:18 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -103.599
X-Spam-Level:
X-Spam-Status: No, score=-103.599 tagged_above=-999 required=5 tests=[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 Yt3eh6WA+cJw for <ietf@ietfa.amsl.com>; Fri, 18 May 2012 09:41:17 -0700 (PDT)
Received: from mail-qa0-f49.google.com (mail-qa0-f49.google.com [209.85.216.49]) by ietfa.amsl.com (Postfix) with ESMTP id 6E93A21F8627 for <ietf@ietf.org>; Fri, 18 May 2012 09:41:16 -0700 (PDT)
Received: by qabj40 with SMTP id j40so394716qab.15 for <ietf@ietf.org>; Fri, 18 May 2012 09:41:16 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=content-type:mime-version:subject:from:in-reply-to:date :content-transfer-encoding:message-id:references:to:x-mailer; bh=hfGAlZZtABxRgFVVWJfZw5k1iC6SbdQgCXQplZyO7qo=; b=oJHwzkRh0ZWsx6cGp44IBvmmaltLNrdglF5jWUTA+cdoGHrKJM5nLAdIwBWoZZ0Wrh 6MzZPhdvQxrOmgiE/lybyrYmD88nKuEeLX9bypjm497G+gRZyFEZpGQJJNZy1aVRAZrc znVxcDw/oPWGcx4wgCkiur7PLJT0xWLkyn33do2LbuQViJk3dMbzRMmGLGRgmpqpFY+1 EW78qnm9nU3vaMpl6rCVHNsQ9WI3eiZiyYqHqtg60QmDv9TqDP+SC71sB4O0U67aFpAh Mr2JyE3mJybx+Fdf3YTuTNnfoh9AdSnm1cRf6CL82O0tsFjcwWQfSxhgf2+qYEkuYGBk TZbw==
Received: by 10.224.212.5 with SMTP id gq5mr24434562qab.1.1337359275952; Fri, 18 May 2012 09:41:15 -0700 (PDT)
Received: from [161.44.65.173] ([161.44.65.173]) by mx.google.com with ESMTPS id x10sm21868449qan.1.2012.05.18.09.41.13 (version=TLSv1/SSLv3 cipher=OTHER); Fri, 18 May 2012 09:41:14 -0700 (PDT)
Content-Type: text/plain; charset="us-ascii"
Mime-Version: 1.0 (Apple Message framework v1278)
Subject: Re: RFC 2119 terms, ALL CAPS vs lower case
From: Ralph Droms <rdroms.ietf@gmail.com>
In-Reply-To: <01OFK8GNXASC0006TF@mauve.mrochek.com>
Date: Fri, 18 May 2012 12:41:11 -0400
Content-Transfer-Encoding: quoted-printable
Message-Id: <384732C7-C0D6-4D00-B1A8-2B9B86587264@gmail.com>
References: <562A61B995B24BD854A4D154@[192.168.0.2]> <m262bwchr9.wl%randy@psg.com> <01OFJXXZJB2I0006TF@mauve.mrochek.com> <3AAB0DB9-5E51-4117-B2BB-851700FD9CDC@gmail.com> <01OFK8GNXASC0006TF@mauve.mrochek.com>
To: IETF list discussion <ietf@ietf.org>
X-Mailer: Apple Mail (2.1278)
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 16:41:18 -0000

On May 16, 2012, at 10:22 PM 5/16/12, Ned Freed wrote:

> 
>> On May 16, 2012, at 5:22 PM 5/16/12, ned+ietf@mauve.mrochek.com wrote:
> 
>>>>>  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] when they
>>>>>  appear in ALL CAPS.  These words may also appear in this document in
>>>>>  lower case as plain English words, absent their normative meanings.
>>> 
>>>> i like this a lot
>>> 
>>> I agree. In fact I just incorporated it into the media types registration
>>> update.
> 
>> To be sure of meaning and help confusion avoidance, I would prefer that the
>> key words not appear in the document in lower case and that authors use the
>> suggested replacement words (or break out the thesaurus?).
> 
> Preferring it is one thing; I'm OK with that. Making it some sort of
> hard-and-fast rule is another matter entirely. We have too many of those
> as it is.

Well, here's another example of imprecision in the written word.  What I meant is that my preference would be a requirement that RFC 2119 key words not appear in lower case at all.

Seems to me that precision of meaning overrides graceful use of the language.  Making the requirement something like "RFC 2119 key words SHOULD NOT appear in lower case unless the lower case usage is clearly non-normative" means we have to think a lot harder about some details and (AD hat and reading glasses firmly in place) we have enough details to think about already.  So, I recommend an errata to RFC 2119: "These words MUST NOT appear in a document in lower case."

- Ralph

> 
> 				Ned