diff options
| author | Tobias Hunger <tobias.hunger@qt.io> | 2016-09-09 08:01:45 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-09-26 18:23:53 (GMT) |
| commit | 82104cc7a8e831ad20cb87d126c2ff00a851bedc (patch) | |
| tree | 79f319287f1f7370676cc69f0280e68fd46e42c1 /Help | |
| parent | 1a5fddfe6d56733528ace3d15899b0739ea28054 (diff) | |
| download | CMake-82104cc7a8e831ad20cb87d126c2ff00a851bedc.zip CMake-82104cc7a8e831ad20cb87d126c2ff00a851bedc.tar.gz CMake-82104cc7a8e831ad20cb87d126c2ff00a851bedc.tar.bz2 | |
server-mode: Query global configuration of cmake via a command
Add "globalSettings" command that returns:
* Return capability information
* Return currently used generator/extra generator
* Return a range of flags for debug/trace/etc.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-server.7.rst | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst index 61d6896..ba28e12 100644 --- a/Help/manual/cmake-server.7.rst +++ b/Help/manual/cmake-server.7.rst @@ -248,3 +248,57 @@ which will result in a response type "reply":: ]== CMake Server ==] indicating that the server is ready for action. + + +Type "globalSettings" +^^^^^^^^^^^^^^^^^^^^^ + +This request can be sent after the initial handshake. It will return a +JSON structure with information on cmake state. + +Example:: + + [== CMake Server ==[ + {"type":"globalSettings"} + ]== CMake Server ==] + +which will result in a response type "reply":: + + [== CMake Server ==[ + { + "buildDirectory": "/tmp/test-build", + "capabilities": { + "generators": [ + { + "extraGenerators": [], + "name": "Watcom WMake", + "platformSupport": false, + "toolsetSupport": false + }, + <...> + ], + "serverMode": false, + "version": { + "isDirty": false, + "major": 3, + "minor": 6, + "patch": 20160830, + "string": "3.6.20160830-gd6abad", + "suffix": "gd6abad" + } + }, + "checkSystemVars": false, + "cookie": "", + "extraGenerator": "", + "generator": "Ninja", + "debugOutput": false, + "inReplyTo": "globalSettings", + "sourceDirectory": "/home/code/cmake", + "trace": false, + "traceExpand": false, + "type": "reply", + "warnUninitialized": false, + "warnUnused": false, + "warnUnusedCli": true + } + ]== CMake Server ==] |