summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorTobias Hunger <tobias.hunger@qt.io>2016-09-09 10:01:46 +0200
committerTobias Hunger <tobias.hunger@qt.io>2016-09-28 18:32:54 +0200
commit84553a6e709ea810f3e7fc5ece5daa1c53be5cda (patch)
tree2b9c3ec68f7581ee046e057c9aefb2dad5a64c92 /Help
parentead71873b2025a28df1208bbd3f2f8e1918a120c (diff)
downloadcmake-84553a6e709ea810f3e7fc5ece5daa1c53be5cda.tar.gz
server-mode: Add command to retrieve build system files
Add a command to retrieve files that are input to cmake itself.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-server.7.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst
index 79b67b012f..76ee3fb914 100644
--- a/Help/manual/cmake-server.7.rst
+++ b/Help/manual/cmake-server.7.rst
@@ -558,3 +558,44 @@ listed by default.
Finally you can limit the target types that are going to be listed. This is
done by providing a list of target types as an array of strings to the
"targetTypes" key.
+
+
+Type "cmakeInputs"
+^^^^^^^^^^^^^^^^^^
+
+The "cmakeInputs" requests will report files used by CMake as part
+of the build system itself.
+
+This request is only available after a project was successfully
+"configure"d.
+
+Example::
+
+ [== CMake Server ==[
+ {"type":"cmakeInputs"}
+ ]== CMake Server ==]
+
+CMake will reply with the following information::
+
+ [== CMake Server ==[
+ {"buildFiles":
+ [
+ {"isCMake":true,"isTemporary":false,"sources":["/usr/lib/cmake/...", ... ]},
+ {"isCMake":false,"isTemporary":false,"sources":["CMakeLists.txt", ...]},
+ {"isCMake":false,"isTemporary":true,"sources":["/tmp/build/CMakeFiles/...", ...]}
+ ],
+ "cmakeRootDirectory":"/usr/lib/cmake",
+ "sourceDirectory":"/home/code/src/cmake",
+ "cookie":"",
+ "inReplyTo":"cmakeInputs",
+ "type":"reply"
+ }
+ ]== CMake Server ==]
+
+All file names are either relative to the top level source directory or
+absolute.
+
+The list of files which "isCMake" set to true are part of the cmake installation.
+
+The list of files witch "isTemporary" set to true are part of the build directory
+and will not survive the build directory getting cleaned out.