summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-11-01 14:37:53 (GMT)
committerBrad King <brad.king@kitware.com>2018-12-12 11:40:10 (GMT)
commitb83fe27d8d3f25ed6e229270966b8323f5fc3ae5 (patch)
treeec345eec5c2d84087dabff361888d463d7ce41d0 /Help
parent7ee0abbde1656b07eb28ddacca3d22bb7aafdbd8 (diff)
downloadCMake-b83fe27d8d3f25ed6e229270966b8323f5fc3ae5.zip
CMake-b83fe27d8d3f25ed6e229270966b8323f5fc3ae5.tar.gz
CMake-b83fe27d8d3f25ed6e229270966b8323f5fc3ae5.tar.bz2
fileapi: Report cmake generator in reply index file
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-file-api.7.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst
index f5e4eeb..a1b4830 100644
--- a/Help/manual/cmake-file-api.7.rst
+++ b/Help/manual/cmake-file-api.7.rst
@@ -197,6 +197,9 @@ The reply index file contains a JSON object:
"ctest": "/prefix/bin/ctest",
"cpack": "/prefix/bin/cpack",
"root": "/prefix/share/cmake-3.14"
+ },
+ "generator": {
+ "name": "Unix Makefiles"
}
},
"objects": [
@@ -260,6 +263,16 @@ The members are:
the absolute path to the directory containing CMake resources like the
``Modules/`` directory (see :variable:`CMAKE_ROOT`).
+ ``generator``
+ A JSON object describing the CMake generator used for the build.
+ It has members:
+
+ ``name``
+ A string specifying the name of the generator.
+ ``platform``
+ If the generator supports :variable:`CMAKE_GENERATOR_PLATFORM`,
+ this is a string specifying the generator platform name.
+
``objects``
A JSON array listing all versions of all `Object Kinds`_ generated
as part of the reply. Each array entry is a