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 13:07 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 BFEA1130E61 for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 06:07:15 -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 Kws1sUbUzK-p for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 06:07:14 -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 2EEBD130E02 for <xml2rfc-dev@ietf.org>; Mon, 1 Oct 2018 06:07:13 -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 0Ldttv-1fOrS90e4B-00j0V4; Mon, 01 Oct 2018 15:07:02 +0200
Received: from [192.168.1.34] ([217.91.35.233]) by mail.gmx.com (mrgmx101 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Ldttv-1fOrS90e4B-00j0V4; Mon, 01 Oct 2018 15:07:02 +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> <edd7e2d4-77a6-bdc0-1acd-066876e0a829@gmx.de> <66f634b8-1789-cb13-02cc-08dcbdeda373@levkowetz.com>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <c20d9600-cbad-a305-34f4-1a6a7243df53@gmx.de>
Date: Mon, 01 Oct 2018 15:07:01 +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: <66f634b8-1789-cb13-02cc-08dcbdeda373@levkowetz.com>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-Provags-ID: V03:K1:/VBgNq7rMUv8W04dmEPc7upLhIjRcb1uyZmeHgs92l2xDFKikEj Q0/YJZvZRfkea8IwRD7TZ4RSRBvIdLSFXON62lXLERm2fGYbDJ1C5jvUn5aZhk2bGFOVMsh N0o69RkG7/fzZBbBaWlVLDl9zMvSZLSHsyzHbo2P6weZRR44s0OJQx665jhA/BZBHo72obe INvip/EZJCWD0EMN68ghQ==
X-UI-Out-Filterresults: notjunk:1;V01:K0:7UBS+zoSfQg=:muZCRQOCud2YbZfq3LPi39 YA3O1u7Y0z/ugX5Uqh3axHrkEpsVvaz0H8KwzeBcgweO4UDN1ENBAvfrqLAa/1ZMgqEMHT7x/ 9Vq+jztzrlNOq8CI1E2UmvEq9uBH9rZvAjpZ0HFqgiLB7LYFPm5CT0/zk64JaleWedglPvF+m Wwkt4wX4hr/It0eg2c+l7EMPBzuNawGmbOSfmT5jSUDbxZ5sg/t3G7DqDgpE3Jt2kx0F8juHd uYHkMlgmOl0qwZC2NPTdTKdntQUqjEYVEG5A8vY6WocHcR2UxAJmqFFoSOWoTyy9MAPZ7zG4n WKqme5SeqJAN0J1/phI3GWwx7O60i2J4oSClnOfSrnU2Ge6MlzU9P68HbWel/ZtYBscgu3hEw orXo0g6aAQV1oZoiVWCswHDXm07LhV8lxAOwwpthcD/GS+Jq+QpfaFa7xIigYYLiIhaeh83Ci OU3fT8q8RhLWvMVWs31kz8DrfkCQhv4ttYtotpZ4XtLx0wPpcvN8gP8sZFgbORuCLPR1lY6Or JonokaQyiL3neN/6doOYOSwOcs7ag1M3WlxuIkNawhUF/2gjDMfEUDl6VPboS+cB5Ff1uvdEa Vs5v4EEGi/hjE4Qkt9+5U/IalA5ZmytuPO/w8UNknMC8JrS0gOMEZVY39HCZXo/puxMhUQ8nh COmvWdS5eRWBfzP/geGJpplqVksSjpjrnkIsSCcl+y5EpfIYH8ooyAQFm+W77qTlH4+1kk/xf maBPynUzC9alJeEg6As0iR8vxz9EGieFzN1W9kQDxn2ZSnhW7ZK1Nc4YwKy8KdPUCmN/5c1Dl GO+i6AkAlDznDrjuNjR+5n4MdmgyPffc08PHV1KDCzcCuR4bNA=
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/5O0tlDleRmDfVeG9H4zguB50Czg>
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 13:07:16 -0000

On 10/1/2018 2:45 PM, Henrik Levkowetz wrote:
> Hi Julian,
> 
> On 2018-10-01 14:10, Julian Reschke wrote:
>> 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 think now, before actual use of v3 starts in earnest is the only chance
> we have to make changes like this.  So if the change makes sense, let's
> do it, rather than live forever with something which is (even if only
> slightly) less appropriate.

Well, @name has been around for over a decade, it's not a V3 thing. If 
this was new, I'd be more likely to agree.

>> 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.
> 
> On the coupling with sourcecode tagging, it was not my intention here
> to argue for that.  FWIW, in the next release of xml2rfc the insertion
> of <CODE BEGINS> will be controlled by an attribute "markers", with the
> default being "false".  Expansion of "file" or "name" would occur only
> for markers="true".
> 
> The "markers" attribute is of course also something we'll have to decide
> on, quite apart from this issue's proposed change of "name" to "file".

Ok, then I misread that point.

Best regards, Julian