Update yangtools release notes - Nitrogen

Change-Id: I6ee7ffe927ee9b555770adce886c30aa853c1d6b
Signed-off-by: Peter Kajsa <pkajsa@cisco.com>
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/docs/getting-started-guide/project-release-notes/yangtools.rst b/docs/getting-started-guide/project-release-notes/yangtools.rst
index d9bd2aa15d8f20cfe4e75d994630c5c1b975d32d..51031f0eab9de2239695e9c0f3219509e4b62358 100644 (file)
--- a/docs/getting-started-guide/project-release-notes/yangtools.rst
+++ b/docs/getting-started-guide/project-release-notes/yangtools.rst
@@ -5,21 +5,33 @@ YANG Tools
 Major Features
 ==============
 
-Carbon release marks the sixth release of YANG Tools components. We have fixed `56 <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Carbon>`_ issues ranging from small annoyances to major reworks.
+Nitrogen release marks the seventh release of YANG Tools components. We have
+fixed lot of issues ranging from small annoyances to major reworks.
+
+Major changes delivered in this release are
+
+* Migration to new XML Parser
+  `Bug 5824 <https://bugs.opendaylight.org/show_bug.cgi?id=5824>`_
+  `Bug 5825 <https://bugs.opendaylight.org/show_bug.cgi?id=5825>`_
+* Fix of new XML parser design flaws
+  `Bug 8675 <https://bugs.opendaylight.org/show_bug.cgi?id=8675>`_
+  `Bug 8715 <https://bugs.opendaylight.org/show_bug.cgi?id=8715>`_
+  `Bug 8745 <https://bugs.opendaylight.org/show_bug.cgi?id=8745>`_.
+* InMemoryDataTree can be configured to perform full mandatory leaf
+  validation
+  `Bug 8291 <https://bugs.opendaylight.org/show_bug.cgi?id=8291>`_
+* Deviation statements are properly activated
+  `Bug 8307 <https://bugs.opendaylight.org/show_bug.cgi?id=8307>`_
+* TrieMap implementation
+  `Bug 7464 <https://bugs.opendaylight.org/show_bug.cgi?id=7464>`_
+* Improvements, bug fixing and clean up yang-model-export, yang-parser-impl,
+  yang-model-api, yang-data-impl, yang-data-api
 
-New major features delivered in this release are
-
-* Introduction of YANG 1.1 (`RFC 7950 <https://tools.ietf.org/html/rfc7950>`_)
-  support in YANG parser
-  (`Bug 2305 <https://bugs.opendaylight.org/show_bug.cgi?id=2305>`_)
-* Introduction of deviation statements support, i.e., when assembling a
-  SchemaContext, target nodes of deviations are updated according to the deviate
-  type (`Bug 6261 <https://bugs.opendaylight.org/show_bug.cgi?id=6261>`_).
 
 odl-yangtools-yang-data
 -----------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob_plain;f=features/odl-yangtools-yang-data/pom.xml;hb=refs/heads/v1.2.x
 * **Feature Description:** to install YANG Data APIs and implementation.
 * **Top Level:** Yes
 * **User Facing:** No
@@ -29,7 +41,7 @@ odl-yangtools-yang-data
 odl-yangtools-common
 --------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/odl-yangtools-common/pom.xml;hb=refs/heads/v1.2.x
 * **Feature Description:** to install common concepts and utilities.
 * **Top Level:** Yes
 * **User Facing:** No
@@ -39,12 +51,12 @@ odl-yangtools-common
 odl-yangtools-yang-parser
 -------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/odl-yangtools-yang-parser/pom.xml;hb=refs/heads/v1.2.x
 * **Feature Description:** to install YANG model APIs and YANG Parser
 * **Top Level:** Yes
 * **User Facing:** No
 * **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-nitrogen/
 
 Documentation
 =============
@@ -63,9 +75,9 @@ Quality Assurance
 =================
 
 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=13079>`_
-  (Test coverage 76%)
+  (Test coverage 75.4%)
 * `Link to CSIT Jobs
-  <https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/>`_
+  <https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-nitrogen/>`_
 
 Migration
 ---------
@@ -80,44 +92,69 @@ Compatibility
 * Release is compatible with the previous one.
 * API changes:
 
-  * `Change of if-feature related API
-    <https://wiki.opendaylight.org/view/Weather#Yangtools:_Change_of_if-feature_related_API>`_
-  * `Change in yangtools's yang-model-api
-    <https://wiki.opendaylight.org/view/Weather#Change_in_yangtools.27s_yang-model-api>`_
-  * `Changes in yang-model-api in order to support Yang 1.1
-    <https://bugs.opendaylight.org/show_bug.cgi?id=6989>`_
+  * `XmlParserStream.traverse (DOMSource)
+    <https://git.opendaylight.org/gerrit/#/c/60864/5>`_
+  * `Added UnrecognizedStatement and refactoring of StmtContextUtils
+    <https://git.opendaylight.org/gerrit/#/c/61571/>`_
+  * `Moving of SubstatementValidator into spi.meta package
+    <https://git.opendaylight.org/gerrit/#/c/61570/>`_
+  * EffectiveSchemaContext was moved, users are advised to use
+    SimpleSchemaContext
+  * org.opendaylight.yangtools.yang.parser.spi package was adjusted
+
 * No configuration changes.
 
+* Behavior changes:
+  * concepts.Registration does not allow nulls
+  * SemVer and the associated Semantic Version is now bound to OpenConfig
+  * YANG/YIN parser is less forgiving in face of ambiguous constructs
+    (like 'mandatory ture' or 'status foobar')
+
 Bugs Fixed
 ----------
 
-* List of fixed `Bugs (56)
-  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Carbon>`_.
+* List of fixed `Bugs
+  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Nitrogen%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Nitrogen%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Nitrogen>`_.
 
 Known Issues
 ------------
 
 * `Link to Open Bugs
-  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78805&o1=substring&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=---&v1=Carbon>`_
+  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Nitrogen%3A%20Yangtools&list_id=78805&o1=substring&product=yangtools&query_based_on=Nitrogen%3A%20Yangtools&query_format=advanced&resolution=---&v1=Nitrogen>`_
 
 End-of-life
 ===========
 
-* This release has not introduced any new deprecation of a major feature or API.
-  However, there are some minor deprecations such as:
+* This release has not introduced any new deprecation of a major feature
+  or API. However, there are some minor deprecations such as:
+
+  * Yang-data-impl XML codec has been deprecated
+    `<https://git.opendaylight.org/gerrit/#/c/60558/>`_
+  * YangParseException has been deprecated
+    `<https://git.opendaylight.org/gerrit/#/c/58751/>`_
 
-  * YangStatementSourceImpl has been deprecated
-  * YinStatementSourceImpList has been deprecated
-  * some methods in DataTreeFactory have been deprecated
+* Major development is shifting to 2.0.0 version, which is guaranteed to be
+  API incompatible. Users are advised to eliminate any reliance on @Deprecated
+  components as soon as possible after adopting this release.
+  Furthermore, the use of CheckedFuture will be eliminated, hence users should
+  reduce their reliance on this class.
+  Next release will also move Optional, Function, Predicate and others
+  from Guava to their java.util equivalents.
 
 Standards
 =========
 
-* YANG parser processing according to
+* YANG and YIN parser processing according to
+  `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_,
+  `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_ and
+  `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_
+* XML parser for YANG-modeled data according to
   `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
   `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
+* JSON parser for YANG-modeled data according to
+  `RFC 7951 <https://tools.ietf.org/html/rfc7951>`_
 
 Release Mechanics
 =================
 
-* `Link to the release plan <https://wiki.opendaylight.org/view/YANG_Tools:Carbon:Release_Plan>`_
+* `Link to the release plan <https://wiki.opendaylight.org/view/Simultaneous_Release:Nitrogen_Release_Plan>`_