IETF Logo Mail Archive

Re: [netmod] Tree diagram comment lines

Martin Björklund <mbj+ietf@4668.se> Mon, 11 April 2022 11:03 UTC

Return-Path: <mbj+ietf@4668.se>
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 A92E73A1768 for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:03:15 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.11
X-Spam-Level:
X-Spam-Status: No, score=-2.11 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, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=4668.se header.b=SbB6nHRv; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=otoSiyjp
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 K56K0x-BeWTv for <netmod@ietfa.amsl.com>; Mon, 11 Apr 2022 04:03:09 -0700 (PDT)
Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id D37243A1765 for <netmod@ietf.org>; Mon, 11 Apr 2022 04:03:08 -0700 (PDT)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.nyi.internal (Postfix) with ESMTP id 763CE5C0135; Mon, 11 Apr 2022 07:03:05 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Mon, 11 Apr 2022 07:03:05 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=4668.se; h=cc:cc :content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm2; t=1649674985; x= 1649761385; bh=zd7S5efA7bc6Sn+TOvN/MNeEmxjqTEMSERe+cvDCgNo=; b=S bB6nHRvx8CV22eUdy6P6oIzYuesXu4dPypGsbs0C8EPmzL+8hurDJTx9NkFdtdiR mcui4SFvdvUu/aXKHg2t6kv8oj7n80k3XhMEaytYmW/WvFFsXOWwfjNNN0WMufx/ ibClnWazpRUI8Lb9Jp5xqbc/bA7PtYH1lKQe3RzSrmd2gCOQCw8oRlpUBSV8DqoY Elm81f43OhaFkAu6LDdPBqpEnv/J/jU7oES7kmZbWuVr7BJFlmeELPwkeKbvZh9a 4TKWoGVJj8j8NXZudgIdExrlaXaPtxBptLJCyHAz0TmE1C9xRz/Fl0Vq6p8AAyqS isO/LpwYjBKPJsAYFxNLA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; t=1649674985; x=1649761385; bh=zd7S5efA7bc6S n+TOvN/MNeEmxjqTEMSERe+cvDCgNo=; b=otoSiyjpbq2rCYIYjGA23TJif9GM8 276lND7v3mpLg5CDBXQeHz5hdaPY5GV0ITMRC1rj28g9PrqMOTJ3gT9SBVKTyF88 mF67dXnAbj4gmzdRTFNiirY1UczazQz8W0jdsZfaRIVMMQ+OAyDQUx+k3WzCA1+v SMqaksP9RugvOVt9E0fBWQjQEf/m6df1Mi9bk+lKQPz0s/xKrR+3kN17Msi9NxSa VXks1c0kbrAuQlrNvua2dUGztoEAchXwqfTsk5zXDhwQbthoejOo31U4/jvT2mDT HWqpxzFyDnWeGweIVQuH4RdMCS5gLmmQgvKDaEucQZTy5dN8IrVUU+C2Q==
X-ME-Sender: <xms:6QpUYvQiaVjMt76rotKLEjbjGtTqFYPxdijIjHmbXZPwt5llOGI6NA> <xme:6QpUYgw2ETO_jKW8wQQm-yFWR3cXj-IT9GQq6n_B3UVsa0LSYsoJDg9bn66CBULxl 46rYxESLZK4QK0cRuo>
X-ME-Received: <xmr:6QpUYk0jU2d-jMEgwOMpCRxdphpUU1Twk0Ada4Q-E8VVa8HzavWqPjRqYE0>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvvddrudekiedgfeehucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpeffkffvuffhjghfofggtgfgsehtje ertdertddvnecuhfhrohhmpeforghrthhinhcuuehjnphrkhhluhhnugcuoehmsghjodhi vghtfhesgeeiieekrdhsvgeqnecuggftrfgrthhtvghrnhepjeetgedvueelfeduudeule egfefgveevgfevueejhefhleeghfelieehfeffhfeknecuffhomhgrihhnpehivghtfhdr ohhrghenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpe hmsghjodhivghtfhesgeeiieekrdhsvg
X-ME-Proxy: <xmx:6QpUYvCh_EXyROhJ2gFXrtojb9tvt4QhNcAjxNOzQJzrT7-40WoASg> <xmx:6QpUYohXkmsbt8MgEYNqgSlvUwujoOD1ZG-ZlbXVDgLhj4t5RVitaQ> <xmx:6QpUYjoROmoo62t5Ib5VJJ5xG7XOKSdIERkzu51KMO1YD-TSDueIoA> <xmx:6QpUYgJ9Ego5ktqynBCXXA351oq5uecXfrHuUz6I-kMAdcsIKtRXmg>
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Mon, 11 Apr 2022 07:03:04 -0400 (EDT)
Date: Mon, 11 Apr 2022 13:02:46 +0200
Message-Id: <20220411.130246.1026658909508971766.id@4668.se>
To: ietfc@btconnect.com
Cc: netmod@ietf.org
From: Martin Björklund <mbj+ietf@4668.se>
In-Reply-To: <AM7PR07MB6248A833C119D7928443FB39A0EA9@AM7PR07MB6248.eurprd07.prod.outlook.com>
References: <AM7PR07MB6248A833C119D7928443FB39A0EA9@AM7PR07MB6248.eurprd07.prod.outlook.com>
X-Mailer: Mew version 6.8 on Emacs 26.3
Mime-Version: 1.0
Content-Type: Text/Plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/AgQcIiEKrZFCtzF5GTEeZcWLOIM>
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:03:16 -0000

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

v2.23.0 | Report a Bug | By Email