Re: [netmod] I-D Action: draft-ietf-netmod-yang-tree-diagrams-02.txt one or many

Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> Fri, 27 October 2017 17:21 UTC

Return-Path: <j.schoenwaelder@jacobs-university.de>
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 05C28138A38 for <netmod@ietfa.amsl.com>; Fri, 27 Oct 2017 10:21:58 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001] 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 9AiITiC2F7ub for <netmod@ietfa.amsl.com>; Fri, 27 Oct 2017 10:21:56 -0700 (PDT)
Received: from atlas5.jacobs-university.de (atlas5.jacobs-university.de [212.201.44.20]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 43F9213F418 for <netmod@ietf.org>; Fri, 27 Oct 2017 10:21:55 -0700 (PDT)
Received: from localhost (demetrius5.irc-it.jacobs-university.de [10.70.0.222]) by atlas5.jacobs-university.de (Postfix) with ESMTP id 155FE691; Fri, 27 Oct 2017 19:21:54 +0200 (CEST)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from atlas5.jacobs-university.de ([10.70.0.217]) by localhost (demetrius5.jacobs-university.de [10.70.0.222]) (amavisd-new, port 10032) with ESMTP id M98TdMlUDAgr; Fri, 27 Oct 2017 19:21:52 +0200 (CEST)
Received: from hermes.jacobs-university.de (hermes.jacobs-university.de [212.201.44.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "hermes.jacobs-university.de", Issuer "Jacobs University CA - G01" (verified OK)) by atlas5.jacobs-university.de (Postfix) with ESMTPS; Fri, 27 Oct 2017 19:21:54 +0200 (CEST)
Received: from localhost (demetrius3.jacobs-university.de [212.201.44.48]) by hermes.jacobs-university.de (Postfix) with ESMTP id F34D42010B; Fri, 27 Oct 2017 19:21:53 +0200 (CEST)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from hermes.jacobs-university.de ([212.201.44.23]) by localhost (demetrius3.jacobs-university.de [212.201.44.32]) (amavisd-new, port 10024) with ESMTP id BlDF5RX4ZsyK; Fri, 27 Oct 2017 19:21:53 +0200 (CEST)
Received: from elstar.local (elstar.jacobs.jacobs-university.de [10.50.231.133]) by hermes.jacobs-university.de (Postfix) with ESMTP id 33E1E2010A; Fri, 27 Oct 2017 19:21:53 +0200 (CEST)
Received: by elstar.local (Postfix, from userid 501) id 956404140172; Fri, 27 Oct 2017 19:20:27 +0200 (CEST)
Date: Fri, 27 Oct 2017 19:20:27 +0200
From: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
To: "t.petch" <ietfc@btconnect.com>
Cc: netmod@ietf.org, Lou Berger <lberger@labn.net>
Message-ID: <20171027172027.f6ki7wljdwmwzwib@elstar.local>
Reply-To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
Mail-Followup-To: "t.petch" <ietfc@btconnect.com>, netmod@ietf.org, Lou Berger <lberger@labn.net>
References: <150893578927.4882.2117597388624976982@ietfa.amsl.com> <23892572-a0db-d24b-e591-a19799ace9ae@labn.net> <03bb01d34f14$2907e5c0$4001a8c0@gateway.2wire.net> <63fca2cd-e41e-5d79-2290-41e0d0541ccb@labn.net> <013401d34f46$42976740$4001a8c0@gateway.2wire.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <013401d34f46$42976740$4001a8c0@gateway.2wire.net>
User-Agent: NeoMutt/20170714 (1.8.3)
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/szjLOWAKGoEgkdLOrIdSYVdjjao>
Subject: Re: [netmod] I-D Action: draft-ietf-netmod-yang-tree-diagrams-02.txt one or many
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: Fri, 27 Oct 2017 17:21:58 -0000

Why do we come up with such rules in the first place? It really
depends on the modules and their relationship and it is the
responsibility of the WG, the authors, the reviewers to produce a
reasonable document.

/js

On Fri, Oct 27, 2017 at 06:08:31PM +0100, t.petch wrote:
> Lou
> 
> Suggested text
> 
> NEW
> 
> 3.3 One Document Several Modules
> 
> When a document contains several YANG modules, all the tree diagrams
> should be placed together, before all the modules.  Each tree diagram
> should be preceded by a brief introduction to highlight where one tree
> diagram ends and another starts.
> 
> If a document contains a single module which is logically a number of
> distinct components, the same strategy should be followed; RFC7317
> provides a good example of this approach.
> 
> /NEW
> 
> Like Juergen, I am conflicted as to at what point details like this
> should be part of rfc6087bis; I think a paragraph like this does belong
> in 'tree-diagrams'.
> 
> Tom Petch
> 
> ----- Original Message -----
> From: "Lou Berger" <lberger@labn.net>
> To: "t.petch" <ietfc@btconnect.com>om>; <netmod@ietf.org>
> Sent: Friday, October 27, 2017 1:38 PM
> 
> > Tom,
> >
> >
> > On 10/27/2017 7:08 AM, t.petch wrote:
> > > Lou
> > >
> > > On a slightly different tack, so a slightly modified Subject: line,
> > > when an I-D contains multiple modules, some place all the models
> > > together and then all the modules, e.g.
> > > draft-hares-i2nsf-capability-data-model-04 while others intersperse
> the
> > > models and the modules, e.g. draft-ietf-lisp-yang-05 .
> > >
> > > I think the former is superior and should be recommended, especially
> > > when, as Sue has done, there is a brief paragraph of text before
> each
> > > model, so it is very clear where a model ends and another begins.
> With
> > > the latter, models can be hard to find.
> >
> > > I see this as dovetailing into Juergen's comments on RFC7317 which,
> to
> > > me, is really several separate modules packaged as one, so the
> > > separation makes excellent sense to a reader.
> > >
> > > Where the I-D is already several modules, then do as RFC7317 has
> done.
> > Sure, Do you have text you'd like to propose?
> >
> >
> > > Tom Petch
> > >
> > > ----- Original Message -----
> > > From: "Lou Berger" <lberger@labn.net>
> > > To: <netmod@ietf.org>
> > > Sent: Wednesday, October 25, 2017 2:13 PM
> > >
> > >> Hi,
> > >>
> > >> This version addresses all known / open issues in the draft known
> to
> > >> the authors.
> > >>
> > >> The changes are as follows:
> > >> - Added groupings and yang-data descriptions
> > >> - Added Comments, Long Diagrams and Security Considerations
> sections
> > >> - Clarified representation of schema mount points and
> representation
> > > of
> > >> modules exposed using schema mount.
> > >> - Miscellaneous editorial changes
> > >>
> > >> Lou (for draft authors)
> > >>
> > >> On 10/25/2017 8:49 AM, internet-drafts@ietf.org wrote:
> > >>> A New Internet-Draft is available from the on-line Internet-Drafts
> > > directories.
> > >>> This draft is a work item of the Network Modeling WG of the IETF.
> > >>>
> > >>>         Title           : YANG Tree Diagrams
> > >>>         Authors         : Martin Bjorklund
> > >>>                           Lou Berger
> > >>> Filename        : draft-ietf-netmod-yang-tree-diagrams-02.txt
> > >>> Pages           : 11
> 
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod

-- 
Juergen Schoenwaelder           Jacobs University Bremen gGmbH
Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
Fax:   +49 421 200 3103         <http://www.jacobs-university.de/>