docs/release-notes/projects/mdsal.rst

   1 ======
   2 MD-SAL
   3 ======
   4
   5 Major Features
   6 ==============
   7
   8 odl-mdsal-binding
   9 -----------------
  10
  11 * **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
  12 * **Feature Description:** MDSAL Binding layer, representing mapping of YANG
  13   modeled data to respective Java Objects
  14 * **Top Level:** Yes
  15 * **User Facing:** No
  16 * **Experimental:** No
  17 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-nitrogen/
  18
  19 odl-mdsal-binding2
  20 ------------------
  21 * **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
  22 * **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG
  23   modeled data to respective Java Objects
  24 * **Top Level:** Yes
  25 * **User Facing:** No
  26 * **Experimental:** Yes
  27
  28 Documentation
  29 =============
  30
  31 * **Developer Guide(s):**
  32
  33   * :ref:`MDSAL Developer guide <mdsal_dev_guide>`
  34
  35   * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/nitrogen/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
  36
  37 Security Considerations
  38 =======================
  39
  40 * MDSAL libraries are designed to be embedded and not to be a stand-alone
  41   application so security concerns need to be addressed by the application
  42   using this library.
  43
  44 Quality Assurance
  45 =================
  46
  47 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=55311>`_
  48   (61.0% line coverage)
  49 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-nitrogen/>`_
  50
  51 Migration
  52 ---------
  53
  54 * no additional steps needed for migration
  55
  56 Compatibility
  57 -------------
  58
  59 * Release is compatible with the previous one
  60 * No configuration changes
  61
  62 Bugs Fixed
  63 ----------
  64
  65 * `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>`_
  66   Additionally, all issues fixed in Carbon SR1 and SR2 release trains have been integrated.
  67
  68 Known Issues
  69 ------------
  70
  71 * List key known issues with workarounds
  72 * `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>`_
  73
  74 End-of-life
  75 ===========
  76
  77 * Users are advised that any API element marked as @deprecated may be removed
  78   in the next release. Users are advised to follow JavaDoc pointers and migrate
  79   to replacement APIs.
  80
  81 * Next release is likely to make incompatible API changes due to changes
  82   in the next yangtools release.
  83
  84 Standards
  85 =========
  86
  87 * relies on processing according to
  88   `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
  89   `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
  90
  91 Release Mechanics
  92 =================
  93
  94 * `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Nitrogen:Release_Plan>`_