Subject: [Netconf] role of object description-stmt

From: Andy Bierman <[email-masked]>
Date: Mon, 31 May 2010 10:22:05 -0700

Hi,

There are many YANG objects in ietf-netconf.yang
that do not have description-stmts yet.

Originally, I had more of them.
The goal was to make the YANG module be the normative
source for the protocol details.  This did not really work,
and we ended up not changing the normative text sections
around.  The 'capability template' is too entrenched,
and this module may be a corner-case anyway.

So what to put in the description-stmts?
This issue is also showing up in with-defaults.
The YANG descriptions are not the same as the normative
definitions (as Kent pointed out).  Perhaps I should either
cut-and-paste or use a reference-stmt instead.

The preferred solution seems to be to use the description-stmt
as a label (e.g.,config-source == the source of the
copy operation), and use a reference-stmt to point at
the real normative text.

Another solution is to make the description-stmt
optional in IETF modules if the reference-stmt is present.

Any preferences, comments?

Andy