diff options
| author | Brad King <brad.king@kitware.com> | 2017-06-30 14:32:18 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2017-06-30 14:32:22 (GMT) |
| commit | b6cbbbe129fdbbbb12e7ac39e1589e448fd86031 (patch) | |
| tree | 81233a67f78d58754bd5b337692d6bfc19a8fd74 /Help | |
| parent | 15c5d9a0dd6961f908ffd30bc32471905a3d2bda (diff) | |
| parent | ab533e4851b1a9ac862af353e5013650f35360bf (diff) | |
| download | CMake-b6cbbbe129fdbbbb12e7ac39e1589e448fd86031.zip CMake-b6cbbbe129fdbbbb12e7ac39e1589e448fd86031.tar.gz CMake-b6cbbbe129fdbbbb12e7ac39e1589e448fd86031.tar.bz2 | |
Merge topic 'server-mode-protocol-version-docs'
ab533e48 Help: Document server-mode protocol versions more clearly
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1015
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-server.7.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst index 9520cc1..6a68a1c 100644 --- a/Help/manual/cmake-server.7.rst +++ b/Help/manual/cmake-server.7.rst @@ -254,6 +254,11 @@ versions supported by the cmake server. These are JSON objects with "major" and as experimental. These will contain the "isExperimental" key set to true. Enabling these requires a special command line argument when starting the cmake server mode. +Within a "major" version all "minor" versions are fully backwards compatible. +New "minor" versions may introduce functionality in such a way that existing +clients of the same "major" version will continue to work, provided they +ignore keys in the output that they do not know about. + Example:: [== "CMake Server" ==[ @@ -268,6 +273,9 @@ The first request that the client may send to the server is of type "handshake". This request needs to pass one of the "supportedProtocolVersions" of the "hello" type response received earlier back to the server in the "protocolVersion" field. +Giving the "major" version of the requested protocol version will make the server +use the latest minor version of that protocol. Use this if you do not explicitly +need to depend on a specific minor version. Each protocol version may request additional attributes to be present. |