summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-06-07 14:22:34 (GMT)
committerBrad King <brad.king@kitware.com>2019-06-07 15:08:38 (GMT)
commitc932f498426609beb14b9339c2a7dec3ea624998 (patch)
tree42e9db048344d39a576abe368dd111ba2f4afa4d /Help
parent6696855f72adebbb40d475c39dace1e9f855ca2a (diff)
downloadCMake-c932f498426609beb14b9339c2a7dec3ea624998.zip
CMake-c932f498426609beb14b9339c2a7dec3ea624998.tar.gz
CMake-c932f498426609beb14b9339c2a7dec3ea624998.tar.bz2
cmake: Teach -E capabilities to report supported fileapi requests
Fixes: #19339
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-file-api.7.rst2
-rw-r--r--Help/manual/cmake.1.rst16
2 files changed, 18 insertions, 0 deletions
diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst
index f3e0208..04b6ed2 100644
--- a/Help/manual/cmake-file-api.7.rst
+++ b/Help/manual/cmake-file-api.7.rst
@@ -379,6 +379,8 @@ finds the file missing, that means a concurrent CMake has generated
a new reply. The client may simply start again by reading the new
reply index file.
+.. _`file-api object kinds`:
+
Object Kinds
============
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index f1d02eb..13cba71 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -423,6 +423,22 @@ Available commands are:
A list of strings with all the extra generators compatible with
the generator.
+ ``fileApi``
+ Optional member that is present when the :manual:`cmake-file-api(7)`
+ is available. The value is a JSON object with one member:
+
+ ``requests``
+ A JSON array containing zero or more supported file-api requests.
+ Each request is a JSON object with members:
+
+ ``kind``
+ Specifies one of the supported :ref:`file-api object kinds`.
+
+ ``version``
+ A JSON array whose elements are each a JSON object containing
+ ``major`` and ``minor`` members specifying non-negative integer
+ version components.
+
``serverMode``
``true`` if cmake supports server-mode and ``false`` otherwise.