Skip to content

Commit

Permalink
Proposed text for #221
Browse files Browse the repository at this point in the history
  • Loading branch information
rgwilton committed Jan 16, 2024
1 parent 10f6bd2 commit d52a9e9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -884,10 +884,10 @@ Internet-Draft Updated YANG Module Revision Handling January 2024

6.1. Guidelines for YANG module authors

All IETF YANG modules MUST include revision label statements for all
newly published YANG modules, and all newly published revisions of
existing YANG modules. The revision label MUST take the form of a
YANG semantic version number [I-D.ietf-netmod-yang-semver].
All IETF YANG modules MUST conform to this specification. In
particular, sections: Section 3, Section 4, and the guidelines
documented in this section.




Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,7 @@ module: ietf-yang-library-revisions
<xref target="RFC8407"/> to revise the guidelines for updating YANG modules.
</t>
<section anchor="guidelines_authors" title="Guidelines for YANG module authors">
<t>All IETF YANG modules MUST include revision label statements for all newly published YANG modules, and all newly published revisions of existing YANG modules. The revision label MUST take the form of a YANG semantic version number <xref target="I-D.ietf-netmod-yang-semver"/>.
</t>
<t>All IETF YANG modules MUST conform to this specification. In particular, sections: <xref target="yang_revision_handling"/>, <xref target="import-overview"/>, and the guidelines documented in this section.</t>
<t>NBC changes to YANG modules may cause problems to clients, who are consumers of YANG models, and hence YANG module authors SHOULD minimize NBC changes and keep changes BC whenever possible.</t>
<t>When NBC changes are introduced, consideration should be given to the impact on clients and YANG module authors SHOULD try to mitigate that impact.</t>
<t>A "rev:non-backwards-compatible" statement MUST be added if there are NBC changes relative to the previous revision.</t>
Expand Down

0 comments on commit d52a9e9

Please sign in to comment.