Re: [netmod] Tree diagram comment lines

mohamed.boucadair@orange.com Mon, 11 April 2022 11:50 UTC

Return-Path: <mohamed.boucadair@orange.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 B7BA53A1908 for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:50:21 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.106
X-Spam-Level:
X-Spam-Status: No, score=-2.106 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, UNPARSEABLE_RELAY=0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=orange.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 epeLoRbGNLUe for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:50:16 -0700 (PDT)
Received: from relais-inet.orange.com (relais-inet.orange.com [80.12.66.41]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 66A6C3A1907 for <netmod@ietf.org>; Mon, 11 Apr 2022 04:50:16 -0700 (PDT)
Received: from opfedar06.francetelecom.fr (unknown [xx.xx.xx.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by opfedar22.francetelecom.fr (ESMTP service) with ESMTPS id 4KcRxL6BJpz2y31; Mon, 11 Apr 2022 13:50:14 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=orange.com; s=ORANGE001; t=1649677814; bh=meTm04VjjqP4ZQIJU8xtm/w3XKxQ/jXJGd3PgtWf86Y=; h=From:To:Subject:Date:Message-ID:Content-Type: Content-Transfer-Encoding:MIME-Version; b=gJyJkbR78Eb6T/9NaqsInREE9kmsDsimiqd4YNsXls/jARXP1qSZcFqjf1ST8352E tvzNoe3I1TPMwcOFFfVamUYXUOV39BMR44X8mdVG/EZAueT3o759b6/6Ti4KXmP6la bJSshDS8Ot3xmaLLQvwljzi52SPzURF71D6GvSxFrIh2XAwtZLfqoxfENZyJAaD2X+ fMIVtS+lJgtpshsCFB6xYNZyrM+PT4lGIi1PZ6JK6tRCl6106t2BEA2+nxY/ZVnHXm 3qnX9cUQaruDfji86l4WoI7tpgnlgFAqdh4cyF3dOOX4rt/cHLIWM0+SvAkqGS6m0V ut1J30BpggFmw==
From: mohamed.boucadair@orange.com
To: Martin Björklund <mbj+ietf@4668.se>, "ietfc@btconnect.com" <ietfc@btconnect.com>
CC: "netmod@ietf.org" <netmod@ietf.org>
Thread-Topic: [netmod] Tree diagram comment lines
Thread-Index: AQHYTZPHwSjfVob+K0ePaCTAJZWNDKzqmKAw
Content-Class:
Date: Mon, 11 Apr 2022 11:50:14 +0000
Message-ID: <24762_1649677814_625415F6_24762_103_1_410ec101417e4bc892bdd6197ee519ac@orange.com>
References: <AM7PR07MB6248A833C119D7928443FB39A0EA9@AM7PR07MB6248.eurprd07.prod.outlook.com> <20220411.130246.1026658909508971766.id@4668.se>
In-Reply-To: <20220411.130246.1026658909508971766.id@4668.se>
Accept-Language: fr-FR, en-US
Content-Language: fr-FR
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
msip_labels: MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_Enabled=true; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_SetDate=2022-04-11T11:47:26Z; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_Method=Privileged; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_Name=unrestricted_parent.2; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_SiteId=90c7a20a-f34b-40bf-bc48-b9253b6f5d20; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_ActionId=eed59d24-b296-4125-821f-81115bee6106; MSIP_Label_07222825-62ea-40f3-96b5-5375c07996e2_ContentBits=0
x-originating-ip: [10.115.27.51]
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/Ih2VG3_WDJ51FZ90IGdK97ar6-k>
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:50:22 -0000

Hi all, 

Agree with Martin.

Here is the note I'm using in some RFCs with long trees:  

   The full tree diagram of the module can be generated using the
   "pyang" tool [PYANG].  That tree is not included here because it is
   too long (Section 3.3 of [RFC8340]).  Instead, subtrees are provided
   for the reader's convenience.

Cheers,
Med

> -----Message d'origine-----
> De : netmod <netmod-bounces@ietf.org> De la part de Martin
> Björklund
> Envoyé : lundi 11 avril 2022 13:03
> À : ietfc@btconnect.com
> Cc : netmod@ietf.org
> Objet : Re: [netmod] Tree diagram comment lines
> 
> 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

_________________________________________________________________________________________________________________________

Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci.

This message and its attachments may contain confidential or privileged information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified.
Thank you.