Re: [netmod] [Anima] looking for practical advice on managing YANG source in XML format RFCs

Michael Richardson <mcr@sandelman.ca> Mon, 14 June 2021 15:37 UTC

Return-Path: <mcr@sandelman.ca>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 8A6C33A2848; Mon, 14 Jun 2021 08:37:04 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.232
X-Spam-Level:
X-Spam-Status: No, score=-1.232 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_SOFTFAIL=0.665, URIBL_BLOCKED=0.001] autolearn=no 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 HIToMUOvZkyP; Mon, 14 Jun 2021 08:36:59 -0700 (PDT)
Received: from relay.sandelman.ca (minerva.sandelman.ca [IPv6:2a01:7e00::3d:b000]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 8584F3A2847; Mon, 14 Jun 2021 08:36:59 -0700 (PDT)
Received: from dooku.sandelman.ca (unknown [142.169.78.190]) by relay.sandelman.ca (Postfix) with ESMTPS id 1ABF41F456; Mon, 14 Jun 2021 15:36:55 +0000 (UTC)
Received: by dooku.sandelman.ca (Postfix, from userid 179) id 49E3E1A293E; Mon, 14 Jun 2021 11:36:53 -0400 (EDT)
From: Michael Richardson <mcr@sandelman.ca>
To: Carsten Bormann <cabo@tzi.org>, netmod@ietf.org, tools-discuss@ietf.org, anima@ietf.org
In-reply-to: <D907A27E-2A70-4292-ADFA-5D8B350E676C@tzi.org>
References: <6795.1623632992@localhost> <D907A27E-2A70-4292-ADFA-5D8B350E676C@tzi.org>
Comments: In-reply-to Carsten Bormann <cabo@tzi.org> message dated "Mon, 14 Jun 2021 06:36:05 +0200."
X-Mailer: MH-E 8.6+git; nmh 1.7.1; GNU Emacs 26.3
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha512"; protocol="application/pgp-signature"
Date: Mon, 14 Jun 2021 11:36:53 -0400
Message-ID: <73347.1623685013@dooku>
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/PVCfuBdTuZZCLtH65ghcVDR-T7s>
Subject: Re: [netmod] [Anima] looking for practical advice on managing YANG source in XML format RFCs
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 14 Jun 2021 15:37:05 -0000

Carsten Bormann <cabo@tzi.org> wrote:
    > On 14. Jun 2021, at 03:09, Michael Richardson <mcr+ietf@sandelman.ca>
    > wrote:
    >> 
    >> 1) how to process yang files with YYYY-DD-MM into XML.  2) how to
    >> generate yang tree files.  3) how do I get my YANG includes
    >> downloaded, and do I put them into my repo?  4) how to do this with MT
    >> Makefiles?

    > I people could tell me what they need, we could develop a feature in
    > kramdown-rfc to handle this.  (This would presumably also include
    > support for YANG-SID files.)

But, part of the question is, how does one do this with just XML.
As wonderful as kramdown is, and it's always my preference, sometimes it is
hard to convince a design team that has started on XML to go that way.
(sunk cost fallacy, etc.)

I looked at Kent's XIAX repo documentation, and what I saw was that it might
take XML as input, paste the YANG in, but leave enough meta-data in the XML so that
the XML can be processed again.  So this is an in-place edit.  I worry that
such a workflow would be confusing to some authors who might edit in the
wrong place.

Kent, I didn't look extensively at that repo you said to clone.

As to editing in YIN, which is an XML syntax way to represent
YANG.... well... I don't mind if someone wants to store YANG that way, but I
sure don't want to edit that way.

So at this point, the best I can do is to bring my "insert-figures" hack into
a repo, rename the XML to another name, and generate draft-foobar.xml in the
top-Makefile.

-- 
]               Never tell me the odds!                 | ipv6 mesh networks [ 
]   Michael Richardson, Sandelman Software Works        | network architect  [ 
]     mcr@sandelman.ca  http://www.sandelman.ca/        |   ruby on rails    [