Re: [rfc-i] [xml2rfc] use of sourcecode type

Henrik Levkowetz <henrik@levkowetz.com> Mon, 17 August 2020 10:18 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id F417A3A1489; Mon, 17 Aug 2020 03:18:18 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.848
X-Spam-Level:
X-Spam-Status: No, score=-3.848 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.001, MAILING_LIST_MULTI=-1, NICE_REPLY_A=-0.949, SPF_PASS=-0.001, 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 5BPKmEVp38XG; Mon, 17 Aug 2020 03:18:17 -0700 (PDT)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 721CE3A14A3; Mon, 17 Aug 2020 03:18:16 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id 630E4F40759; Mon, 17 Aug 2020 03:18:02 -0700 (PDT)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id B3D4BF40759 for <rfc-interest@rfc-editor.org>; Mon, 17 Aug 2020 03:18:00 -0700 (PDT)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id BXTKp5A-x1mT for <rfc-interest@rfc-editor.org>; Mon, 17 Aug 2020 03:17:56 -0700 (PDT)
Received: from zinfandel.tools.ietf.org (zinfandel.tools.ietf.org [64.170.98.42]) by rfc-editor.org (Postfix) with ESMTPS id 50DE8F40740 for <rfc-interest@rfc-editor.org>; Mon, 17 Aug 2020 03:17:55 -0700 (PDT)
Received: from h-202-242.a357.priv.bahnhof.se ([158.174.202.242]:63768 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 1k7cDO-0004ZS-He; Mon, 17 Aug 2020 03:18:08 -0700
To: Cullen Jennings <fluffy@iii.ca>, XML2RFC Interest Group <xml2rfc@ietf.org>, RFC Interest <rfc-interest@rfc-editor.org>
References: <e13ad2a9-e460-58cb-3ffe-88acec803a8a@alum.mit.edu> <748F0BE8-5DDA-4CC1-9306-0C67F906C955@tzi.org> <C123625E-B24E-4719-8680-A764F88E8CD7@iii.ca> <3EC1101F-397C-4A64-AEDA-02BB809043D9@iii.ca>
From: Henrik Levkowetz <henrik@levkowetz.com>
Message-ID: <b27bfe72-8eef-870a-ac9b-0849606395ca@levkowetz.com>
Date: Mon, 17 Aug 2020 12:17:59 +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: <3EC1101F-397C-4A64-AEDA-02BB809043D9@iii.ca>
X-SA-Exim-Connect-IP: 158.174.202.242
X-SA-Exim-Rcpt-To: rfc-interest@rfc-editor.org, xml2rfc@ietf.org, fluffy@iii.ca
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
Subject: Re: [rfc-i] [xml2rfc] use of sourcecode type
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Content-Type: multipart/mixed; boundary="===============0020896424331149796=="
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: rfc-interest <rfc-interest-bounces@rfc-editor.org>

Hi Cullen,

On 2020-08-14 23:48, Cullen Jennings wrote:
> 
> Never-mind - I found 
> 

> https://www.rfc-editor.org/materials/sourcecode-types.txt
> <https://www.rfc-editor.org/materials/sourcecode-types.txt>
> 
> Not really sure how I supposed to find that. Could we rev the RFC to
> have the required information?

FWIW, xml2rfc's built-in information, available through '$ xml2rfc --man'
in the latest release and going forward, and online at 

   https://xml2rfc.tools.ietf.org/xml2rfc-doc.html 

points at this URL for values for the <sourcecode> "type" attribute.


	Henrik
 
> 
> 
> 
>> On Aug 14, 2020, at 3:42 PM, Cullen Jennings <fluffy@iii.ca> wrote:
>> 
>> 
>> Related to this, the RFC says "The RFC Series Editor will maintain a complete list of the preferred
>>    values on the RFC Editor web site
>> “
>> 
>> Does that list exist somewhere, I’m not finding it ?
>> 
>> 
>> 
>>> On Jul 21, 2020, at 9:10 AM, Carsten Bormann <cabo@tzi.org <mailto:cabo@tzi.org>> wrote:
>>> 
>>> A similar problem is giving examples that are intentionally bad in order to demonstrate a kind of error.
>>> 
>>> I typically tag them with a type that is derived from the one I would give for real code, e.g., “CDDLx” for a bad CDDL example.  I think it would be good to agree on some way to indicate this.
>>> 
>>> A related problem is that often several code blocks combine to one valid instance of CDDL, for example see Figure 1, 2, 3 in RFC 8428.  There is no way to say that Figure 1 and 2 combine into a valid instance, and so do Figure 1 and 3, but not any other combination.
>>> 
>>> And, by the way, those type tags are conventionally lower-cased, but this is not made very explicit; you have to infer that from the list in Section 2.48.4 of RFC 7991 or the RFC editor’s updated copy of that list:
>>> 
>>> https://www.rfc-editor.org/materials/sourcecode-types.txt <https://www.rfc-editor.org/materials/sourcecode-types.txt>
>>> 
>>> (Ha, this doesn’t even have “cddl” in it; I’m not sure how this is updated and whether there shouldn’t really be an IANA registry for these.)
>>> 
>>> Grüße, Carsten
>>> 
>>> 
>>>> On 2020-07-21, at 16:36, Paul Kyzivat <pkyzivat@alum.mit.edu> wrote:
>>>> 
>>>> I have a question about specification of type in sourcecode elements:
>>>> 
>>>> In RFC4566bis there are many examples that have fragments of SDP. But they aren't compliant to SDP syntax, since it requires that many things be present - that are intentionally omitted from these examples.
>>>> 
>>>> Is it valid to tag these with type="SDP"?
>>>> 
>>>> (In sip we had a similar problem. There is a mime-type message/sip, but we sometimes also return fragments of sip in error messages. We ended up defining a separate message/sipfrag mime-type for this.)
>>>> 
>>>> 	Thanks,
>>>> 	Paul
>>>> 
>>>> _______________________________________________
>>>> xml2rfc mailing list
>>>> xml2rfc@ietf.org
>>>> https://www.ietf.org/mailman/listinfo/xml2rfc
>>> 
>>> _______________________________________________
>>> rfc-interest mailing list
>>> rfc-interest@rfc-editor.org <mailto:rfc-interest@rfc-editor.org>
>>> https://www.rfc-editor.org/mailman/listinfo/rfc-interest <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>
> 
> 
> 
> _______________________________________________
> rfc-interest mailing list
> rfc-interest@rfc-editor.org
> https://www.rfc-editor.org/mailman/listinfo/rfc-interest
> 

_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest