Document XML/JSON parser change

YANGTOOLS-1097 has fixed our parsing compliance, make sure we
mention that in our upgrade guide.

Change-Id: Id8f65d5493d9672b5e583b371e5ebd356ed110c2
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/docs/release-notes/upgrade-process.rst b/docs/release-notes/upgrade-process.rst
index be3366993a7824078da929f6ed3578582a107610..6b5651b54c4a12e01f23085931735b4f9a5a1fbc 100644 (file)
--- a/docs/release-notes/upgrade-process.rst
+++ b/docs/release-notes/upgrade-process.rst
@@ -225,6 +225,31 @@ Java 10 as part of `JEP-286 <https://openjdk.java.net/jeps/286>`__:
    final int size = modules.size();
 
 
+XML and JSON parsers accept only 'true' and 'false' for booleans
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Due to historic implementation reasons, we have accepted various
+capitalizations of ``true`` and ``false`` in ``type boolean`` leaf
+values.
+
+This leniency results in incorrect interpretation of constructs such as
+
+ .. code-block:: none
+
+   leaf foo {
+     type union {
+       type boolean;
+       type string;
+     }
+   }
+
+leading to value being changed when subjected to decode/encode cycle.
+Both codecs have been adjusted to accept only ``true`` and ``false``
+literals.
+
+Further details about this change can be found in the corresponding
+`YANG Tools issue <https://jira.opendaylight.org/browse/YANGTOOLS-1097>`__.
+
+
 MD-SAL Impacts
 --------------