diff options
author | Brad King <brad.king@kitware.com> | 2018-11-13 14:34:10 (GMT) |
---|---|---|
committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-12-12 20:12:26 (GMT) |
commit | 4b6b2a571c39439f3b07d56f36e6a927ed6d1dd8 (patch) | |
tree | c0ee27f9e86aea592e750d4004c46f96b44d9df4 /Help/manual/cmake-file-api.7.rst | |
parent | eb8c7676a4723a44245e47630f12d4868e8e182c (diff) | |
download | CMake-4b6b2a571c39439f3b07d56f36e6a927ed6d1dd8.zip CMake-4b6b2a571c39439f3b07d56f36e6a927ed6d1dd8.tar.gz CMake-4b6b2a571c39439f3b07d56f36e6a927ed6d1dd8.tar.bz2 |
fileapi: extend codemodel v2 with directory details
Issue: #18398
Co-Author: Kyle Edwards <kyle.edwards@kitware.com>
Diffstat (limited to 'Help/manual/cmake-file-api.7.rst')
-rw-r--r-- | Help/manual/cmake-file-api.7.rst | 32 |
1 files changed, 30 insertions, 2 deletions
diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst index f35e351..f3e0208 100644 --- a/Help/manual/cmake-file-api.7.rst +++ b/Help/manual/cmake-file-api.7.rst @@ -433,14 +433,21 @@ Version 1 does not exist to avoid confusion with that from "build": ".", "childIndexes": [ 1 ], "projectIndex": 0, - "targetIndexes": [ 0 ] + "targetIndexes": [ 0 ], + "hasInstallRule": true, + "minimumCMakeVersion": { + "string": "3.14" + } }, { "source": "sub", "build": "sub", "parentIndex": 0, "projectIndex": 0, - "targetIndexes": [ 1 ] + "targetIndexes": [ 1 ], + "minimumCMakeVersion": { + "string": "3.14" + } } ], "projects": [ @@ -535,6 +542,27 @@ The members specific to ``codemodel`` objects are: array of entries corresponding to the targets. Each entry is an unsigned integer 0-based index into the main ``targets`` array. + ``minimumCMakeVersion`` + Optional member present when a minimum required version of CMake is + known for the directory. This is the ``<min>`` version given to the + most local call to the :command:`cmake_minimum_required(VERSION)` + command in the directory itself or one of its ancestors. + The value is a JSON object with one member: + + ``string`` + A string specifying the minimum required version in the format:: + + <major>.<minor>[.<patch>[.<tweak>]][<suffix>] + + Each component is an unsigned integer and the suffix may be an + arbitrary string. + + ``hasInstallRule`` + Optional member that is present with boolean value ``true`` when + the directory or one of its subdirectories contains any + :command:`install` rules, i.e. whether a ``make install`` + or equivalent rule is available. + ``projects`` A JSON array of entries corresponding to the top-level project and sub-projects defined in the build system. Each (sub-)project |