Help: Fix cmake-server documentation
Some information was not updated to reflect the latest implementation. Reported-by: Sylvain Joubert <joubert.sy@gmail.com>
This commit is contained in:
Tobias Hunger
Brad King
parent
a0c539b546
commit
48189697eb
|
|
@ -250,7 +250,9 @@ This is the only message ever sent by the server that is not of type "reply",
|
||||||
|
|
||||||
It will contain "supportedProtocolVersions" with an array of server protocol
|
It will contain "supportedProtocolVersions" with an array of server protocol
|
||||||
versions supported by the cmake server. These are JSON objects with "major" and
|
versions supported by the cmake server. These are JSON objects with "major" and
|
||||||
"minor" keys containing non-negative integer values.
|
"minor" keys containing non-negative integer values. Some versions may be marked
|
||||||
|
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.
|
||||||
|
|
||||||
Example::
|
Example::
|
||||||
|
|
||||||
|
|
@ -403,7 +405,7 @@ CMake will reply like this (after reporting progress for some time)::
|
||||||
Type "compute"
|
Type "compute"
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
|
||||||
This requist will generate build system files in the build directory and
|
This request will generate build system files in the build directory and
|
||||||
is only available after a project was successfully "configure"d.
|
is only available after a project was successfully "configure"d.
|
||||||
|
|
||||||
Example::
|
Example::
|
||||||
|
|
@ -426,8 +428,19 @@ The "codemodel" request can be used after a project was "compute"d successfully.
|
||||||
|
|
||||||
It will list the complete project structure as it is known to cmake.
|
It will list the complete project structure as it is known to cmake.
|
||||||
|
|
||||||
The reply will contain a key "projects", which will contain a list of
|
The reply will contain a key "configurations", which will contain a list of
|
||||||
project objects, one for each (sub-)project defined in the cmake build system.
|
configuration objects. Configuration objects are used to destinquish between
|
||||||
|
different configurations the build directory might have enabled. While most
|
||||||
|
generators only support one configuration, others might support several.
|
||||||
|
|
||||||
|
Each configuration object can have the following keys:
|
||||||
|
|
||||||
|
"name"
|
||||||
|
contains the name of the configuration. The name may be empty.
|
||||||
|
"projects"
|
||||||
|
contains a list of project objects, one for each build project.
|
||||||
|
|
||||||
|
Project objects define one (sub-)project defined in the cmake build system.
|
||||||
|
|
||||||
Each project object can have the following keys:
|
Each project object can have the following keys:
|
||||||
|
|
||||||
|
|
@ -437,19 +450,8 @@ Each project object can have the following keys:
|
||||||
contains the current source directory
|
contains the current source directory
|
||||||
"buildDirectory"
|
"buildDirectory"
|
||||||
contains the current build directory.
|
contains the current build directory.
|
||||||
"configurations"
|
|
||||||
contains a list of configuration objects.
|
|
||||||
|
|
||||||
Configuration objects are used to destinquish between different
|
|
||||||
configurations the build directory might have enabled. While most generators
|
|
||||||
only support one configuration, others support several.
|
|
||||||
|
|
||||||
Each configuration object can have the following keys:
|
|
||||||
|
|
||||||
"name"
|
|
||||||
contains the name of the configuration. The name may be empty.
|
|
||||||
"targets"
|
"targets"
|
||||||
contains a list of target objects, one for each build target.
|
contains a list of build system target objects.
|
||||||
|
|
||||||
Target objects define individual build targets for a certain configuration.
|
Target objects define individual build targets for a certain configuration.
|
||||||
|
|
||||||
|
|
@ -520,88 +522,53 @@ sourceDirectory of the target.
|
||||||
Example::
|
Example::
|
||||||
|
|
||||||
[== CMake Server ==[
|
[== CMake Server ==[
|
||||||
{"type":"project"}
|
{"type":"codemodel"}
|
||||||
]== CMake Server ==]
|
]== CMake Server ==]
|
||||||
|
|
||||||
CMake will reply::
|
CMake will reply::
|
||||||
|
|
||||||
[== CMake Server ==[
|
[== CMake Server ==[
|
||||||
{
|
{
|
||||||
"cookie":"",
|
"configurations": [
|
||||||
"type":"reply",
|
|
||||||
"inReplyTo":"project",
|
|
||||||
|
|
||||||
"projects":
|
|
||||||
[
|
|
||||||
{
|
{
|
||||||
"name":"CMAKE_FORM",
|
"name": "",
|
||||||
"sourceDirectory":"/home/code/src/cmake/Source/CursesDialog/form"
|
"projects": [
|
||||||
"buildDirectory":"/tmp/cmake-build-test/Source/CursesDialog/form",
|
|
||||||
"configurations":
|
|
||||||
[
|
|
||||||
{
|
{
|
||||||
"name":"",
|
"buildDirectory": "/tmp/build/Source/CursesDialog/form",
|
||||||
"targets":
|
"name": "CMAKE_FORM",
|
||||||
[
|
"sourceDirectory": "/home/code/src/cmake/Source/CursesDialog/form",
|
||||||
|
"targets": [
|
||||||
{
|
{
|
||||||
"artifactDirectory":"/tmp/cmake/Source/CursesDialog/form",
|
"artifacts": [ "/tmp/build/Source/CursesDialog/form/libcmForm.a" ],
|
||||||
"fileGroups":
|
"buildDirectory": "/tmp/build/Source/CursesDialog/form",
|
||||||
[
|
"fileGroups": [
|
||||||
{
|
{
|
||||||
"compileFlags":" -std=gnu11",
|
"compileFlags": " -std=gnu11",
|
||||||
"defines":
|
"defines": [ "CURL_STATICLIB", "LIBARCHIVE_STATIC" ],
|
||||||
[
|
"includePath": [ { "path": "/tmp/build/Utilities" }, <...> ],
|
||||||
"SOMETHING=1",
|
"isGenerated": false,
|
||||||
"LIBARCHIVE_STATIC"
|
"language": "C",
|
||||||
],
|
"sources": [ "fld_arg.c", <...> ]
|
||||||
"includePath":
|
|
||||||
[
|
|
||||||
{ "path":"/tmp/cmake-build-test/Utilities" },
|
|
||||||
{ "isSystem": true, "path":"/usr/include/something" },
|
|
||||||
...
|
|
||||||
]
|
|
||||||
"language":"C",
|
|
||||||
"sources":
|
|
||||||
[
|
|
||||||
"fld_arg.c",
|
|
||||||
...
|
|
||||||
"fty_regex.c"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"fullName":"libcmForm.a",
|
"fullName": "libcmForm.a",
|
||||||
"linkerLanguage":"C",
|
"linkerLanguage": "C",
|
||||||
"name":"cmForm",
|
"name": "cmForm",
|
||||||
"type":"STATIC_LIBRARY"
|
"sourceDirectory": "/home/code/src/cmake/Source/CursesDialog/form",
|
||||||
|
"type": "STATIC_LIBRARY"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
|
||||||
],
|
|
||||||
},
|
},
|
||||||
...
|
<...>
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
],
|
||||||
|
"cookie": "",
|
||||||
|
"inReplyTo": "codemodel",
|
||||||
|
"type": "reply"
|
||||||
|
}
|
||||||
]== CMake Server ==]
|
]== CMake Server ==]
|
||||||
|
|
||||||
The output can be tailored to the specific needs via parameter passed when
|
|
||||||
requesting "project" information.
|
|
||||||
|
|
||||||
You can have a "depth" key, which accepts "project", "configuration" and
|
|
||||||
"target" as string values. These cause the output to be trimmed at the
|
|
||||||
appropriate depth of the output tree.
|
|
||||||
|
|
||||||
You can also set "configurations" to an array of strings with configuration
|
|
||||||
names to list. This will cause any configuration that is not listed to be
|
|
||||||
trimmed from the output.
|
|
||||||
|
|
||||||
Generated files can be included in the listing by setting "includeGeneratedFiles"
|
|
||||||
to "true". This setting defaults to "false", so generated files are not
|
|
||||||
listed by default.
|
|
||||||
|
|
||||||
Finally you can limit the target types that are going to be listed. This is
|
|
||||||
done by providing a list of target types as an array of strings to the
|
|
||||||
"targetTypes" key.
|
|
||||||
|
|
||||||
|
|
||||||
Type "cmakeInputs"
|
Type "cmakeInputs"
|
||||||
^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue