Re: [netmod] Tree diagram comment lines

Benoit Claise <benoit.claise@huawei.com> Mon, 11 April 2022 11:14 UTC

Return-Path: <benoit.claise@huawei.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 359C53A17CD for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:14:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.907
X-Spam-Level:
X-Spam-Status: No, score=-1.907 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-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 Y7A5I3ci0ayi for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:14:02 -0700 (PDT)
Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id DF5513A17C6 for <netmod@ietf.org>; Mon, 11 Apr 2022 04:14:01 -0700 (PDT)
Received: from fraeml736-chm.china.huawei.com (unknown [172.18.147.206]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4KcR502vC1z6865q; Mon, 11 Apr 2022 19:11:48 +0800 (CST)
Received: from [10.195.34.48] (10.195.34.48) by fraeml736-chm.china.huawei.com (10.206.15.217) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.24; Mon, 11 Apr 2022 13:13:55 +0200
Message-ID: <7f678386-b9d6-65e3-6b1e-3017b6330ef1@huawei.com>
Date: Mon, 11 Apr 2022 13:13:48 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.7.0
Content-Language: en-GB
To: Martin Björklund <mbj+ietf@4668.se>, ietfc@btconnect.com
CC: netmod@ietf.org
References: <AM7PR07MB6248A833C119D7928443FB39A0EA9@AM7PR07MB6248.eurprd07.prod.outlook.com> <20220411.130246.1026658909508971766.id@4668.se>
From: Benoit Claise <benoit.claise@huawei.com>
In-Reply-To: <20220411.130246.1026658909508971766.id@4668.se>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
X-Originating-IP: [10.195.34.48]
X-ClientProxiedBy: dggems704-chm.china.huawei.com (10.3.19.181) To fraeml736-chm.china.huawei.com (10.206.15.217)
X-CFilter-Loop: Reflected
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/3AyzVMUj23MXfZFgR0RSditXJDk>
Subject: Re: [netmod] Tree diagram comment lines
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
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, 11 Apr 2022 11:14:07 -0000

Hi Tom,

Martin beat me on this one.
So the famous +1 to his "in combination with explanatory text to explain 
certain aspects of the module design "reply :-)
We got rid a page number for a good reason (in the YANG world).

Regards, Benoit

On 4/11/2022 1:02 PM, Martin Björklund wrote:
> tom petch <ietfc@btconnect.com> wrote:
>> Can a YANG tree diagram contain comment lines?
>>
>> draft-ietf-teas-yang-te has a tree diagram of 40 pages and since the
>> IETF has abolished the page number, then any reference into it could
>> be a challenge.  For a YANG module, this can be ameliorated by
>> inserting comment lines every page or two.
>>
>> Can this be done with tree diagrams?
> Yes, "//" introduces a (line) comment.  See 2.5 of RFC 8340.
>
> But a 40 page tree diagram isn't very useful anyway, imo.  If I want
> the full tree diagram I can run a tool to generate it.  Tree diagrams
> are best used in combination with explanatory text to explain certain
> aspects of the module design.  Perhaps section 3.4 in RFC 8407 should
> be updated to explain this.
>
>
> /martin
>
>
>
>
>> Tom Petch
>> _______________________________________________
>> 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
> .