docs/getting-started-guide/project-release-notes/yangtools.rst

   1 ==========
   2 YANG Tools
   3 ==========
   4
   5 Major Features
   6 ==============
   7
   8 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.
   9
  10 New major features delivered in this release are
  11
  12 * Introduction of YANG 1.1 (`RFC 7950 <https://tools.ietf.org/html/rfc7950>`_)
  13   support in YANG parser
  14   (`Bug 2305 <https://bugs.opendaylight.org/show_bug.cgi?id=2305>`_)
  15 * Introduction of deviation statements support, i.e., when assembling a
  16   SchemaContext, target nodes of deviations are updated according to the deviate
  17   type (`Bug 6261 <https://bugs.opendaylight.org/show_bug.cgi?id=6261>`_).
  18
  19 odl-yangtools-yang-data
  20 -----------------------
  21
  22 * **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
  23 * **Feature Description:** to install YANG Data APIs and implementation.
  24 * **Top Level:** Yes
  25 * **User Facing:** No
  26 * **Experimental:** Yes
  27 * **CSIT Test:** System test waiver request pending.
  28
  29 odl-yangtools-common
  30 --------------------
  31
  32 * **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
  33 * **Feature Description:** to install common concepts and utilities.
  34 * **Top Level:** Yes
  35 * **User Facing:** No
  36 * **Experimental:** Yes
  37 * **CSIT Test:** System test waiver request pending.
  38
  39 odl-yangtools-yang-parser
  40 -------------------------
  41
  42 * **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
  43 * **Feature Description:** to install YANG model APIs and YANG Parser
  44 * **Top Level:** Yes
  45 * **User Facing:** No
  46 * **Experimental:** No
  47 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/
  48
  49 Documentation
  50 =============
  51 * **Developer Guide(s):**
  52
  53   * :ref:`yangtools-developer-guide`
  54
  55 Security Considerations
  56 =======================
  57
  58 * YANG Tools libraries are designed to be embedded and not to be a stand-alone
  59   application so security concerns need to be addressed by the application
  60   using this library.
  61
  62 Quality Assurance
  63 =================
  64
  65 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=13079>`_
  66   (Test coverage 76%)
  67 * `Link to CSIT Jobs
  68   <https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/>`_
  69
  70 Migration
  71 ---------
  72
  73 * It is possible to migrate from the previous release. Aside from adjusting to
  74   the removal of deprecated API elements and changed elements, there are no
  75   additional steps needed for migration to this release.
  76
  77 Compatibility
  78 -------------
  79
  80 * Release is compatible with the previous one.
  81 * API changes:
  82
  83   * `Change of if-feature related API
  84     <https://wiki.opendaylight.org/view/Weather#Yangtools:_Change_of_if-feature_related_API>`_
  85   * `Change in yangtools's yang-model-api
  86     <https://wiki.opendaylight.org/view/Weather#Change_in_yangtools.27s_yang-model-api>`_
  87   * `Changes in yang-model-api in order to support Yang 1.1
  88     <https://bugs.opendaylight.org/show_bug.cgi?id=6989>`_
  89 * No configuration changes.
  90
  91 Bugs Fixed
  92 ----------
  93
  94 * List of fixed `Bugs (56)
  95   <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>`_.
  96
  97 Known Issues
  98 ------------
  99
 100 * `Link to Open Bugs
 101   <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>`_
 102
 103 End-of-life
 104 ===========
 105
 106 * This release has not introduced any new deprecation of a major feature or API.
 107   However, there are some minor deprecations such as:
 108
 109   * YangStatementSourceImpl has been deprecated
 110   * YinStatementSourceImpList has been deprecated
 111   * some methods in DataTreeFactory have been deprecated
 112
 113 Standards
 114 =========
 115
 116 * YANG parser processing according to
 117   `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
 118   `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
 119
 120 Release Mechanics
 121 =================
 122
 123 * `Link to the release plan <https://wiki.opendaylight.org/view/YANG_Tools:Carbon:Release_Plan>`_