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)
commitb8e4e524d32614baecca9aa59924b5bda023b882 (patch)
treeff0fb924c71d20284ca7a43f0a18b494ff96694c /Help
parentff78927e7080482dc42ac5de03d8c1a9cf6928d9 (diff)
parent8f1e607ed9bdab7d7c7cf380113a9bf3339ac3e5 (diff)
downloadCMake-b8e4e524d32614baecca9aa59924b5bda023b882.zip
CMake-b8e4e524d32614baecca9aa59924b5bda023b882.tar.gz
CMake-b8e4e524d32614baecca9aa59924b5bda023b882.tar.bz2
Merge topic 'preset-json-comments'
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