mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-12-30 18:29:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Clarify string(JSON) error handling

Browse Source 
Closes: #21355
This commit is contained in:
Peter Steneteg
2020-10-26 15:15:16 +01:00
committed by Craig Scott
parent 9fa7afe7d3
commit 49fce3373b
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Help/command/string.rst
View File

@@ -491,6 +491,16 @@ JSON
Functionality for querying a JSON string.
.. note::
In each of the following JSON-related subcommands, if the optional
``ERROR_VARIABLE`` argument is given, errors will be reported in
``<error-variable>`` and the ``<out-var>`` will be set to
``<member|index>-[<member|index>...]-NOTFOUND`` with the path elements
up to the point where the error occurred, or just ``NOTFOUND`` if there
is no relevant path. If an error occurs but the ``ERROR_VARIABLE``
option is not present, a fatal error message is generated. If no error
occurs, the ``<error-variable>`` will be set to ``NOTFOUND``.
.. _GET:
.. code-block:: cmake
@@ -563,13 +573,6 @@ The contents of ``<value>`` should be valid JSON.
EQUAL <json-string1> <json-string2>)
Compare the two JSON objects given by ``<json-string1>`` and ``<json-string2>``
for equality
If the optional ``ERROR_VARIABLE`` argument is given, errors will be
reported in ``<error-variable>``. If no error occurs, the ``<error-variable>``
will be set to ``NOTFOUND``. If ``ERROR_VARIABLE`` is not set a CMake error
will be issued.
When an error occurs the ``<out-var>`` will be set to
``<member|index>-[<member|index>...]-NOTFOUND`` with the path elements up to
the point where the error occurred.
for equality. The contents of ``<json-string1>`` and ``<json-string2>``
should be valid JSON. The ``<out-var>`` will be set to a true value if the
JSON objects are considered equal, or a false value otherwise.