Re: [netmod] stable reference for tree diagram notation

Martin Bjorklund <mbj@tail-f.com> Mon, 13 March 2017 18:59 UTC

Return-Path: <mbj@tail-f.com>
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 B90AA129A63 for <netmod@ietfa.amsl.com>; Mon, 13 Mar 2017 11:59:25 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.901
X-Spam-Level:
X-Spam-Status: No, score=-1.901 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RP_MATCHES_RCVD=-0.001, 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 3cUCwaPeRdpM for <netmod@ietfa.amsl.com>; Mon, 13 Mar 2017 11:59:24 -0700 (PDT)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id 339AC129478 for <netmod@ietf.org>; Mon, 13 Mar 2017 11:59:24 -0700 (PDT)
Received: from localhost (h-148-188.a165.priv.bahnhof.se [176.10.148.188]) by mail.tail-f.com (Postfix) with ESMTPSA id 499761AE0476; Mon, 13 Mar 2017 19:59:23 +0100 (CET)
Date: Mon, 13 Mar 2017 19:59:23 +0100 (CET)
Message-Id: <20170313.195923.307435181550548168.mbj@tail-f.com>
To: rwilton@cisco.com
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <46dc5cf5-87bc-c77c-0aaa-3b7fb73b7f30@cisco.com>
References: <D4E9D4E5.A12DC%acee@cisco.com> <20170311.224951.2245774412799352894.mbj@tail-f.com> <46dc5cf5-87bc-c77c-0aaa-3b7fb73b7f30@cisco.com>
X-Mailer: Mew version 6.7 on Emacs 24.5 / Mule 6.0 (HANACHIRUSATO)
Mime-Version: 1.0
Content-Type: Text/Plain; charset=iso-8859-1
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/w743md93q6j0rPzB3uK-yTEf7Zk>
Cc: netmod@ietf.org
Subject: Re: [netmod] stable reference for tree diagram notation
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.17
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, 13 Mar 2017 18:59:26 -0000

Robert Wilton <rwilton@cisco.com> wrote:
> Hi Martin,
> 
> It looks like it needs a further tweak to also wrap augments.  I just
> tried (with the latest master off github) and hasn't wrapped the
> augment line.

Ok.  In general, it will not be possible to cover all cases.  An
example would be if you have a deeply nested module and some long leaf
names in the end.  In such cases it might be better to split the
diagram into many smaller diagrams, using --tree-path and maybe
--tree-depth.

But this particular case should be possible to handle.  I'll have a
look.  Meanwhile you'll have to tweak this manually.


/martin


> 
> E.g.
> 
> module: ietf-if-l3-vlan
>   augment
>   /if:interfaces/if:interface/if-cmn:encapsulation/if-cmn:encaps-type:
>     +--:(vlan)
>        +--rw vlan
>           +--rw tag* [index]
>              +--rw index        uint8
>              +--rw dot1q-tag
>                 +--rw tag-type    dot1q-tag-type
>                 +--rw vlan-id     ieee:vlanid
> 
> Thanks,
> Rob
> 
> 
> On 11/03/2017 21:49, Martin Bjorklund wrote:
> > "Acee Lindem (acee)" <acee@cisco.com> wrote:
> >> Hi Juergen,
> >>
> >> On 3/8/17, 2:34 PM, "netmod on behalf of Juergen Schoenwaelder"
> >> <netmod-bounces@ietf.org on behalf of
> >> j.schoenwaelder@jacobs-university.de> wrote:
> >>
> >>> On Wed, Mar 08, 2017 at 06:56:20PM +0000, Kent Watsen wrote:
> >>>> This way, reader can focus more quickly on the diffs, but also this
> >>>> likely mimics what happened in reality (start with `pyang -f tree`
> >>>> and then manually edit from there).  What do you think?
> >>>>
> >>> Manually edited tree diagrams? I hope not.
> >> I frequently have to manually edit the pyang-generated trees to get
> >> them
> >> to fit in the xml2rfc output. Is there a work around for this that I
> >> don¹t
> >> know about?
> > In the latest pyang, I have added --tree-line-length.  Use:
> >
> >    pyang -f -tree --tree-line-length 69 ...
> >
> > to fit RFCs.
> >
> >
> > /martin
> >
> > _______________________________________________
> > netmod mailing list
> > netmod@ietf.org
> > https://www.ietf.org/mailman/listinfo/netmod
> > .
> >
>