diff options
| author | Tobias Hunger <tobias.hunger@qt.io> | 2016-09-09 10:01:45 +0200 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-09-26 14:25:20 -0400 |
| commit | 544f65f44de0bb63a0b427150eb5e2bc90f58396 (patch) | |
| tree | 0d5e4fbbd3a13cd1df30c68cf1293bca01801f20 /Help/manual/cmake-server.7.rst | |
| parent | 82104cc7a8e831ad20cb87d126c2ff00a851bedc (diff) | |
| download | cmake-544f65f44de0bb63a0b427150eb5e2bc90f58396.tar.gz | |
server-mode: Set global configuration of cmake via a command
"setGlobalSettings" can be used to change settings reported by
"globalSettings" command.
Diffstat (limited to 'Help/manual/cmake-server.7.rst')
| -rw-r--r-- | Help/manual/cmake-server.7.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst index ba28e12327..cdd87d1c41 100644 --- a/Help/manual/cmake-server.7.rst +++ b/Help/manual/cmake-server.7.rst @@ -302,3 +302,29 @@ which will result in a response type "reply":: "warnUnusedCli": true } ]== CMake Server ==] + + +Type "setGlobalSettings" +^^^^^^^^^^^^^^^^^^^^^^^^ + +This request can be sent to change the global settings attributes. Unknown +attributes are going to be ignored. Read-only attributes reported by +"globalSettings" are all capabilities, buildDirectory, generator, +extraGenerator and sourceDirectory. Any attempt to set these will be ignored, +too. + +All other settings will be changed. + +The server will respond with an empty reply message or an error. + +Example:: + + [== CMake Server ==[ + {"type":"setGlobalSettings","debugOutput":true} + ]== CMake Server ==] + +CMake will reply to this with:: + + [== CMake Server ==[ + {"inReplyTo":"setGlobalSettings","type":"reply"} + ]== CMake Server ==] |