Re: [abnf-discuss] Core Rules and References for ABNF: draft-seantek-abnf-more-core-rules-07.txt

Paul Kyzivat <pkyzivat@alum.mit.edu> Thu, 29 September 2016 21:08 UTC

Return-Path: <pkyzivat@alum.mit.edu>
X-Original-To: abnf-discuss@ietfa.amsl.com
Delivered-To: abnf-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 8CD0F12B004 for <abnf-discuss@ietfa.amsl.com>; Thu, 29 Sep 2016 14:08:41 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.935
X-Spam-Level:
X-Spam-Status: No, score=-1.935 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, SPF_SOFTFAIL=0.665] autolearn=no autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id DPZ7lg3OdA1Q for <abnf-discuss@ietfa.amsl.com>; Thu, 29 Sep 2016 14:08:40 -0700 (PDT)
Received: from resqmta-ch2-02v.sys.comcast.net (resqmta-ch2-02v.sys.comcast.net [IPv6:2001:558:fe21:29:69:252:207:34]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 05680127058 for <abnf-discuss@ietf.org>; Thu, 29 Sep 2016 14:08:39 -0700 (PDT)
Received: from resomta-ch2-17v.sys.comcast.net ([69.252.207.113]) by resqmta-ch2-02v.sys.comcast.net with SMTP id piUmb6ZDm0MKRpiZKblTFz; Thu, 29 Sep 2016 21:08:38 +0000
Received: from [192.168.1.110] ([73.186.127.100]) by resomta-ch2-17v.sys.comcast.net with SMTP id piZJb4my9bKqdpiZKbHiav; Thu, 29 Sep 2016 21:08:38 +0000
To: abnf-discuss@ietf.org
References: <20160929184942.13162.qmail@ary.lan>
From: Paul Kyzivat <pkyzivat@alum.mit.edu>
Message-ID: <4b7a37a5-2bc3-1991-1b6f-8d9e79636626@alum.mit.edu>
Date: Thu, 29 Sep 2016 17:08:37 -0400
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:45.0) Gecko/20100101 Thunderbird/45.2.0
MIME-Version: 1.0
In-Reply-To: <20160929184942.13162.qmail@ary.lan>
Content-Type: text/plain; charset="windows-1252"; format="flowed"
Content-Transfer-Encoding: 7bit
X-CMAE-Envelope: MS4wfJzq4ihDWk65vwApSri26rCWO1GN7XpLHOKtmpqY1TAiZtKE0ZgVZKcvOF/aFAJxhuLxbyZUVIBKhmmGm7ZimXX/ZQrJrH1sbzIN3rfDiKvcR8IadSVh S5H4FOJXSJlwPdKnkxetaWDyU8ZDHL2lZ48wfGZq7G3tAaMZ4pfHjpsWjbRjh1p0T7+GXVmUB8ah9g==
Archived-At: <https://mailarchive.ietf.org/arch/msg/abnf-discuss/u1dU_zqQJziY2Sv02Kvv7W29FHA>
Subject: Re: [abnf-discuss] Core Rules and References for ABNF: draft-seantek-abnf-more-core-rules-07.txt
X-BeenThere: abnf-discuss@ietf.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: "General discussion about tools, activities and capabilities involving the ABNF meta-language" <abnf-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/abnf-discuss>, <mailto:abnf-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/abnf-discuss/>
List-Post: <mailto:abnf-discuss@ietf.org>
List-Help: <mailto:abnf-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/abnf-discuss>, <mailto:abnf-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 29 Sep 2016 21:08:41 -0000

John,

On 9/29/16 2:49 PM, John Levine wrote:
>> In this draft-07 (and draft-06, which had some typos and unclear parts
>> that have since been addressed), the syntax for a "referenced rule" is
>> rulename@RULEREF, where RULEREF can be a document such as
>>
>>   URI@[RFC3986]
>>
>> or a path such as
>>
>> name-part@<https://raw.githubusercontent.com/antlr/grammars-v4/master/abnf/examples/postal.abnf>
>
> Yuck.  I agree it would be nice to make it easier to automatically collect, syntax check,
> and use ABNF, but please don't glop up the text with it.

How is:

	URI = URI@[RFC3986]

more "glopped up" than:

	URI = <URI defined in RFC3986>

(The current most concise, but semantically undefined, way to informally 
say the same thing.)

> The IETF has already decided that the RFC format is going to be XML, so put the cross
> references in the XML where parsing is trivial (given that it's already parsing the
> rest of the XML) and you don't need to invent squidgy text kludges to identify
> the various things you want to include.

If you want to literally include the external ABNF, and have it 
displayed in the document, then you can use an xml include.

But the semantics we are going for here are not that. It is important 
for the *reader* to understand what is being imported, and from where. 
If you stick it in the XML then it isn't visible to the reader.

	Thanks,
	Paul