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

Benoit Claise <bclaise@cisco.com> Sat, 17 March 2018 18:34 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 []) by ietfa.amsl.com (Postfix) with ESMTP id EC51612D0C3 for <yang-doctors@ietfa.amsl.com>; Sat, 17 Mar 2018 11:34:09 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.509
X-Spam-Status: No, score=-14.509 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, URIBL_BLOCKED=0.001, 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 ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id scLORZq2mJKO for <yang-doctors@ietfa.amsl.com>; Sat, 17 Mar 2018 11:34:07 -0700 (PDT)
Received: from aer-iport-2.cisco.com (aer-iport-2.cisco.com []) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id B07E21271DF for <yang-doctors@ietf.org>; Sat, 17 Mar 2018 11:34:06 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=5088; q=dns/txt; s=iport; t=1521311646; x=1522521246; h=to:cc:from:subject:message-id:date:mime-version; bh=sgk8og7OEI8f/90XWHdG4ayQCxzzmnAnF8NBma7rCPA=; b=F7jdxSJGhyLDvRvZm9gcohVQMeSS1/lvj7iMyxDQu/DgeR+3l2Kfg/+n QJ7ZVleN+SCBWFXvbd3a4wHqcVJdUgFpMy4cc2Wc8bbqrM7FBzLc5WcBB mRiYaNkGUBV9cdITBqXwXNqAlAoCEyfxotOdhuPDALQYJQ8bsD7G+5f8W o=;
X-IronPort-AV: E=Sophos;i="5.48,321,1517875200"; d="scan'208,217";a="2667874"
Received: from aer-iport-nat.cisco.com (HELO aer-core-4.cisco.com) ([]) by aer-iport-2.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Mar 2018 18:34:04 +0000
Received: from [] ([]) by aer-core-4.cisco.com (8.14.5/8.14.5) with ESMTP id w2HIY4x1004742; Sat, 17 Mar 2018 18:34:04 GMT
To: YANG Doctors <yang-doctors@ietf.org>
Cc: "Joe Clarke (jclarke)" <jclarke@cisco.com>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <25363b8e-2d4c-6ec4-404d-1d6961cfaa00@cisco.com>
Date: Sat, 17 Mar 2018 18:34:04 +0000
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.6.0
MIME-Version: 1.0
Content-Type: multipart/alternative; boundary="------------0694A289FE8B0C48565B6E5E"
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/bzmUJFc8ibKiayP2kVbSw0bg_JM>
Subject: [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: Sat, 17 Mar 2018 18:34:10 -0000

Dear all,

Here are the hackathon with Joe Clarke, dealing with the yangcatalog.org 

Excerpt from RFC8346.

            B.1.2 <https://tools.ietf.org/html/rfc8346#appendix-B.1.2>.
            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 
    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:

Mainly FYI.

Regards, Benoit