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

Henrik Levkowetz <henrik@levkowetz.com> Mon, 01 October 2018 14:23 UTC

Return-Path: <henrik@levkowetz.com>
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 628B0130DDC for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 07:23:43 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, URIBL_BLOCKED=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 MOeS04GN0ww3 for <xml2rfc-dev@ietfa.amsl.com>; Mon, 1 Oct 2018 07:23:41 -0700 (PDT)
Received: from zinfandel.tools.ietf.org (zinfandel.tools.ietf.org [IPv6:2001:1890:126c::1:2a]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 53883130DC8 for <xml2rfc-dev@ietf.org>; Mon, 1 Oct 2018 07:23:41 -0700 (PDT)
Received: from h-37-140.a357.priv.bahnhof.se ([94.254.37.140]:62553 helo=tannat.localdomain) by zinfandel.tools.ietf.org with esmtpsa (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.80) (envelope-from <henrik@levkowetz.com>) id 1g6z6q-0001HI-5i; Mon, 01 Oct 2018 07:23:40 -0700
To: Julian Reschke <julian.reschke@gmx.de>, 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> <c20d9600-cbad-a305-34f4-1a6a7243df53@gmx.de> <3559f29f-38b5-4af3-f92d-d6c2a24a073f@levkowetz.com> <377cbc50-6c2f-9a62-872d-f578116693ed@gmx.de>
From: Henrik Levkowetz <henrik@levkowetz.com>
Message-ID: <a0d2f67e-641a-1f9a-36af-5a0a5e12ee5c@levkowetz.com>
Date: Mon, 01 Oct 2018 16:23:32 +0200
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:45.0) Gecko/20100101 Thunderbird/45.8.0
MIME-Version: 1.0
In-Reply-To: <377cbc50-6c2f-9a62-872d-f578116693ed@gmx.de>
Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="TRcdLgao1HnQMdQjIGiPtROJBQIhRfAJe"
X-SA-Exim-Connect-IP: 94.254.37.140
X-SA-Exim-Rcpt-To: xml2rfc-dev@ietf.org, julian.reschke@gmx.de
X-SA-Exim-Mail-From: henrik@levkowetz.com
X-SA-Exim-Version: 4.2.1 (built Mon, 26 Dec 2011 16:24:06 +0000)
X-SA-Exim-Scanned: Yes (on zinfandel.tools.ietf.org)
X-Clacks-Overhead: GNU Terry Pratchett
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/xRz9IGiPF3Dmn9ojbcxJCzmi0Pc>
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 14:23:44 -0000

Hi Julian,

On 2018-10-01 16:10, Julian Reschke wrote:
> On 10/1/2018 3:27 PM, Henrik Levkowetz wrote:
>> Hi Julian,
>> 
>> On 2018-10-01 15:07, Julian Reschke wrote:
>>> 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.
>> 
>> Umm?  For the specific purpose of specifying the name of a file for
>> extraction of artwork or sourcecode?  This is the specific case I'm
>> thinking of here.
> 
> Yes.
> 
> "A filename suitable for the contents (such as for extraction to a local 
> file).
> 
> This attribute generally isn't used for document generation, but it can 
> be helpful for other kinds of tools (such as automated syntax checkers, 
> which work by extracting the source code)." -- 
> <https://greenbytes.de/tech/webdav/rfc7749.html#element.artwork.attribute.name>
> 
> ...and, previously...:
> 
> "Finally, the "artwork" element has two optional attributes: "name" and 
> "type". The former is used to suggest a filename to use when storing the 
> content of the "artwork" element, whilst the latter contains a 
> suggestive data-typing for the content." --
> <https://tools.ietf.org/html/rfc2629#section-2.3.1.3>

Ah! Ok.  I've closed the issue.


Best regards,

	Henrik