Re: [netmod] Proposal to enhance the YANG tree output

Benoit Claise <bclaise@cisco.com> Fri, 15 September 2017 12:54 UTC

Return-Path: <bclaise@cisco.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 707FE1332C8 for <netmod@ietfa.amsl.com>; Fri, 15 Sep 2017 05:54:40 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.5
X-Spam-Level:
X-Spam-Status: No, score=-14.5 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
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 kwFJA0Z6MpFH for <netmod@ietfa.amsl.com>; Fri, 15 Sep 2017 05:54:38 -0700 (PDT)
Received: from aer-iport-3.cisco.com (aer-iport-3.cisco.com [173.38.203.53]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 64730133211 for <netmod@ietf.org>; Fri, 15 Sep 2017 05:54:38 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=3050; q=dns/txt; s=iport; t=1505480078; x=1506689678; h=subject:to:cc:references:from:message-id:date: mime-version:in-reply-to:content-transfer-encoding; bh=QYQkByvhXvk7b//oXxQIWLKdpiFxWMgenYxUexm9bRI=; b=NuU4nRGI4yiYukBwRFsRDXpzAxEgHssfxuw36bKtlipeP6N+Mv5BfJ/6 lYEDjvUUVehywsHvnRCgOva14rz+Kc77vtq9MN8ni1KEB1ch0hsdfQtNV 3lwvZnjk3iR0hZyxH2No2e4nSUstI/MQptSOC7TngxmmjSDfr8NyKm2Kb U=;
X-IronPort-AV: E=Sophos;i="5.42,396,1500940800"; d="scan'208";a="655665276"
Received: from aer-iport-nat.cisco.com (HELO aer-core-2.cisco.com) ([173.38.203.22]) by aer-iport-3.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Sep 2017 12:54:36 +0000
Received: from [10.55.221.36] (ams-bclaise-nitro3.cisco.com [10.55.221.36]) by aer-core-2.cisco.com (8.14.5/8.14.5) with ESMTP id v8FCsVsJ017256; Fri, 15 Sep 2017 12:54:31 GMT
To: Joe Clarke <jclarke@cisco.com>, Martin Bjorklund <mbj@tail-f.com>, andy@yumaworks.com
Cc: netmod@ietf.org
References: <9d84d068-29ba-8e89-394f-b7f6a5272adc@cisco.com> <CABCOCHQZ4zJ3p_4oB1Pu=1H60btzrccqTx7rUtsRsF0reXgrYw@mail.gmail.com> <20170914.195037.593298963545596882.mbj@tail-f.com> <5721c564-48e9-299e-5ada-b272b00716cf@cisco.com>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <748ca881-2180-3096-750d-44d28aa1b7ce@cisco.com>
Date: Fri, 15 Sep 2017 14:54:31 +0200
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.3.0
MIME-Version: 1.0
In-Reply-To: <5721c564-48e9-299e-5ada-b272b00716cf@cisco.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/OyJ1v-bQxy96Z3FXL_Olcr-rBtw>
Subject: Re: [netmod] Proposal to enhance the YANG tree output
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, 15 Sep 2017 12:54:40 -0000

Hi Joe,
> On 9/14/17 13:50, Martin Bjorklund wrote:
>> Andy Bierman <andy@yumaworks.com> wrote:
>>> Hi,
>>>
>>>
>>> Actually I liked the early pyang output that was concise and easy to
>>> remember.
>>> The current format gets very cluttered and there are too many little symbols
>>> to remember them all.
>> I agree with Andy.  I also did some experiments with printing
>> enumerations, and they work ok for small enums.  But once you have
>> more than a handful they do tend to clutter the output.  Even worse so
>> for trees that go into RFCs (where lines need to be < 70 characters).
> What about protecting this with an optional parameter?  I certainly
> appreciate the output could be large, but I think it does have its uses
> sometimes.
I would agree it has its uses sometimes.
And it helps the broader community with understanding YANG, this is good.
Now, if you are already a YANG expert, I guess you don't use the tree 
output much.

Regards, Benoit (as a contributor)
>
> Joe
>
>> Lada is sometimes using a format with even less information, where he
>> has removed all type information, focusing more on the structure.
>>
>>
>> /martin
>>
>>
>>
>>>
>>> Andy
>>>
>>>
>>> On Thu, Sep 14, 2017 at 8:33 AM, Joe Clarke <jclarke@cisco.com> wrote:
>>>
>>>> I've been hacking on pyang, and I changed tree.py to add the enum values
>>>> for enumeration types and identiyref bases for identityref types.  Here
>>>> is an example:
>>>>
>>>> module: yang-catalog
>>>>      +--rw catalog
>>>>         +--rw modules
>>>>         |  +--rw module* [name revision organization]
>>>>         |     +--rw name                     yang:yang-identifier
>>>>         |     +--rw revision                 union
>>>>         |     +--rw organization             string
>>>>         |     +--rw ietf
>>>>         |     |  +--rw ietf-wg?   string
>>>>         |     +--rw namespace                inet:uri
>>>>         |     +--rw schema?                  inet:uri
>>>>         |     +--rw generated-from?          enumeration [mib, code,
>>>> not-applicable, native]
>>>>         |     +--rw maturity-level?          enumeration [ratified,
>>>> adopted, initial, not-applicable]
>>>> ...
>>>>                                 +--rw protocols
>>>>                                 |  +--rw protocol* [name]
>>>>                                 |     +--rw name
>>>> identityref -> protocol
>>>> ...
>>>>
>>>> My questions are:
>>>>
>>>> 1. Is this useful?
>>>>
>>>> 2. If so, can this be added to pyang (happy to submit a PR) and
>>>> draft-ietf-netmod-yang-tree-diagrams?
>>>>
>>>> 3. What changes to the output format would you recommend?
>>>>
>>>> Thanks.
>>>>
>>>> Joe
>>>>
>>>> _______________________________________________
>>>> 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
> .
>