Update mdsal release notes for Nitrogen 45/63245/5
authorRobert Varga <robert.varga@pantheon.tech>
Mon, 18 Sep 2017 20:07:58 +0000 (22:07 +0200)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 22 Sep 2017 22:54:13 +0000 (18:54 -0400)
- Links updated
- Reformatted to 80 columns
- Reworded EOL section

Change-Id: I8a669228776a6d03cd4f9b9690ca00a4b1050066
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
docs/getting-started-guide/project-release-notes/mdsal.rst

index d3fe0fbdc69de485224b550027dc480e2ed3d946..c2091d4e2d5b41f9aa8373ccdace709612f16a37 100644 (file)
@@ -1,6 +1,6 @@
-============
+======
 MD-SAL
-============
+======
 
 Major Features
 ==============
@@ -8,17 +8,19 @@ Major Features
 odl-mdsal-binding
 -----------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** MDSAL Binding layer, representing mapping of YANG modeled data to respective Java Objects
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/odl-mdsal-binding/pom.xml;hb=refs/heads/stable/nitrogen
+* **Feature Description:** MDSAL Binding layer, representing mapping of YANG
+  modeled data to respective Java Objects
 * **Top Level:** Yes
 * **User Facing:** No
 * **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-nitrogen/
 
 odl-mdsal-binding2
 ------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG modeled data to respective Java Objects
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/odl-mdsal-binding2/pom.xml;hb=refs/heads/stable/nitrogen
+* **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG
+  modeled data to respective Java Objects
 * **Top Level:** Yes
 * **User Facing:** No
 * **Experimental:** Yes
@@ -30,18 +32,21 @@ Documentation
 
   * :ref:`MDSAL Developer guide <mdsal_dev_guide>`
 
-  * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/carbon/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
+  * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/nitrogen/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
 
 Security Considerations
 =======================
 
-* MDSAL libraries are designed to be embedded and not to be a stand-alone application so security concerns need to be addressed by the application using this library.
+* MDSAL libraries are designed to be embedded and not to be a stand-alone
+  application so security concerns need to be addressed by the application
+  using this library.
 
 Quality Assurance
 =================
 
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=55311>`_ (70.6% line coverage)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/>`_
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=55311>`_
+  (61.0% line coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-nitrogen/>`_
 
 Migration
 ---------
@@ -57,28 +62,33 @@ Compatibility
 Bugs Fixed
 ----------
 
-* `Link of fixed bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&j_top=AND_G&list_id=78839&o1=substring&product=mdsal&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
+* `Link of fixed bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&j_top=AND_G&list_id=78839&o1=substring&product=mdsal&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Nitrogen>`_
+  Additionally, all issues fixed in Carbon SR1 and SR2 release trains have been integrated.
 
 Known Issues
 ------------
 
 * List key known issues with workarounds
-* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78842&o1=substring&product=mdsal&query_format=advanced&resolution=---&v1=Carbon>`_
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78842&o1=substring&product=mdsal&query_format=advanced&resolution=---&v1=Nitrogen>`_
 
 End-of-life
 ===========
 
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
-  release
+* Users are advised that any API element marked as @deprecated may be removed
+  in the next release. Users are advised to follow JavaDoc pointers and migrate
+  to replacement APIs.
 
-  none
+* Next release is likely to make incompatible API changes due to changes
+  in the next yangtools release.
 
 Standards
 =========
 
-* relies on processing according to `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
+* relies on processing according to
+  `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
+  `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
 
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Carbon:Release_Plan>`_
\ No newline at end of file
+* `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Nitrogen:Release_Plan>`_