Server-mode: Document protocol version for optional handshake arguments

Document which Protocol version only needs the build directory to be passed
during a handshake.

This is available a bit earlier than that, but from all I can tell 1.2 is
the earliest version where that feature is reliably available.
This commit is contained in:
Tobias Hunger 2018-01-24 17:08:24 +01:00
parent 9b1a3d244b
commit 239a3ef821

View File

@ -277,10 +277,6 @@ Giving the "major" version of the requested protocol version will make the serve
use the latest minor version of that protocol. Use this if you do not explicitly use the latest minor version of that protocol. Use this if you do not explicitly
need to depend on a specific minor version. need to depend on a specific minor version.
If the build directory already contains a CMake cache, it is sufficient to set
the "buildDirectory" attribute. To create a fresh build directory, additional
attributes are required depending on the protocol version.
Protocol version 1.0 requires the following attributes to be set: Protocol version 1.0 requires the following attributes to be set:
* "sourceDirectory" with a path to the sources * "sourceDirectory" with a path to the sources
@ -290,6 +286,10 @@ Protocol version 1.0 requires the following attributes to be set:
* "platform" with the generator platform (if supported by the generator) * "platform" with the generator platform (if supported by the generator)
* "toolset" with the generator toolset (if supported by the generator) * "toolset" with the generator toolset (if supported by the generator)
Protocol version 1.2 makes all but the build directory optional, provided
there is a valid cache in the build directory that contains all the other
information already.
Example:: Example::
[== "CMake Server" ==[ [== "CMake Server" ==[