Re: [netmod] WGLC - draft-ietf-netmod-yang-tree-diagrams

Martin Bjorklund <mbj@tail-f.com> Wed, 17 January 2018 07:43 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 BE6A912F3D0 for <netmod@ietfa.amsl.com>; Tue, 16 Jan 2018 23:43:22 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.91
X-Spam-Level:
X-Spam-Status: No, score=-1.91 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, 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 W0Xcq32tVCR6 for <netmod@ietfa.amsl.com>; Tue, 16 Jan 2018 23:43:21 -0800 (PST)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id DF59812EC56 for <netmod@ietf.org>; Tue, 16 Jan 2018 23:43:20 -0800 (PST)
Received: from localhost (h-85-209.A165.priv.bahnhof.se [94.254.85.209]) by mail.tail-f.com (Postfix) with ESMTPSA id 20A811AE0385; Wed, 17 Jan 2018 08:43:18 +0100 (CET)
Date: Wed, 17 Jan 2018 08:43:18 +0100
Message-Id: <20180117.084318.1633996450082512639.mbj@tail-f.com>
To: alexander.clemm@huawei.com
Cc: rwilton@cisco.com, vladimir@transpacket.com, netmod@ietf.org
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <644DA50AFA8C314EA9BDDAC83BD38A2E0EADB145@sjceml521-mbx.china.huawei.com>
References: <20180116.164053.2123534827829006518.mbj@tail-f.com> <e63efa9f-3114-d59d-e1d8-e62602a830c5@cisco.com> <644DA50AFA8C314EA9BDDAC83BD38A2E0EADB145@sjceml521-mbx.china.huawei.com>
X-Mailer: Mew version 6.7 on Emacs 24.5 / Mule 6.0 (HANACHIRUSATO)
Mime-Version: 1.0
Content-Type: Text/Plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/jwfOykCwFKOfgpnKSbLOcRD9uoE>
Subject: Re: [netmod] WGLC - draft-ietf-netmod-yang-tree-diagrams
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
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: Wed, 17 Jan 2018 07:43:23 -0000

Alexander Clemm <alexander.clemm@huawei.com> wrote:
> +1 to (2) as preference, followed by (1).  I don't think (3) is needed
> here.  The purpose is to make this human-readable and provide readers
> a good sense of the overall structure.  The authoritative
> specification is still the .yang itself.  Providing some guidance for
> how to represent the tree is good but let's not over-engineer this; I
> believe retaining some flexibility is good.

The last sentence summarizes my personal view.  I prefer (1), followed
by (2).


/martin

> --- Alex 
> 
> > -----Original Message-----
> ...
> > > Does anyone else have an opinion on this?  I can see three
> > > alternatives:
> > >
> > >    1) allow any number of addtional spaces
> > >    2) allow any number of addtional spaces + define a suggested
> > >       alignment algorithm
> > >    3) mandate the alignment algorithm
> > 
> > Definition of symbols should be precise/consistent, so that readers
> > can
> > consistently interpret tree diagrams.
> > 
> > I think that flexibility in layout should be OK, but the draft should
> > provide
> > guideline to ensure the output is readable, and likely to be broadly
> > consistent
> > (since consistency aids readability).
> > 
> > If the IETF data modeling group is trying to specify text output
> > precisely
> > enough that it can be screen scraped then we may want to consider
> > whether
> > we are focusing on the right solution ;-)
> > 
> > In summary, (2) is my preference, followed by (1), followed by (3).
> > 
> > Thanks,
> > Rob
> > 
> > >
> > >
> > > /martin
> > >
> > > _______________________________________________
> > > netmod mailing list
> > > netmod@ietf.org
> > > https://www.ietf.org/mailman/listinfo/netmod
> > > .
> > >
> > 
> > _______________________________________________
> > netmod mailing list
> > netmod@ietf.org
> > https://www.ietf.org/mailman/listinfo/netmod