summaryrefslogtreecommitdiff
path: root/Help/manual/cmake-server.7.rst
diff options
context:
space:
mode:
authorTobias Hunger <tobias.hunger@qt.io>2016-09-09 10:01:44 +0200
committerTobias Hunger <tobias.hunger@qt.io>2016-09-20 20:52:38 +0200
commit537efe0561ef6a690fd7aac34ce1e4a46614f2e4 (patch)
tree3affd22e6db5f02e4227153adb37b0c626869045 /Help/manual/cmake-server.7.rst
parentca7799482cbbb38b667fd5d045a0fc95d09a8cf2 (diff)
downloadcmake-537efe0561ef6a690fd7aac34ce1e4a46614f2e4.tar.gz
server-mode: Report Messages from cmake to clients
Pass messages sent from cmake via Error(...) or Message(...) on to clients.
Diffstat (limited to 'Help/manual/cmake-server.7.rst')
-rw-r--r--Help/manual/cmake-server.7.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst
index fd0c9ee42c..7edb6d32e3 100644
--- a/Help/manual/cmake-server.7.rst
+++ b/Help/manual/cmake-server.7.rst
@@ -132,6 +132,21 @@ a message of type "reply" or "error" that complete the request.
the request that triggered the responses was delivered.
+Type "message"
+^^^^^^^^^^^^^^
+
+A message is triggered when the server processes a request and produces some
+form of output that should be displayed to the user. A Message has a "message"
+with the actual text to display as well as a "title" with a suggested dialog
+box title.
+
+Example::
+
+ [== CMake Server ==[
+ {"cookie":"","message":"Something happened.","title":"Title Text","inReplyTo":"handshake","type":"message"}
+ ]== CMake Server ==]
+
+
Specific Message Types
----------------------