Re: [netmod] stable reference for tree diagram notation

t.petch <ietfc@btconnect.com> Thu, 09 March 2017 12:21 UTC

Return-Path: <ietfc@btconnect.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 696691295AA for <netmod@ietfa.amsl.com>; Thu, 9 Mar 2017 04:21:20 -0800 (PST)
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, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=btconnect.onmicrosoft.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 H9ZZU9pcCDPV for <netmod@ietfa.amsl.com>; Thu, 9 Mar 2017 04:21:18 -0800 (PST)
Received: from EUR01-VE1-obe.outbound.protection.outlook.com (mail-ve1eur01on0119.outbound.protection.outlook.com [104.47.1.119]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 8110B129458 for <netmod@ietf.org>; Thu, 9 Mar 2017 04:21:18 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=btconnect.onmicrosoft.com; s=selector1-btconnect-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=k8kO5Vs+xYvurl2xUQeWHyeMbtl/JLcI5ngfpkznlcU=; b=Bto5DusC1oS1HtdJyoS/fOvHKdvw88SItcKO1x3NNd+/QAJSZ3chASqE5NKUSR7kQSRmz/EGDulpuj53Fqm44AAEuSbogSvMDNQwsemkYqapuod94baeVfN+xyhT5LYlSiEsHCTsoenMLT/NXQH4OTYWBpiV6p+YzKV0QM2ZU5U=
Authentication-Results: yumaworks.com; dkim=none (message not signed) header.d=none;yumaworks.com; dmarc=none action=none header.from=btconnect.com;
Received: from pc6 (86.185.203.75) by HE1PR0701MB3002.eurprd07.prod.outlook.com (10.168.93.136) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.947.2; Thu, 9 Mar 2017 12:21:15 +0000
Message-ID: <09a301d298cf$781d3d00$4001a8c0@gateway.2wire.net>
From: t.petch <ietfc@btconnect.com>
To: Andy Bierman <andy@yumaworks.com>, Kent Watsen <kwatsen@juniper.net>
References: <EE43C03C-4660-4492-B40A-BAA17FD99A39@juniper.net> <20170303170233.GB3345@elstar.local> <20170307.185637.67261051570590747.mbj@tail-f.com> <82703e36-26f9-d459-c36a-c274861c5386@labn.net> <84583EEA-C7FE-4BB0-8D16-744E3768AB5C@nic.cz> <CABCOCHQaEAs039Tim6CWGg0h_cK1rcZo5DBS-Kko8j05UosZwQ@mail.gmail.com> <20170308180211.GA9937@elstar.local> <271CED23-8655-45A8-8E05-3ABD460871BD@juniper.net> <CABCOCHRBKaLcPExQUNp0j1TVb0zh8hDtZkUG46XkymidpFA9hw@mail.gmail.com>
Date: Thu, 9 Mar 2017 12:19:07 +0000
MIME-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
X-Priority: 3
X-MSMail-Priority: Normal
X-Mailer: Microsoft Outlook Express 6.00.2800.1106
X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2800.1106
X-Originating-IP: [86.185.203.75]
X-ClientProxiedBy: DB6PR0202CA0042.eurprd02.prod.outlook.com (10.171.70.28) To HE1PR0701MB3002.eurprd07.prod.outlook.com (10.168.93.136)
X-MS-Office365-Filtering-Correlation-Id: b21cba49-e513-47c9-c092-08d466e6c886
X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001); SRVR:HE1PR0701MB3002;
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0701MB3002; 3:bKxMOtuIvGtBzqDlCmyNoKlFZCBKStuGd6fg8ld4cCl5jZgt40RXNlgFmPXZSCaapcl/2agPwxIEye6/2de/iWAhOPdXIy6SpjmiOLCY+o+7BSTHe1xBvA7vV0Ni2hWwA2EvDwOs0wFmbEtMieaBRciytorG9Xoas/k6ORX0EHw4by4oGlWgwWI1Kw38q+VuAYyC+QCBXvrNm2YoT9yP04PKPl+vTGDF2/+QQvM/7ZnTb55HnKNl9Gtf8BggBt1ujF6DxXhiPIYqe7Um9hY4Tg==; 25:qpKBbGe4DbcoVeSk+jXGLoCdl+oSP/szeosssIU/Wp68dC2wctoE4ZXwY9mIVMc/Un39sKQsJ/OgjuSDgSRWawZ4mZegsvKVqf1M1dpp9StjKxYLYRQdhKS4qjQYhw76grAlm7HzHH02u50+zR2JUW75ylZtAHcYCfDlL4eHm5qh5roOG4tDIHcwmnrYo2Ugcrs4ptS7OwrU1ipoW4JYdFtohSb+eGTvqha5b8+p3Xd/zPzNjX6kxRP76aORxLN4RZAwe3btAOnPtS1pvixxHgSQibm4aSTnZ3ZNwM1CFQkZPO7tKBgF7Sp10gqflSGYYxNfdnj6b43qpXQDGczVlJWGPyy7ou4CTr2zPs8YTlOrczlaacYGexCDry+QPUpTcyhSC/1MC2ihj3p2xHuoquU37VJQA6RySEpTD2EDW4xM4PBt2kHklzweVewJPAzsOVTw+m1O886P5oEM5akxSw==
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0701MB3002; 31:uQjq9UJv6Ruy6GMahteXa+u7mmoejpkE2xPHBWVDM2FPJBglwDDjCw1E345VY+XX9XwlLXCgtJsZmHL/gFp2c54l2sZZ3wznROnU6O6hsJOHiC09uLkH4lgllRpqGFuO9DnML1KmRjzS6cTxj+r83Mh9jvKCfaVnwng26eE6wSZp4QYACRIaJ9gJF1lEti4GNhEnruZ9cHZIu8tgcqUJj3R/v9kuL1hy5cKnJQmIeF4tOUdKQvNSjuCay1puyU83FmFpXUtqocMEahRfiZhmow==
X-Microsoft-Antispam-PRVS: <HE1PR0701MB30025FD00756B575D20DCEF8A0210@HE1PR0701MB3002.eurprd07.prod.outlook.com>
X-Exchange-Antispam-Report-Test: UriScan:(138986009662008);
X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040375)(601004)(2401047)(8121501046)(5005006)(10201501046)(3002001)(6041248)(20161123562025)(20161123560025)(20161123564025)(20161123558025)(20161123555025)(6072148); SRVR:HE1PR0701MB3002; BCL:0; PCL:0; RULEID:; SRVR:HE1PR0701MB3002;
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0701MB3002; 4:6NEYtWj/p7Zpqu3M3NCPIy4DDGRI/8jUeWN2yEXeHUfvYsWp2wICqKl2Exfb+kCvX3ORvsavcs4lnDpGrmCzL6fJGvN3QDcNxtaADQD4PUhKZ6xzLt2twnkPvTbHwDCa+H1fZgjMitRxLc010s3j8F0rf6ELbs97KFjF1r/7adbhHprXq8bF9Bag9Q9dhuWLnwRcahwJr8k25hyeiNq7Lpp1BuxVOOTIyzXq/ePpnEn/HgifDphtCKWvjLHpUG9chHl08YtPfWbU2YiX/6BxAeYesritQEfm+PHEnZ9bBShtM9fsIaOnTPIy2Cwo6BHJL1PXLRPz/PngBQ+v+JntwJsPiOg/15fhPtYJ70RQl6CLBPntEu4aFRQSwvILExEjf52b0buO9ok/7l6qbTgcLad4ghE+yWkaUGyDe0gpdBKdKVWriaIjlDFFpxa13qsyRxpXGPX0ECwqwf8H09NkRX1DdXVAa+5mb+Do/47esv7Gg8KlT3LyXGgNrzc7bI/k3OCtve3NmcYqJYWoGAUIRuT5nI9r9R55OMxItyKkUAx4jjzeq4j6GopRzZohl3oIy1vrAwU5o5zFP7tz0tALNoSxCeej+0b7xfJZtW7o6T9kIC8dQXWjJCikI0tzTLVvptH8eVXthGd0NNwWLfHnqQ==
X-Forefront-PRVS: 0241D5F98C
X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10019020)(4630300001)(6009001)(39450400003)(13464003)(76104003)(377454003)(24454002)(66066001)(33646002)(44716002)(189998001)(8676002)(1941001)(230700001)(6666003)(305945005)(61296003)(81816999)(9686003)(50466002)(76176999)(47776003)(7736002)(3846002)(62236002)(81686999)(42186005)(6116002)(5820100001)(81166006)(1456003)(4720700003)(44736005)(23676002)(5660300001)(14496001)(38730400002)(50986999)(2906002)(6246003)(50226002)(93886004)(4326008)(25786008)(86362001)(6496005)(53546006)(1556002)(53936002)(6486002)(229853002)(8666007)(74416001)(7726001); DIR:OUT; SFP:1102; SCL:1; SRVR:HE1PR0701MB3002; H:pc6; FPR:; SPF:None; MLV:sfv; LANG:en;
X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtIRTFQUjA3MDFNQjMwMDI7MjM6d3hGRm16M0tMRkRhaldFU1VQSGRueTNh?= =?utf-8?B?aDNWR3FmeW1pSTRuVUR0K1kzOWxGQ0ViQXljSlA0Z0FQVmJtbnY5WERqWTVZ?= =?utf-8?B?K1NLN2ZZejFnR3NnQ1k5M3FuS0ZudWNTVVFRanVVaVNVQS9xVGJTeUZhM3Fm?= =?utf-8?B?VzhIaE40ZXRNY3dicWUvUjFsVkFSNjAvYnNZRk5zSjMwZVovUFg1VHdCMjNU?= =?utf-8?B?d1hBZzA5Szl3MGRON2JvUERsK0EwN2o5cGg2T0xuZG8vbmliUldQcmVUMUR6?= =?utf-8?B?L2hyTW1GRHh6LzZGcVBuTmtmWVlWdjlFWkorcHRZY1lOQlF3elZNSTdXSmVr?= =?utf-8?B?MGNTa2tCUUlFSXI3MS9pMDB2ek1Ba1J0OHFxaTI1M2pTWE8vVzNsMVRxY3V0?= =?utf-8?B?Sm1zK3NNdVpsLzBZMlJ3Rlo1R25wYm5NdGxsUGdQbVFyWFh3MGFOUVlJZE5U?= =?utf-8?B?NW9HSWVJZkJmYWhaSEszdjJBb2J6UkZpcmQ2Z1JIQjZndkV6dTBveFNGZ25F?= =?utf-8?B?SzIvbWlpWTJIMXVyUEtMcFUxdmMrNnJwMHg0ZjlTVU52aGs1QWxtRkhaMmxt?= =?utf-8?B?MU1VOXNMWDhMbE5OajY3bkcvb2dIMUxOcmdaa3NaTVBqNkkzRldpNjF6bk1G?= =?utf-8?B?Ui9ON3MwZ1JNZDZWdnJSZjBWejBwbDFXL0pmRFBCb3d6aVYzMDZ3dmJwR0Iw?= =?utf-8?B?NGY3M3BPb1JJaVJDSWwvTWR1ekFpOFVpMmFFZHlxZDVGV3k3cWpOeHB3TkJT?= =?utf-8?B?N0hjSmMyeUFneTNiK3hBZkJ0SDZscFcrWkJTVERkaGVhS3lLQzRFZ2lidTc2?= =?utf-8?B?MGtNYVlHMU5qaGtENEE0ZFUyczQ2dzBRRXZ5U08yQ1BjZE5rTHlMRE5udk9h?= =?utf-8?B?Qmlwd0N0aUNnSUwyZ3FyVmlWSUgweG16VTdFK2pwNThhTzZHbWU0ajJrOTc5?= =?utf-8?B?dzdnNDBHUG00dm8vS2toVXM0bDR1TGFBRW5qQThSbTNYQ1lBK05JYzFXRisr?= =?utf-8?B?U2V0NVczYlZUcll5R2hGeFBRMjZMbGV0dEhEUXZiNWExRkQyS0VNK0dHeGlu?= =?utf-8?B?aWdSMFcwbjZySGhnK0ZMZWQzSTFnWU4yTFhVR2x6bm9mUE5OTk01Qi9aNk5w?= =?utf-8?B?V0daY3RuNEhITnpvZVlVUUFFYXBOWVprMjBwblVjZEREcXlrbUFvbklEVWty?= =?utf-8?B?bzY0Q3VsbWFXMFdzd1g0Wms3QlFnTzhkRjdUaEMxM1YrdFNvRSs1MVJZRnRr?= =?utf-8?B?ZUpicWVSNU1ZVFJCWDFwcDZJUFhRSWpUV0hrSFIrME9xaUZRYXRVZnZQYllG?= =?utf-8?B?dzhXQjk3Wm5VM0l3eXUxWkg3a3lPWWVPRVZWZXhwaVBFUGhUcHludTdCQlZt?= =?utf-8?B?Qy93ZEZyY201SithOUcvQWYzTm9LZk1PbVloN3Q3azZMSTBsVDhZUyt4QUxS?= =?utf-8?B?cGZhWjNFNFZzdk1LTzV6VkpZNUJYdDRqVTgzMjRGaVJIS0hGWENRTWNzYWVO?= =?utf-8?B?aGgrbGQwVnNyVElnNjVjdVcxcjQwS3lPSXUxUHVrSXJySm5aL3p4SC96cGhn?= =?utf-8?B?RzJTMmlhUXhQTUhZWitic1pFS04rVVROU0J2TmpUVFhSeHJsMnBVRjRyaEdh?= =?utf-8?B?UGpmK0N2WVZkY0F3c1NydDJLeWhLckJXVUNFV3RLTWZRcnJLQVNidUhETENT?= =?utf-8?B?OGN4WnBHTkN5dHJTSDZZQU1iYkx6NVAxZlRmSE5GNHhFbTM0K3h6OG1yTXpu?= =?utf-8?B?UUZXTFVSaGhWejVObk1mOWdBPT0=?=
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0701MB3002; 6:defRC/pJj3sN0oosAMUDDfrWUGHQji72ozB143xcdCmvbb1ttBDJqVAdYb8O0bCeDQYvyimhLiHNlbS67qQG9HUL3xioaOv4dzjkdTsAJZkhHymcAUw/NGBIvpr0P8rOhDBZU53/S3U8PF06Q9uVr/e5ysR/YIqp3jXnbpu3TsgkjZ3lw2UFDpaBYMMBvihfp+5q1IsNwmOyqcBUeBkUACx5X/ycICYGaTBVmuYG6KPRn/XOEqtj3YCN/f8z87Ea21bDUCzz2U6CjyznMmTP+Y6ly6XL7JvP8+zOgbOLShqsHNnQXVmzYiY6Ojk+EB5ri8LMrV6TlO/s2U1sy1WkifPhcMk6SITzL398+10r0gEmxMnhR02tJ+lzHKKfk0ywTU3btKK5+B/7tk+aMV3dmw==; 5:BIcFtoZjuaUsPYgLuJKMdya3jPM1/+uheporYZuKJZ/2bsTeyfYwyYP4Wg4NISHYIvuYY3C8q4QP6NcocqxNzxbTlzEGYAqsNIhqGXOwiqNAxA47C/jzZBcLqKT71PNTBL3i6RNuqVpg1K/ADFXcEi6XRKf6ZiZB/HCDjkWfZ7M=; 24:xD6n2SiypOxLZhSm8q/PvEV8CbwHS8E0O5Zme0OfPci6UmHSDG/k7Nd8FLjhdMy6oQl+CciWV2TDsjEXXmrl8TTrjy724zrj0q/J9eXW8Qk=
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0701MB3002; 7:RI9DLWkW7vHRbI0TSPZhB4mCqR8RdBW/lC7WfOeKy5X0Zf7uSYxcY9Xmrik/LlBhTsxVpfv8LhhG40FBgj0J4+wM/qqCxW07kKC9Yp7OFOhlkRz25AU5ECKTxXRezRC/1GJtevg2MMl68M/LoST3fIUpvz9XD/im+Rp0LNBewIkGWxt3vwNPXvCGmZfAdMXcE8L+LEORlTa1KZJxfT0IaqYMK0wkYFx7HT6bii4P9173FANElIk65XjC4AaOs9BJ1Ba38on8700kKwn0wOJvPKxkPaOiUvGswe5wL9u9Q+byw6nO51tPBTEQFyB0fp7rPxgqjFaD8aKTI47tuMVWVA==
X-OriginatorOrg: btconnect.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Mar 2017 12:21:15.3763 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0701MB3002
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/x9Pj-PvtzbyetAjlVRtxLMb9kbs>
Cc: netmod@ietf.org
Subject: Re: [netmod] stable reference for tree diagram notation
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.17
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: Thu, 09 Mar 2017 12:21:20 -0000

---- Original Message -----
From: "Andy Bierman" <andy@yumaworks.com>
To: "Kent Watsen" <kwatsen@juniper.net>
Cc: <netmod@ietf.org>
Sent: Wednesday, March 08, 2017 7:14 PM
> On Wed, Mar 8, 2017 at 10:56 AM, Kent Watsen <kwatsen@juniper.net>
wrote:
>
> > > I think we can allow both and leave it to the document author.
Either
> > > the author uses a well known tree format and refers to its
definition
> > > or the author uses a not yet well known tree format and then it
has
> > > to be defined inline:
> >
> > Nice compromise, but even then it would be helpful if a draft that
wants
> > to use some custom-annotations do so on top of a standard
tree-diagram.
> > So, for instance, the draft might say something like:
> >
> >   Tree diagrams used in this draft use notation described in
> >   [RFCXXXX] with the following additional annotations:
> >
> >      @ - means ...
> >      # - means ...
> >      etc.
> >
> > This way, reader can focus more quickly on the diffs, but also this
> > likely mimics what happened in reality (start with `pyang -f tree`
> > and then manually edit from there).  What do you think?
> >

> YANG is supposed to be prioritized for readers, writers, and then
> tool-makers.
> As a reader of YANG modules, I do not want people creating their own
> tree diagram syntax.  I prefer all tree diagrams use the same syntax.

Spot on.

I was about to say that this thread is YANG experts discussing what is
best for YANG experts and ignoring the needs of the other 90-something
percent of those involved with YANG but Andy expressed it much better
than I

I want not just the tree diagram to be unchanging (except when something
big like schema mount comes along) but I struggle when the explanation
of the diagram changes.

Why does netmod-syslog-model have a completely different explanation to
most other models?  Is there a functional difference I need to know?  I
cannot look at netmod-syslog-model and recognise whether there is or not
without doing a compare and contrast with a 'proper' explanation, such
as netmod-entity or 6087bis-09; and I don't want to spend time on that.

Tom Petch

> > K.
> >
> >
> >
>
> Andy
>