Re: [apps-discuss] Review of draft-ietf-eai-rfc5337bis-dsn-1

"Lyndon Nerenberg (VE6BBM/VE7TFX)" <lyndon@orthanc.ca> Sun, 12 December 2010 21:47 UTC

Return-Path: <lyndon@gandalf.orthanc.ca>
X-Original-To: apps-discuss@core3.amsl.com
Delivered-To: apps-discuss@core3.amsl.com
Received: from localhost (localhost [127.0.0.1]) by core3.amsl.com (Postfix) with ESMTP id 61CF83A6D0C for <apps-discuss@core3.amsl.com>; Sun, 12 Dec 2010 13:47:19 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.599
X-Spam-Level:
X-Spam-Status: No, score=-2.599 tagged_above=-999 required=5 tests=[BAYES_00=-2.599]
Received: from mail.ietf.org ([64.170.98.32]) by localhost (core3.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 0xDB1FWaI1uy for <apps-discuss@core3.amsl.com>; Sun, 12 Dec 2010 13:47:18 -0800 (PST)
Received: from orthanc.ca (ve6bbm-1-pt.tunnel.tserv13.ash1.ipv6.he.net [IPv6:2001:470:7:139::2]) by core3.amsl.com (Postfix) with ESMTP id 764C33A6CEE for <discuss@apps.ietf.org>; Sun, 12 Dec 2010 13:47:18 -0800 (PST)
Received: from orthanc.ca (localhost [127.0.0.1]) by orthanc.ca (8.14.4/8.14.4) with ESMTP id oBCLmqAU082703 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Sun, 12 Dec 2010 13:48:52 -0800 (PST) (envelope-from lyndon@gandalf.orthanc.ca)
Received: (from uucp@localhost) by orthanc.ca (8.14.4/8.14.4/Submit) with UUCP id oBCLmq5e082702; Sun, 12 Dec 2010 13:48:52 -0800 (PST) (envelope-from lyndon@gandalf.orthanc.ca)
Received: from gandalf.orthanc.ca (frodo.orthanc.ca [172.16.0.3]) by legolas.orthanc.ca (8.14.4/8.14.4) with ESMTP id oBCLmnE4051762; Sun, 12 Dec 2010 13:48:49 -0800 (PST) (envelope-from lyndon@gandalf.orthanc.ca)
Message-ID: <252f1508ca393ec830c24fdf94d19cb5@gandalf.orthanc.ca>
To: dhc@dcrocker.net, draft-ietf-eai-rfc5337bis-dsn@tools.ietf.org
From: "Lyndon Nerenberg (VE6BBM/VE7TFX)" <lyndon@orthanc.ca>
Date: Sun, 12 Dec 2010 13:48:48 -0800
In-Reply-To: <4D050373.40406@dcrocker.net>
MIME-Version: 1.0
Content-Type: text/plain; charset="US-ASCII"
Content-Transfer-Encoding: 7bit
Cc: discuss@apps.ietf.org, iesg@ietf.org, apps-review@ietf.org
Subject: Re: [apps-discuss] Review of draft-ietf-eai-rfc5337bis-dsn-1
X-BeenThere: apps-discuss@ietf.org
X-Mailman-Version: 2.1.9
Precedence: list
List-Id: General discussion of application-layer protocols <apps-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/listinfo/apps-discuss>, <mailto:apps-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/apps-discuss>
List-Post: <mailto:apps-discuss@ietf.org>
List-Help: <mailto:apps-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/apps-discuss>, <mailto:apps-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sun, 12 Dec 2010 21:47:19 -0000

> So I suggest having a citation for the original version of the rule be included 
> in a comment associated with the new rule.
> 
> For example:
> 
>       generic-address =/ utf-8-enc-addr
>                         ; updates Section 3.2.3 of [RFC3798]

FWIW, this is what I did for IMAP Binary (3516); it doesn't seem to have
caused any confusion:

  7.  Formal Protocol Syntax

   The following syntax specification uses the augmented Backus-Naur
   Form (ABNF) notation as used in [ABNF], and incorporates by reference
   the Core Rules defined in that document.

   This syntax augments the grammar specified in [IMAP4rev1].

   append         =/  "APPEND" SP mailbox [SP flag-list]
                      [SP date-time] SP literal8

   fetch-att      =/  "BINARY" [".PEEK"] section-binary [partial]
                      / "BINARY.SIZE" section-binary

   literal8       =   "~{" number "}" CRLF *OCTET
                      ; <number> represents the number of OCTETs
                      ; in the response string.

   msg-att-static =/  "BINARY" section-binary SP (nstring / literal8)
                      / "BINARY.SIZE" section-binary SP number

   partial        =   "<" number "." nz-number ">"

   resp-text-code =/  "UNKNOWN-CTE"

   section-binary =   "[" [section-part] "]"

The base IMAP RFC (3501) made this construct easy and (I think)
relatively obvious.  YMMV.  If a grammar extension is globally
applicable to a parent specification, I think the subject document
reads easier if the extension is called out at the top of the grammar,
rather than littering each ABNF element with a callout comment.  The
alternatives can get very noisy, especially if there is multiple
inheritance involved.

--lyndon