Update docs for 2023.09 Potassium
[docs.git] / docs / release-notes / projects / yangtools.rst
index df36a9cd011a1d9c7367dbefd656f344dd00e9bc..2476d747993b0fd9d82a72d7ef13bb7cdf9f4631 100644 (file)
@@ -4,49 +4,30 @@ YANG Tools
 
 Overview
 ========
-
 YANG Tools provides a set of libraries to deal with YANG models and data modeled using them.
 
 Behavior/Feature Changes
 ========================
-YANG parser's memory efficiency has been improved by about 5x on service-provider-grade device
-models. This comes at the cost of removal of ``SchemaNode.getPath()`` method. The returned
-``SchemaPath`` did not correctly provide statement identification anyway, so was of quite limited
-use in general schema navigation. Users relying on it for lookups need to update their algorithm
-to explicitly track schema tree navigation -- using utilities like ``SchemaInferenceStack``,
-``EffectiveStatementInference``, ``DataSchemaContextTree``.
-
-The type mapping of ``type decimal64`` has been changed to a dedicated ``Decimal64`` class, similar
-to ``uint8`` and other built-in YANG types.
+The mapping of YANG augmentations in ``yang-data-api`` has changed. Where previously these have
+been supported by ``AugmetationNode`` and addressable via ``AugmentationIdentifier``, any augmented
+nodes are now direct children of their ``data tree`` parent nodes.
 
-YANG parser will now validate the argument to ``unique`` statement against its surroundings.
-This specifically means that if a ``unique`` statement contains schema node identifiers that do
-not resolve to valid statements, the module will be rejected with a SourceException.
-
-YANG parser will now rejects attempts to import-with-revision a YANG-1.1 module into a YANG-1
-module, as per RFC7950 guidelines.
+``YangTextSchemaSource`` is now a ``CharSource`` rather than a ``ByteSource``. This eliminates ambiguity
+and assumptions made on the text encoding character set, pushing the responsibility down to users
+introducing schema sources into the system.
 
 New Features
 ============
-No new features.
+``yang-maven-plugin`` now executes during incremental builds and does its best to not overwrite
+unchanged outputs.
+
+Removed Features
+================
+``AugmentationNode`` and ``AugmentationIdentifer`` constructs have been removed.
 
 Deprecated Features
 ===================
-Code generation plugin APIs for ``yang-maven-plugin`` contained in the ``yang-maven-plugin-spi``
-artifact are deprecated and will be removed in the next major release. Their replacement live
-in maven-agnostic ``plugin-generator-api``.
-
-The ``SchemaPath`` class has been deprecated and will be removed in the next major release. Please
-use its correct replacements, ``SchemaNodeIdentifier`` and ``EffectiveStatementInference``, which
-provide more powerful capabilities.
-
-The ``CheckedBuilder`` and ``Builder`` concepts have been deprecated and will be removed in the next
-major release. Use of these interfaces makes life difficult when reasoning about callers of a
-particular ``build()`` method.
-
-The ``IllegalArgumentCodec`` concept has been deprecated and will be removed in the next major release.
-Its semantics are quite confusing and it turned out to be hiding more problems than solving. Users
-are advised to define their replacements with semantics appropriate to their use case.
+No deprecated features.
 
 Resolved Issues
 ===============
@@ -54,7 +35,7 @@ The following table lists the issues resolved in this release.
 
 .. jira_fixed_issues::
    :project: YANGTOOLS
-   :versions: 8.0.0-8.0.3
+   :versions: 11.0.0-11.0.0
 
 Known Issues
 ============
@@ -62,20 +43,4 @@ The following table lists the known issues that exist in this release.
 
 .. jira_known_issues::
    :project: YANGTOOLS
-   :versions: 8.0.0-8.0.3
-
-Resolved Issues in SR1
-======================
-The following table lists the issues resolved in Service Release 1.
-
-.. jira_fixed_issues::
-   :project: YANGTOOLS
-   :versions: 8.0.4-8.0.6
-
-Known Issues in SR1
-===================
-The following table lists the known issues that exist in Service Release 1.
-
-.. jira_known_issues::
-   :project: YANGTOOLS
-   :versions: 8.0.4-8.0.6
+   :versions: 11.0.0-11.0.0