Re: [xml2rfc-dev] RFC 7991 issue #36: Schema Issue, RFC 7991, In Section 2.5.5, "name" Attribute

Julian Reschke <julian.reschke@gmx.de> Mon, 01 October 2018 12:10 UTC

Return-Path: <julian.reschke@gmx.de>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id B78A7130E72 for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 05:10:23 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.6
X-Spam-Level:
X-Spam-Status: No, score=-2.6 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_PASS=-0.001] autolearn=ham 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 mcSpGTRASsr6 for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 05:10:21 -0700 (PDT)
Received: from mout.gmx.net (mout.gmx.net [212.227.17.22]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 27CDB120072 for <xml2rfc-dev@ietf.org>; Mon, 1 Oct 2018 05:10:20 -0700 (PDT)
Received: from [192.168.1.34] ([217.91.35.233]) by mail.gmx.com (mrgmx101 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Lr32V-1fTEQd3hjP-00eaP8; Mon, 01 Oct 2018 14:10:08 +0200
Received: from [192.168.1.34] ([217.91.35.233]) by mail.gmx.com (mrgmx101 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Lr32V-1fTEQd3hjP-00eaP8; Mon, 01 Oct 2018 14:10:08 +0200
To: Henrik Levkowetz <henrik@levkowetz.com>, XML Developer List <xml2rfc-dev@ietf.org>
References: <d97ebfcf-ee4f-02ef-39c7-ac439ba1e421@levkowetz.com> <e8d5e4d3-8cf0-80c7-f475-e86339b74d7b@levkowetz.com>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <edd7e2d4-77a6-bdc0-1acd-066876e0a829@gmx.de>
Date: Mon, 01 Oct 2018 14:10:08 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.0
MIME-Version: 1.0
In-Reply-To: <e8d5e4d3-8cf0-80c7-f475-e86339b74d7b@levkowetz.com>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-Provags-ID: V03:K1:O5gfOT5o2pt6V+qOYoamejGOlmmDtQhG/tyI+XmMDB6uSaH2tfN lV/aZnnq3ir2SabpFdkK8JD5BIFSdNmXmfjOX3D0WJHYqerymegGt9aAtogO0epsJF0Pv3h mIP7VPtNljb1JlbMxc8dZWqi6NOJgdL4Ts2Cw7xNt0SQTPrjPoPk31AL3fpaCmVdx3JnxBR nwyW8fGhIHuLx9u3uuX4A==
X-UI-Out-Filterresults: notjunk:1;V01:K0:KjuCyi1IWxs=:ccbjjgcXBeDdwetPiiKW/0 vu2sobejJbi0B0lMQx/iVzPCA8p25bzoOPtHyxmFgReuEEBIxphQ5z+RHDIv96FGL2LZ10zf4 t7LmfAQYNNsS8ozHdvPC7imU7tVM4bQMGExCke9J4UGkrZcOk+LAUyDYnyllmHApPX0bel8w1 YYQN98zqtjiao5/ySmInAzsCTQDnSvMxLV+s1ZyNW2pQwMItzfYNvevhTxqplfSzX6O6V+tnh cbkD5Jtl25HOvwr9/lJUyVSaK0NMhc5++1nk8kSozz0zJ1hJRKyb3PXnEVaALje6t3zFaAr9D 6y1o1RdXrN57u1VuJ8xFqKdEZyxhl0Mvc2doV7a6s1Mlz9+ydyB4ESdu5AHV0uFuEMQtuA3+n yuv2k1wNkfJBcZr1TeLDYHRjRdHE1GYFKbvjgCrb9SZoHo3rP8SP6lsrJu6sM8ksHsVfVvE1d /N2FKSG/W6sSfCvrZLSKJa6WU+4srJJ7cxkGjt74OA8Z8qwb/bQM2PR2CDrLUXLsabIZm27H/ wgcm9zVDvk61XE/PT9NxjqEF/qvoqDE0k+grpylPvJdYGuuZbpPX46xwxxQDOkyP1i8/bL+79 Ys2qFC2nzA+HHB0dP3kJV6utnnY8zojJHgLHSEsdE0ZtDAWwyHoBjoBI1c3VAhIQPb2v5l345 uuNygql3OzuB2ZRxcQqW3cNNzZH1pl8lxHTSk84ahZ547o+Dv80hZhJ+yYn4WxmWiLnd5Jhfw yLzQYs2R6HUuDnIx0pkHqQOnVgwal/w3mKs5yrZmk5PfmHQAyTqEI3xE8lCqN6z16/DT486xp /QD3oR9W1UkoLkEdCSn5zi3phbcSCXJ3Z29h3DNATmEKYmE+mo=
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/wEECYEqruTj9fxiUQKXUO2cNK-A>
Subject: Re: [xml2rfc-dev] RFC 7991 issue #36: Schema Issue, RFC 7991, In Section 2.5.5, "name" Attribute
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design, development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 01 Oct 2018 12:10:26 -0000

On 10/1/2018 1:36 PM, Henrik Levkowetz wrote:
> ...
> 
>        "A filename suitable for the contents (such as for extraction to a
>        local file)."
> 
>     Given the existing use of "name" on <seriesInfo>, this attribute name
>     has a semantic dissonance.
> 
>     Recommendation:  Deprecate "name" for use on <artwork> and <sourcecode>,
>                      and instead use "file", which for <sourcecode> will be
>                      explicitly rendered, as established as best current
>                      practice for YANG modules (see for instance RFC 6087
>                      [RFC6087])
> 
>     Implementation:  The current version of xml2rfc uses "name".
> ---
> ...

I would avoid making changes that aren't strictly necessary, thus keep 
the name as-is.

I also disagree with coupling the sourcecode tagging to the presence of 
a (file)name. This violates the principle of least surprise. There are 
good reasons for providing names, such as for automatic extraction 
during build time (for instance for running check scripts), which have 
absolutely nothing to do with the presentation in text or other formats.

Best regards, Julian