Update docs for 2023.09 Potassium
[docs.git] / docs / release-notes / projects / yangtools.rst
index d5642d1c1583ee5ea7a5c739011eb33d9a3c1c6f..2476d747993b0fd9d82a72d7ef13bb7cdf9f4631 100644 (file)
@@ -8,35 +8,26 @@ YANG Tools provides a set of libraries to deal with YANG models and data modeled
 
 Behavior/Feature Changes
 ========================
-``ImmutableOffsetMap`` and ``SingletonSet`` classes now use the Serialization Proxy Pattern,
-improving their serialization footprint.
+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.
 
-A large number of abstract classes and interfaces not intended to be directly subclasses/implemented
-are now ``sealed``. This results in better API definitions and provides a clearer guidance to users.
-This change also means these can no longer be mocked through Mockito and similar frameworks. Users
-are advised to use concrete implementations instead.
+``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
 ============
-YANG Parser now supports the ``module-tag`` as defined in `RFC819 <https://www.rfc-editor.org/rfc/rfc8819.html>`__.
+``yang-maven-plugin`` now executes during incremental builds and does its best to not overwrite
+unchanged outputs.
 
 Removed Features
 ================
-The ``CheckedBuilder`` and ``Builder`` concepts have been removed in this release.
-
-The ``IllegalArgumentCodec`` concept has been removed in this release.
-
-The support for resolving inter-module dependencies based on semantic version has been removed.
+``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.
+No deprecated features.
 
 Resolved Issues
 ===============
@@ -44,7 +35,7 @@ The following table lists the issues resolved in this release.
 
 .. jira_fixed_issues::
    :project: YANGTOOLS
-   :versions: 9.0.0-9.0.1
+   :versions: 11.0.0-11.0.0
 
 Known Issues
 ============
@@ -52,20 +43,4 @@ The following table lists the known issues that exist in this release.
 
 .. jira_known_issues::
    :project: YANGTOOLS
-   :versions: 9.0.0-9.0.1
-
-Resolved Issues in SR1
-======================
-The following table lists the issues resolved in Service Release 1.
-
-.. jira_fixed_issues::
-   :project: YANGTOOLS
-   :versions: 9.0.2-9.0.2
-
-Known Issues in SR1
-===================
-The following table lists the known issues that exist in Service Release 1.
-
-.. jira_known_issues::
-   :project: YANGTOOLS
-   :versions: 9.0.2-9.0.2
+   :versions: 11.0.0-11.0.0