diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-file-api.7.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-properties.7.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake.1.rst | 16 | ||||
| -rw-r--r-- | Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst | 15 | ||||
| -rw-r--r-- | Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst | 17 | ||||
| -rw-r--r-- | Help/variable/CMAKE_LANG_COMPILER_ID.rst | 1 |
6 files changed, 42 insertions, 11 deletions
diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst index f3e0208..04b6ed2 100644 --- a/Help/manual/cmake-file-api.7.rst +++ b/Help/manual/cmake-file-api.7.rst @@ -379,6 +379,8 @@ finds the file missing, that means a concurrent CMake has generated a new reply. The client may simply start again by reading the new reply index file. +.. _`file-api object kinds`: + Object Kinds ============ diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 25aab8d..77b1ae8 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -62,7 +62,6 @@ Properties on Directories :maxdepth: 1 /prop_dir/ADDITIONAL_CLEAN_FILES - /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES /prop_dir/BINARY_DIR /prop_dir/BUILDSYSTEM_TARGETS /prop_dir/CACHE_VARIABLES @@ -505,6 +504,7 @@ Deprecated Properties on Directories .. toctree:: :maxdepth: 1 + /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES /prop_dir/COMPILE_DEFINITIONS_CONFIG /prop_dir/TEST_INCLUDE_FILE diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index f1d02eb..13cba71 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -423,6 +423,22 @@ Available commands are: A list of strings with all the extra generators compatible with the generator. + ``fileApi`` + Optional member that is present when the :manual:`cmake-file-api(7)` + is available. The value is a JSON object with one member: + + ``requests`` + A JSON array containing zero or more supported file-api requests. + Each request is a JSON object with members: + + ``kind`` + Specifies one of the supported :ref:`file-api object kinds`. + + ``version`` + A JSON array whose elements are each a JSON object containing + ``major`` and ``minor`` members specifying non-negative integer + version components. + ``serverMode`` ``true`` if cmake supports server-mode and ``false`` otherwise. diff --git a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst index 54a78ef..051d22a 100644 --- a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst +++ b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst @@ -1,16 +1,21 @@ ADDITIONAL_CLEAN_FILES ---------------------- -Additional files to remove during the clean stage. +A :ref:`;-list <CMake Language Lists>` of files or directories that will be +removed as a part of the global ``clean`` target. It is useful for +specifying generated files or directories that are used by multiple targets +or by CMake itself, or that are generated in ways which cannot be captured as +outputs or byproducts of custom commands. -A :ref:`;-list <CMake Language Lists>` of files that will be removed as a -part of the ``clean`` target. +If an additional clean file is specific to a single target only, then the +:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better +choice than this directory property. Relative paths are allowed and are interpreted relative to the current binary directory. -Arguments to :prop_dir:`ADDITIONAL_CLEAN_FILES` may use +Contents of ``ADDITIONAL_CLEAN_FILES`` may use :manual:`generator expressions <cmake-generator-expressions(7)>`. This property only works for the :generator:`Ninja` and the Makefile -generators. It is ignored on other generators. +generators. It is ignored by other generators. diff --git a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst index 856bb38..3b9d965 100644 --- a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst +++ b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst @@ -1,16 +1,23 @@ ADDITIONAL_CLEAN_FILES ---------------------- -Additional files to remove during the clean stage. +A :ref:`;-list <CMake Language Lists>` of files or directories that will be +removed as a part of the global ``clean`` target. It can be used to specify +files and directories that are generated as part of building the target or +that are directly associated with the target in some way (e.g. created as a +result of running the target). -A :ref:`;-list <CMake Language Lists>` of files that will be removed as a -part of the ``clean`` target. +For custom targets, if such files can be captured as outputs or byproducts +instead, then that should be preferred over adding them to this property. +If an additional clean file is used by multiple targets or isn't +target-specific, then the :prop_dir:`ADDITIONAL_CLEAN_FILES` directory +property may be the more appropriate property to use. Relative paths are allowed and are interpreted relative to the current binary directory. -Arguments to :prop_tgt:`ADDITIONAL_CLEAN_FILES` may use +Contents of ``ADDITIONAL_CLEAN_FILES`` may use :manual:`generator expressions <cmake-generator-expressions(7)>`. This property only works for the :generator:`Ninja` and the Makefile -generators. It is ignored on other generators. +generators. It is ignored by other generators. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ID.rst b/Help/variable/CMAKE_LANG_COMPILER_ID.rst index 16d97ee..8eb4fb6 100644 --- a/Help/variable/CMAKE_LANG_COMPILER_ID.rst +++ b/Help/variable/CMAKE_LANG_COMPILER_ID.rst @@ -35,6 +35,7 @@ include: TI = Texas Instruments (ti.com) TinyCC = Tiny C Compiler (tinycc.org) XL, VisualAge, zOS = IBM XL (ibm.com) + XLClang = IBM Clang-based XL (ibm.com) This variable is not guaranteed to be defined for all compilers or languages. |