Re: [yang-doctors] CODE BEGINS to mentions that CODE BEGINS is not used

Benoit Claise <bclaise@cisco.com> Sun, 18 March 2018 09:51 UTC

Return-Path: <bclaise@cisco.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id AC5781200FC for <yang-doctors@ietfa.amsl.com>; Sun, 18 Mar 2018 02:51:43 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.51
X-Spam-Level:
X-Spam-Status: No, score=-14.51 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
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 13GGyT1TtAAp for <yang-doctors@ietfa.amsl.com>; Sun, 18 Mar 2018 02:51:41 -0700 (PDT)
Received: from aer-iport-2.cisco.com (aer-iport-2.cisco.com [173.38.203.52]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5A0A71200A0 for <yang-doctors@ietf.org>; Sun, 18 Mar 2018 02:51:41 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=11000; q=dns/txt; s=iport; t=1521366701; x=1522576301; h=subject:to:cc:references:from:message-id:date: mime-version:in-reply-to; bh=qihimmagxUCykWpgsaZxC419ggKARLKJnXfwx/4RKbs=; b=UuTOE+ehhKEqE3eIRq6PwTa+RIa53Gns6YqhDNQEPrtCqR3S/KGQuexk ndtuxHQ8BXj/WI1bTCymlh8Qsws3q06c6FvQIudD7uFUomz8Cu0BFcvB4 QkyI/eVNSGONueEoX3qT+EXIf5gMwvqjJ2rZ27KjCcyLANjby+o1ML9ef E=;
X-IronPort-AV: E=Sophos;i="5.48,324,1517875200"; d="scan'208,217";a="2677837"
Received: from aer-iport-nat.cisco.com (HELO aer-core-1.cisco.com) ([173.38.203.22]) by aer-iport-2.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Mar 2018 09:51:39 +0000
Received: from [10.61.199.58] ([10.61.199.58]) by aer-core-1.cisco.com (8.14.5/8.14.5) with ESMTP id w2I9pd6t001663; Sun, 18 Mar 2018 09:51:39 GMT
To: Kent Watsen <kwatsen@juniper.net>
Cc: YANG Doctors <yang-doctors@ietf.org>, "Joe Clarke (jclarke)" <jclarke@cisco.com>
References: <25363b8e-2d4c-6ec4-404d-1d6961cfaa00@cisco.com> <4699CEF0-F355-4304-B97B-30EECB5F1A78@juniper.net>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <1de52684-6de5-19c7-2bbe-57378a60f203@cisco.com>
Date: Sun, 18 Mar 2018 09:51:39 +0000
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.6.0
MIME-Version: 1.0
In-Reply-To: <4699CEF0-F355-4304-B97B-30EECB5F1A78@juniper.net>
Content-Type: multipart/alternative; boundary="------------5E9AE3AC6B90D8E8864DF79D"
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/88I9B7zU9P01sizRki0JskQsiUI>
Subject: Re: [yang-doctors] CODE BEGINS to mentions that CODE BEGINS is not used
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sun, 18 Mar 2018 09:51:43 -0000

Working out of xml source is on my todo list.
In the IESG meeting right now. From the RFC-editor discussion, "about 
17% of docs do not have any XML source file".
We will be checking how many YANG module-related docs don't have a XML 
source file.

Regards, Benoit

>
> why do we still extract from the txt instead of the xml, now that xml 
> is mandatory?
>
> using the xml would also resolve the line-spacing issue mentioned by 
> Martin recently.
>
> additionally, xml would allow us to stash (appinfo?) processing 
> instructions, such as the command line needed to generate a tree 
> diagram or to validate an instance document.
>
> regarding generating the tree diagram, i think we’d have to accept a 
> 95% solution, as sometimes tree diagrams are hand-tweaked.
>
> if xml we’re used, presumably this error would not have occurred, as 
> the processing instruction would’ve been missing.
>
> K.
>
> Sent from my iPhone
>
> On Mar 17, 2018, at 6:34 PM, Benoit Claise <bclaise@cisco.com 
> <mailto:bclaise@cisco.com>> wrote:
>
>> Dear all,
>>
>> Here are the hackathon with Joe Clarke, dealing with the 
>> yangcatalog.org <http://yangcatalog.org> toolchain.
>>
>> Excerpt from RFC8346.
>>
>>
>>             B.1.2
>>             <https://urldefense.proofpoint.com/v2/url?u=https-3A__tools.ietf.org_html_rfc8346-23appendix-2DB.1.2&d=DwMDaQ&c=HAkYuh63rsuhr6Scbfh0UjBXeMK-ndb3voDTXcWzoCI&r=9zkP0xnJUvZGJ9EPoOH7Yhqn2gsBYaGTvjISlaJdcZo&m=MlJYZiSsWLnPWhl2UBCt0gRS9tWPXId42ZKwR1Noteo&s=M_puwPZ3Ev02hfC4ET-K-BLXytxd8gMFtWdybmT8UsY&e=>.
>>             OSPF Topology YANG Module
>>
>>         The OSPF Topology YANG module is specified below.  As mentioned, the
>>         module is intended as an example for how the Layer 3 Unicast topology
>>         model can be extended to cover OSPF topologies, but it is not
>>         normative.  Accordingly, the module is not delimited with
>>         <CODE BEGINS> and <CODE ENDS> tags.
>>
>>        file"example-ospf-topology@2017-12-16.yang"
>>        module example-ospf-topology {
>>            yang-version 1.1;
>>            namespace "urn:example:example-ospf-topology";
>>            prefix "ex-ospft";
>>            import ietf-yang-types {
>>                prefix "yang";
>>            }
>>
>> Guess what?
>> The <CODE BEGINS>, which is supposed to say that <CODE BEGINS> is not 
>> used, actually triggers the extraction
>>
>> $ xym --strict True  --debug 1 rfc8346.txt
>>
>> Extracting 'ietf-l3-unicast-topology@2018-02-26.yang'
>>    Removed 0 empty lines
>>
>> Extracting 'ietf-l3-unicast-topology-state@2018-02-26.yang'
>>    Removed 0 empty lines
>>    ERROR: 'rfc8346.txt', Line 1425 - YANG file not specified in <CODE 
>> BEGINS>
>>    ERROR: 'rfc8346.txt', Line 1428 - YANG module 
>> 'example-ospf-topology' with <CODE BEGINS> and starting with 'example-'
>>
>> Extracting 'example-ospf-topology'
>>    Getting YANG file name from module name: example-ospf-topology.yang
>>    Removed 0 empty lines
>>    ERROR: 'rfc8346.txt', Line 1963 - Missing <CODE ENDS>
>> Created the following models that conform to the strict guidelines:
>> ietf-l3-unicast-topology@2018-02-26.yang
>> ietf-l3-unicast-topology-state@2018-02-26.yang
>> example-ospf-topology.yang
>>
>> Mainly FYI.
>>
>> Regards, Benoit
>>
>> _______________________________________________
>> yang-doctors mailing list
>> yang-doctors@ietf.org <mailto:yang-doctors@ietf.org>
>> https://urldefense.proofpoint.com/v2/url?u=https-3A__www.ietf.org_mailman_listinfo_yang-2Ddoctors&d=DwICAg&c=HAkYuh63rsuhr6Scbfh0UjBXeMK-ndb3voDTXcWzoCI&r=9zkP0xnJUvZGJ9EPoOH7Yhqn2gsBYaGTvjISlaJdcZo&m=MlJYZiSsWLnPWhl2UBCt0gRS9tWPXId42ZKwR1Noteo&s=575Ltmds2wkiPt2cxV2vQbhisuj0BkFsDB13cDIXeDM&e=