Re: [netmod] tree diagrams for augment

Martin Bjorklund <mbj@tail-f.com> Tue, 23 May 2017 07:18 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 2F4231294CD for <netmod@ietfa.amsl.com>; Tue, 23 May 2017 00:18:28 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.902
X-Spam-Level:
X-Spam-Status: No, score=-1.902 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RP_MATCHES_RCVD=-0.001, SPF_PASS=-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 jowmMU30Za49 for <netmod@ietfa.amsl.com>; Tue, 23 May 2017 00:18:27 -0700 (PDT)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id CD60E127601 for <netmod@ietf.org>; Tue, 23 May 2017 00:18:26 -0700 (PDT)
Received: from localhost (unknown [173.38.220.40]) by mail.tail-f.com (Postfix) with ESMTPSA id 0382B1AE0335; Tue, 23 May 2017 09:18:25 +0200 (CEST)
Date: Tue, 23 May 2017 09:18:41 +0200
Message-Id: <20170523.091841.639172441748909073.mbj@tail-f.com>
To: andy@yumaworks.com
Cc: netmod@ietf.org
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <CABCOCHTLkkCY75Q7TneRYqZu351SeCUdboPD+u2ow4hE2_C3hA@mail.gmail.com>
References: <CABCOCHTLkkCY75Q7TneRYqZu351SeCUdboPD+u2ow4hE2_C3hA@mail.gmail.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/h60RjQFoJmOng4kporVFiWstwc0>
Subject: Re: [netmod] tree diagrams for augment
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: Tue, 23 May 2017 07:18:28 -0000

Andy Bierman <andy@yumaworks.com> wrote:
> Hi,
> 
> Below is part of 1 tree diagram from yang-push-06.
> The problem is that is shows the entire RPC, and gives
> no indication at all that this module only defines augmentations,
> or which nodes in the tree diagram will be found here.

I see what you mean, although it does give some (implicit) indication
with the prefixes (yp:).  But it is certainly not obvious.

Ideas for a better representation of augments are most welcome.  One
simple thing we could do would be to use prefixes on all augmented
nodes, and never on the nodes from the "main" module.


/martin


> 
> 
> Andy
> 
> 
>  rpcs:
>     +---x establish-subscription
>     |  +---w input
>     |  |  +---w encoding?               encoding
>     |  |  +---w (target)
>     |  |  |  +--:(event-stream)
>     |  |  |  |  +---w stream                  stream
> 
>     |  |  |  |  +---w replay-start-time?   yang:date-and-time {replay}?
>     |  |  |  +--:(yp:datastore)
>     |  |  |     +---w yp:datastore            datastore
>     |  |  +---w (applied-filter)
>     |  |  |  +--:(by-reference)
>     |  |  |  |  +---w filter-ref              filter-ref
>     |  |  |  +--:(locally-configured)
>     |  |  |     +---w filter-type             filter-type
>     |  |  |     +---w filter
>     |  |  +---w stop-time?              yang:date-and-time
>     |  |  +---w (yp:update-trigger)?
>     |  |  |  +--:(yp:periodic)
>     |  |  |  |  +---w yp:period               yang:timeticks
>     |  |  |  |  +---w yp:anchor-time?         yang:date-and-time
>     |  |  |  +--:(yp:on-change) {on-change}?
>     |  |  |     +---w yp:dampening-period     yang:timeticks
>     |  |  |     +---w yp:no-synch-on-start?   empty
>     |  |  |     +---w yp:excluded-change*     change-type
>     |  |  +---w yp:dscp?                inet:dscp
>     |  |  +---w yp:weighting?           uint8
>     |  |  +---w yp:dependency?          sn:subscription-id
>     |  +--ro output
>     |     +--ro subscription-result         subscription-result
>     |     +--ro (result)?
>     |        +--:(no-success)
>     |        |  +--ro filter-failure?             string
>     |        |  +--ro replay-start-time-hint?     yang:date-and-time
>     |        |  +--ro yp:period-hint?             yang:timeticks
>     |        |  +--ro yp:error-path?              string
>     |        |  +--ro yp:object-count-estimate?   uint32
>     |        |  +--ro yp:object-count-limit?      uint32
>     |        |  +--ro yp:kilobytes-estimate?      uint32
>     |        |  +--ro yp:kilobytes-limit?         uint32
>     |        +--:(success)
>     |           +--ro identifier                  subscription-id