summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-02-18 19:52:21 (GMT)
committerKitware Robot <kwrobot@kitware.com>2021-02-18 19:52:26 (GMT)
commit98ae005137cb52a01612371f6d16e456aa1342fe (patch)
tree76c43179bcbe9e58959de86974b04e06160575d2 /Help
parentaf91c602fea3d6eedf1d92f94079b8ddce950840 (diff)
parent8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5 (diff)
downloadCMake-98ae005137cb52a01612371f6d16e456aa1342fe.zip
CMake-98ae005137cb52a01612371f6d16e456aa1342fe.tar.gz
CMake-98ae005137cb52a01612371f6d16e456aa1342fe.tar.bz2
Merge topic 'preset-json-comments' into release-3.20
8f1e607ed9 Help: Document JSON comment support in cmake-presets(7) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5830
Diffstat (limited to 'Help')
-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 e3815b6..ac3ecf5 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