summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Hirsch <scivision@users.noreply.gitlab.kitware.com>2021-02-18 16:11:07 (GMT)
committerBrad King <brad.king@kitware.com>2021-02-18 16:47:40 (GMT)
commit8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5 (patch)
tree95c29805df5e86ef48aa0bf3ef9b1e9a5f81a12a
parent94408da2a73a60e0b384c8066ff8200dadaa1bdf (diff)
downloadCMake-8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5.zip
CMake-8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5.tar.gz
CMake-8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5.tar.bz2
Help: Document JSON comment support in cmake-presets(7)
-rw-r--r--Help/manual/cmake-presets.7.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index 49eb157..7d9c8c8 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -29,7 +29,10 @@ is using Git, ``CMakePresets.json`` may be tracked, and
Format
======
-The files are a JSON document with an object as the root:
+The files are JSON documents. C-style comments are allowed using
+line-wise ``//`` syntax or block ``/*...*/`` syntax.
+
+Each document has an object as the root:
.. literalinclude:: presets/example.json
:language: json