[Tools-discuss] Tool request: datatracker link(s) to RFC-extracted YANG module(s)

Benoit Claise <bclaise@cisco.com> Wed, 08 March 2017 14:53 UTC

Return-Path: <bclaise@cisco.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 91D20129416; Wed, 8 Mar 2017 06:53:51 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.523
X-Spam-Level:
X-Spam-Status: No, score=-14.523 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-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 ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id cCkimV0QtbII; Wed, 8 Mar 2017 06:53:45 -0800 (PST)
Received: from aer-iport-3.cisco.com (aer-iport-3.cisco.com [173.38.203.53]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C14C4129496; Wed, 8 Mar 2017 06:53:44 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=1960; q=dns/txt; s=iport; t=1488984825; x=1490194425; h=to:from:subject:cc:message-id:date:mime-version: content-transfer-encoding; bh=ljlO6YRRgRAhpaKoTvj1o8AaE2xeD//rPM1xstPBVHo=; b=M1CcMooWKGjgZsfxTmQBDP0l3fMIhHugnHjAfhrz1+CZKq5QgdeorajJ MTjbBR34FgSjXbeC5t109xxHFTZbWiLkoOudA9+0wSVsLq/07ldMRFKD1 2jaoWpPs4OGsp4f/l+IOyWTImXLojv0W/XoiugSfQ0M5SRjpL1GpzMbIm w=;
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: A0B3CwBtGsBY/xbLJq1dGwEBAQMBAQEJAQEBhDIDJ2CDYIoMc6QCgg+CDSqFeIJ+GAECAQEBAQEBAWsohT8VQTUCJgJfDQgBAReJZA6wJ4Imin8BAQEBAQEEAQEBAQEBIoELhUOCBYQOgwIRAYMigl8FnDaBUoUki0KBe4hUI4YuizOICx84ewgiFQgXFYcUPzUBh1cNFweCEAEBAQ
X-IronPort-AV: E=Sophos;i="5.36,264,1486425600"; d="scan'208";a="651291586"
Received: from aer-iport-nat.cisco.com (HELO aer-core-4.cisco.com) ([173.38.203.22]) by aer-iport-3.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 08 Mar 2017 14:53:42 +0000
Received: from [10.60.67.87] (ams-bclaise-8916.cisco.com [10.60.67.87]) by aer-core-4.cisco.com (8.14.5/8.14.5) with ESMTP id v28ErgJ4030467; Wed, 8 Mar 2017 14:53:42 GMT
To: Tools Team Discussion <tools-discuss@ietf.org>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <9b8a826f-9e15-727b-efd9-cc609085222e@cisco.com>
Date: Wed, 08 Mar 2017 15:53:39 +0100
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Thunderbird/45.7.1
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/GeptBlUnyuGXHxzJq5UR1CNs-UM>
Cc: IESG IESG <iesg@ietf.org>
Subject: [Tools-discuss] Tool request: datatracker link(s) to RFC-extracted YANG module(s)
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 08 Mar 2017 14:53:51 -0000

Dear all,

We now have some YANG modules published in RFCs.
     http://www.claise.be/IETFYANGOutOfRFC.html
     http://www.claise.be/IETFYANGOutOfRFC.png

How do we provide the YANG modules to the wider audience is the problem 
at stake.

If you are familiar with the tooling, https://github.com/xym-tool/xym is 
a convenient tool to extract modules from RFCs and drafts.  There is 
another tool, smilint. Both tools should (we tried hard) provide the 
exact same outcome, but the outcome might differ by some extra blank 
lines... which complicate validation but that's a different story.
This issue: going from a YANG module => a YANG model embbeded in a txt 
draft with additional page breaks => extracted YANG module ==> some 
complications.

If you are familiar with github, all YANG modules are at 
https://github.com/YangModels/yang/tree/master/standard/ietf/RFC
     See the latest pull request so that it's up to date: 
https://github.com/YangModels/yang/pull/121

In the end, we should observe that a YANG module (or a MIB module, or 
code ...) embedded in a RFC is not easily accessible to the wider audience.
Sure there is CODE BEGINS/CODE ENDS as delimiters. Even those is a pain: 
I spent one hour this morning sending email to authors, explaining how 
to use them correctly.

The tool request is for datatracker links to extracted piece of information.
I would be happy with manual provisioning (pointing to github in my 
case) at this point in time.
I would be happy with RFCs only at this point (we have the same issue 
with drafts, but one problem at a time).

In parallel, we could think of a longer term solution: dissociate the 
YANG module, MIB module, code, etc. from the draft text ... and post 
both separately. This implies, no more .txt draft, I guess. I believe I 
read something about this in the new RFC format documents, but we would 
need a solution now.

Feedback?

Regards, Benoit