summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorTobias Hunger <tobias.hunger@qt.io>2016-09-09 08:01:46 (GMT)
committerTobias Hunger <tobias.hunger@qt.io>2016-09-29 20:34:10 (GMT)
commit4e34f042504f1c62f36a0f16e137e137a7bf1e72 (patch)
tree6a9079a16e93dd82dce7d04c36d4bb8805546f25 /Help
parent262500028cb5e6c278cbc0f0a2694b50833dc3ec (diff)
downloadCMake-4e34f042504f1c62f36a0f16e137e137a7bf1e72.zip
CMake-4e34f042504f1c62f36a0f16e137e137a7bf1e72.tar.gz
CMake-4e34f042504f1c62f36a0f16e137e137a7bf1e72.tar.bz2
server-mode: Watch CMakeLists.txt files
Watch CMakeLists.txt files (and similar) from the Server
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-server.7.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst
index a97def7..afd4e2b 100644
--- a/Help/manual/cmake-server.7.rst
+++ b/Help/manual/cmake-server.7.rst
@@ -194,6 +194,49 @@ are of type "signal", have an empty "cookie" and "inReplyTo" field and always
have a "name" set to show which signal was sent.
+Specific Signals
+----------------
+
+The cmake server may sent signals with the following names:
+
+"dirty" Signal
+^^^^^^^^^^^^^^
+
+The "dirty" signal is sent whenever the server determines that the configuration
+of the project is no longer up-to-date. This happens when any of the files that have
+an influence on the build system is changed.
+
+The "dirty" signal may look like this::
+
+ [== CMake Server ==[
+ {
+ "cookie":"",
+ "inReplyTo":"",
+ "name":"dirty",
+ "type":"signal"}
+ ]== CMake Server ==]
+
+
+"fileChange" Signal
+^^^^^^^^^^^^^^^^^^^
+
+The "fileChange" signal is sent whenever a watched file is changed. It contains
+the "path" that has changed and a list of "properties" with the kind of change
+that was detected. Possible changes are "change" and "rename".
+
+The "fileChange" signal looks like this::
+
+ [== CMake Server ==[
+ {
+ "cookie":"",
+ "inReplyTo":"",
+ "name":"fileChange",
+ "path":"/absolute/CMakeLists.txt",
+ "properties":["change"],
+ "type":"signal"}
+ ]== CMake Server ==]
+
+
Specific Message Types
----------------------