Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/DEVICE_LINK_OPTIONS.txt +12 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/OPTIONS_SHELL.txt +15 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_compile_options.rst +67 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_custom_command.rst +699 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_custom_target.rst +211 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_dependencies.rst +42 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/build_command.rst +51 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_host_system_information.rst +403 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/configure_file.rst +203 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/continue.rst +16 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_coverage.rst +50 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_empty_binary_directory.rst +12 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_memcheck.rst +45 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_read_custom_files.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_sleep.rst +16 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_test.rst +329 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_update.rst +43 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_upload.rst +26 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/enable_testing.rst +20 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endfunction.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_file.rst +48 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/include.rst +25 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/install_programs.rst +36 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/link_libraries.rst +19 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/load_cache.rst +26 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/project.rst +202 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/remove_definitions.rst +11 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_source_files_properties.rst +48 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_compile_features.rst +49 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_link_options.rst +68 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/try_compile.rst +405 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/unset.rst +41 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/write_file.rst +22 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_chunk_grad_outputs_efficient_attention_ops.h +28 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_copy_from_and_resize_ops.h +39 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_dirichlet_grad_cuda_dispatch.h +23 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_embedding_bag_ops.h +39 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_fake_quantize_learnable_per_tensor_affine.h +39 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_foreach_tanh_ops.h +50 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_fused_moving_avg_obs_fq_helper_cuda_dispatch.h +23 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_has_compatible_shallow_copy_type_native.h +21 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_indices_copy_compositeexplicitautogradnonfunctional_dispatch.h +23 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_linalg_slogdet_cuda_dispatch.h +25 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_masked_softmax_backward_ops.h +39 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_prelu_kernel_backward_cuda_dispatch.h +23 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_sparse_coo_tensor_with_dims_and_tensors_meta_dispatch.h +26 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_upsample_bilinear2d_aa_meta_dispatch.h +28 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_upsample_nearest_exact1d.h +113 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/adaptive_max_pool3d_backward_cpu_dispatch.h +25 -0
- wemm/lib/python3.10/site-packages/torch/include/ATen/ops/arccosh_native.h +23 -0
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/DEVICE_LINK_OPTIONS.txt
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Host And Device Specific Link Options
|
| 2 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.18
|
| 5 |
+
When a device link step is involved, which is controlled by
|
| 6 |
+
:prop_tgt:`CUDA_SEPARABLE_COMPILATION` and
|
| 7 |
+
:prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` properties and policy :policy:`CMP0105`,
|
| 8 |
+
the raw options will be delivered to the host and device link steps (wrapped in
|
| 9 |
+
``-Xcompiler`` or equivalent for device link). Options wrapped with
|
| 10 |
+
:genex:`$<DEVICE_LINK:...>` generator expression will be used
|
| 11 |
+
only for the device link step. Options wrapped with :genex:`$<HOST_LINK:...>`
|
| 12 |
+
generator expression will be used only for the host link step.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/OPTIONS_SHELL.txt
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Option De-duplication
|
| 2 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 3 |
+
|
| 4 |
+
The final set of options used for a target is constructed by
|
| 5 |
+
accumulating options from the current target and the usage requirements of
|
| 6 |
+
its dependencies. The set of options is de-duplicated to avoid repetition.
|
| 7 |
+
|
| 8 |
+
.. versionadded:: 3.12
|
| 9 |
+
While beneficial for individual options, the de-duplication step can break
|
| 10 |
+
up option groups. For example, ``-option A -option B`` becomes
|
| 11 |
+
``-option A B``. One may specify a group of options using shell-like
|
| 12 |
+
quoting along with a ``SHELL:`` prefix. The ``SHELL:`` prefix is dropped,
|
| 13 |
+
and the rest of the option string is parsed using the
|
| 14 |
+
:command:`separate_arguments` ``UNIX_COMMAND`` mode. For example,
|
| 15 |
+
``"SHELL:-option A" "SHELL:-option B"`` becomes ``-option A -option B``.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_compile_options.rst
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_compile_options
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
Add options to the compilation of source files.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
add_compile_options(<option> ...)
|
| 9 |
+
|
| 10 |
+
Adds options to the :prop_dir:`COMPILE_OPTIONS` directory property.
|
| 11 |
+
These options are used when compiling targets from the current
|
| 12 |
+
directory and below.
|
| 13 |
+
|
| 14 |
+
.. note::
|
| 15 |
+
|
| 16 |
+
These options are not used when linking.
|
| 17 |
+
See the :command:`add_link_options` command for that.
|
| 18 |
+
|
| 19 |
+
Arguments
|
| 20 |
+
^^^^^^^^^
|
| 21 |
+
|
| 22 |
+
.. |command_name| replace:: ``add_compile_options``
|
| 23 |
+
.. include:: GENEX_NOTE.txt
|
| 24 |
+
|
| 25 |
+
.. include:: OPTIONS_SHELL.txt
|
| 26 |
+
|
| 27 |
+
Example
|
| 28 |
+
^^^^^^^
|
| 29 |
+
|
| 30 |
+
Since different compilers support different options, a typical use of
|
| 31 |
+
this command is in a compiler-specific conditional clause:
|
| 32 |
+
|
| 33 |
+
.. code-block:: cmake
|
| 34 |
+
|
| 35 |
+
if (MSVC)
|
| 36 |
+
# warning level 4
|
| 37 |
+
add_compile_options(/W4)
|
| 38 |
+
else()
|
| 39 |
+
# additional warnings
|
| 40 |
+
add_compile_options(-Wall -Wextra -Wpedantic)
|
| 41 |
+
endif()
|
| 42 |
+
|
| 43 |
+
To set per-language options, use the :genex:`$<COMPILE_LANGUAGE>`
|
| 44 |
+
or :genex:`$<COMPILE_LANGUAGE:languages>` generator expressions.
|
| 45 |
+
|
| 46 |
+
See Also
|
| 47 |
+
^^^^^^^^
|
| 48 |
+
|
| 49 |
+
* This command can be used to add any options. However, for
|
| 50 |
+
adding preprocessor definitions and include directories it is recommended
|
| 51 |
+
to use the more specific commands :command:`add_compile_definitions`
|
| 52 |
+
and :command:`include_directories`.
|
| 53 |
+
|
| 54 |
+
* The command :command:`target_compile_options` adds target-specific options.
|
| 55 |
+
|
| 56 |
+
* This command adds compile options for all languages.
|
| 57 |
+
Use the :genex:`COMPILE_LANGUAGE` generator expression to specify
|
| 58 |
+
per-language compile options.
|
| 59 |
+
|
| 60 |
+
* The source file property :prop_sf:`COMPILE_OPTIONS` adds options to one
|
| 61 |
+
source file.
|
| 62 |
+
|
| 63 |
+
* :command:`add_link_options` adds options for linking.
|
| 64 |
+
|
| 65 |
+
* :variable:`CMAKE_<LANG>_FLAGS` and :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>`
|
| 66 |
+
add language-wide flags passed to all invocations of the compiler.
|
| 67 |
+
This includes invocations that drive compiling and those that drive linking.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_custom_command.rst
ADDED
|
@@ -0,0 +1,699 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_custom_command
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
Add a custom build rule to the generated build system.
|
| 5 |
+
|
| 6 |
+
There are two main signatures for ``add_custom_command``.
|
| 7 |
+
|
| 8 |
+
.. _`add_custom_command(OUTPUT)`:
|
| 9 |
+
|
| 10 |
+
Generating Files
|
| 11 |
+
^^^^^^^^^^^^^^^^
|
| 12 |
+
|
| 13 |
+
The first signature is for adding a custom command to produce an output:
|
| 14 |
+
|
| 15 |
+
.. code-block:: cmake
|
| 16 |
+
|
| 17 |
+
add_custom_command(OUTPUT output1 [output2 ...]
|
| 18 |
+
COMMAND command1 [ARGS] [args1...]
|
| 19 |
+
[COMMAND command2 [ARGS] [args2...] ...]
|
| 20 |
+
[MAIN_DEPENDENCY depend]
|
| 21 |
+
[DEPENDS [depends...]]
|
| 22 |
+
[BYPRODUCTS [files...]]
|
| 23 |
+
[IMPLICIT_DEPENDS <lang1> depend1
|
| 24 |
+
[<lang2> depend2] ...]
|
| 25 |
+
[WORKING_DIRECTORY dir]
|
| 26 |
+
[COMMENT comment]
|
| 27 |
+
[DEPFILE depfile]
|
| 28 |
+
[JOB_POOL job_pool]
|
| 29 |
+
[JOB_SERVER_AWARE <bool>]
|
| 30 |
+
[VERBATIM] [APPEND] [USES_TERMINAL]
|
| 31 |
+
[CODEGEN]
|
| 32 |
+
[COMMAND_EXPAND_LISTS]
|
| 33 |
+
[DEPENDS_EXPLICIT_ONLY])
|
| 34 |
+
|
| 35 |
+
This defines a command to generate specified ``OUTPUT`` file(s).
|
| 36 |
+
A target created in the same directory (``CMakeLists.txt`` file)
|
| 37 |
+
that specifies any output of the custom command as a source file
|
| 38 |
+
is given a rule to generate the file using the command at build time.
|
| 39 |
+
|
| 40 |
+
Do not list the output in more than one independent target that
|
| 41 |
+
may build in parallel or the instances of the rule may conflict.
|
| 42 |
+
Instead, use the :command:`add_custom_target` command to drive the
|
| 43 |
+
command and make the other targets depend on that one. See the
|
| 44 |
+
`Example: Generating Files for Multiple Targets`_ below.
|
| 45 |
+
|
| 46 |
+
The options are:
|
| 47 |
+
|
| 48 |
+
``APPEND``
|
| 49 |
+
Append the ``COMMAND`` and ``DEPENDS`` option values to the custom
|
| 50 |
+
command for the first output specified. There must have already
|
| 51 |
+
been a previous call to this command with the same output.
|
| 52 |
+
|
| 53 |
+
If the previous call specified the output via a generator expression,
|
| 54 |
+
the output specified by the current call must match in at least one
|
| 55 |
+
configuration after evaluating generator expressions. In this case,
|
| 56 |
+
the appended commands and dependencies apply to all configurations.
|
| 57 |
+
|
| 58 |
+
The ``COMMENT``, ``MAIN_DEPENDENCY``, and ``WORKING_DIRECTORY``
|
| 59 |
+
options are currently ignored when ``APPEND`` is given, but may be
|
| 60 |
+
used in the future.
|
| 61 |
+
|
| 62 |
+
``BYPRODUCTS``
|
| 63 |
+
.. versionadded:: 3.2
|
| 64 |
+
|
| 65 |
+
Specify the files the command is expected to produce but whose
|
| 66 |
+
modification time may or may not be newer than the dependencies.
|
| 67 |
+
If a byproduct name is a relative path it will be interpreted
|
| 68 |
+
relative to the build tree directory corresponding to the
|
| 69 |
+
current source directory.
|
| 70 |
+
Each byproduct file will be marked with the :prop_sf:`GENERATED`
|
| 71 |
+
source file property automatically.
|
| 72 |
+
|
| 73 |
+
*See policy* :policy:`CMP0058` *for the motivation behind this feature.*
|
| 74 |
+
|
| 75 |
+
Explicit specification of byproducts is supported by the
|
| 76 |
+
:generator:`Ninja` generator to tell the ``ninja`` build tool
|
| 77 |
+
how to regenerate byproducts when they are missing. It is
|
| 78 |
+
also useful when other build rules (e.g. custom commands)
|
| 79 |
+
depend on the byproducts. Ninja requires a build rule for any
|
| 80 |
+
generated file on which another rule depends even if there are
|
| 81 |
+
order-only dependencies to ensure the byproducts will be
|
| 82 |
+
available before their dependents build.
|
| 83 |
+
|
| 84 |
+
The :ref:`Makefile Generators` will remove ``BYPRODUCTS`` and other
|
| 85 |
+
:prop_sf:`GENERATED` files during ``make clean``.
|
| 86 |
+
|
| 87 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 88 |
+
All byproducts must be set in the first call to
|
| 89 |
+
``add_custom_command(OUTPUT...)`` for the output files.
|
| 90 |
+
|
| 91 |
+
.. versionadded:: 3.20
|
| 92 |
+
Arguments to ``BYPRODUCTS`` may use a restricted set of
|
| 93 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 94 |
+
:ref:`Target-dependent expressions <Target-Dependent Expressions>`
|
| 95 |
+
are not permitted.
|
| 96 |
+
|
| 97 |
+
.. versionchanged:: 3.28
|
| 98 |
+
In targets using :ref:`file sets`, custom command byproducts are now
|
| 99 |
+
considered private unless they are listed in a non-private file set.
|
| 100 |
+
See policy :policy:`CMP0154`.
|
| 101 |
+
|
| 102 |
+
``COMMAND``
|
| 103 |
+
Specify the command-line(s) to execute at build time.
|
| 104 |
+
At least one ``COMMAND`` would normally be given, but certain patterns
|
| 105 |
+
may omit it, such as adding commands in separate calls using `APPEND`.
|
| 106 |
+
|
| 107 |
+
If more than one ``COMMAND`` is specified, they will be executed in order,
|
| 108 |
+
but *not* necessarily composed into a stateful shell or batch script.
|
| 109 |
+
To run a full script, use the :command:`configure_file` command or the
|
| 110 |
+
:command:`file(GENERATE)` command to create it, and then specify
|
| 111 |
+
a ``COMMAND`` to launch it.
|
| 112 |
+
|
| 113 |
+
The optional ``ARGS`` argument is for backward compatibility and
|
| 114 |
+
will be ignored.
|
| 115 |
+
|
| 116 |
+
If ``COMMAND`` specifies an executable target name (created by the
|
| 117 |
+
:command:`add_executable` command), it will automatically be replaced
|
| 118 |
+
by the location of the executable created at build time if either of
|
| 119 |
+
the following is true:
|
| 120 |
+
|
| 121 |
+
* The target is not being cross-compiled (i.e. the
|
| 122 |
+
:variable:`CMAKE_CROSSCOMPILING` variable is not set to true).
|
| 123 |
+
* .. versionadded:: 3.6
|
| 124 |
+
The target is being cross-compiled and an emulator is provided (i.e.
|
| 125 |
+
its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set).
|
| 126 |
+
In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be
|
| 127 |
+
prepended to the command before the location of the target executable.
|
| 128 |
+
|
| 129 |
+
If neither of the above conditions are met, it is assumed that the
|
| 130 |
+
command name is a program to be found on the ``PATH`` at build time.
|
| 131 |
+
|
| 132 |
+
Arguments to ``COMMAND`` may use
|
| 133 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 134 |
+
Use the :genex:`TARGET_FILE` generator expression to refer to the location
|
| 135 |
+
of a target later in the command line (i.e. as a command argument rather
|
| 136 |
+
than as the command to execute).
|
| 137 |
+
|
| 138 |
+
Whenever one of the following target based generator expressions are used as
|
| 139 |
+
a command to execute or is mentioned in a command argument, a target-level
|
| 140 |
+
dependency will be added automatically so that the mentioned target will be
|
| 141 |
+
built before any target using this custom command
|
| 142 |
+
(see policy :policy:`CMP0112`).
|
| 143 |
+
|
| 144 |
+
* ``TARGET_FILE``
|
| 145 |
+
* ``TARGET_LINKER_FILE``
|
| 146 |
+
* ``TARGET_SONAME_FILE``
|
| 147 |
+
* ``TARGET_PDB_FILE``
|
| 148 |
+
|
| 149 |
+
This target-level dependency does NOT add a file-level dependency that would
|
| 150 |
+
cause the custom command to re-run whenever the executable is recompiled.
|
| 151 |
+
List target names with the ``DEPENDS`` option to add such file-level
|
| 152 |
+
dependencies.
|
| 153 |
+
|
| 154 |
+
|
| 155 |
+
``COMMENT``
|
| 156 |
+
Display the given message before the commands are executed at
|
| 157 |
+
build time. This will be ignored if ``APPEND`` is given, although a future
|
| 158 |
+
version may use it.
|
| 159 |
+
|
| 160 |
+
.. versionadded:: 3.26
|
| 161 |
+
Arguments to ``COMMENT`` may use
|
| 162 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 163 |
+
|
| 164 |
+
``DEPENDS``
|
| 165 |
+
Specify files on which the command depends. Each argument is converted
|
| 166 |
+
to a dependency as follows:
|
| 167 |
+
|
| 168 |
+
1. If the argument is the name of a target (created by the
|
| 169 |
+
:command:`add_custom_target`, :command:`add_executable`, or
|
| 170 |
+
:command:`add_library` command) a target-level dependency is
|
| 171 |
+
created to make sure the target is built before any target
|
| 172 |
+
using this custom command. Additionally, if the target is an
|
| 173 |
+
executable or library, a file-level dependency is created to
|
| 174 |
+
cause the custom command to re-run whenever the target is
|
| 175 |
+
recompiled.
|
| 176 |
+
|
| 177 |
+
2. If the argument is an absolute path, a file-level dependency
|
| 178 |
+
is created on that path.
|
| 179 |
+
|
| 180 |
+
3. If the argument is the name of a source file that has been
|
| 181 |
+
added to a target or on which a source file property has been set,
|
| 182 |
+
a file-level dependency is created on that source file.
|
| 183 |
+
|
| 184 |
+
4. If the argument is a relative path and it exists in the current
|
| 185 |
+
source directory, a file-level dependency is created on that
|
| 186 |
+
file in the current source directory.
|
| 187 |
+
|
| 188 |
+
5. Otherwise, a file-level dependency is created on that path relative
|
| 189 |
+
to the current binary directory.
|
| 190 |
+
|
| 191 |
+
If any dependency is an ``OUTPUT`` of another custom command in the same
|
| 192 |
+
directory (``CMakeLists.txt`` file), CMake automatically brings the other
|
| 193 |
+
custom command into the target in which this command is built.
|
| 194 |
+
|
| 195 |
+
.. versionadded:: 3.16
|
| 196 |
+
A target-level dependency is added if any dependency is listed as
|
| 197 |
+
``BYPRODUCTS`` of a target or any of its build events in the same
|
| 198 |
+
directory to ensure the byproducts will be available.
|
| 199 |
+
|
| 200 |
+
If ``DEPENDS`` is not specified, the command will run whenever
|
| 201 |
+
the ``OUTPUT`` is missing; if the command does not actually
|
| 202 |
+
create the ``OUTPUT``, the rule will always run.
|
| 203 |
+
|
| 204 |
+
.. versionadded:: 3.1
|
| 205 |
+
Arguments to ``DEPENDS`` may use
|
| 206 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 207 |
+
|
| 208 |
+
``COMMAND_EXPAND_LISTS``
|
| 209 |
+
.. versionadded:: 3.8
|
| 210 |
+
|
| 211 |
+
Lists in ``COMMAND`` arguments will be expanded, including those
|
| 212 |
+
created with
|
| 213 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`,
|
| 214 |
+
allowing ``COMMAND`` arguments such as
|
| 215 |
+
``${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc``
|
| 216 |
+
to be properly expanded.
|
| 217 |
+
|
| 218 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 219 |
+
If the appended commands need this option to be set, it must be set on the
|
| 220 |
+
first call to ``add_custom_command(OUTPUT...)`` for the output files.
|
| 221 |
+
|
| 222 |
+
``CODEGEN``
|
| 223 |
+
.. versionadded:: 3.31
|
| 224 |
+
|
| 225 |
+
Adds the custom command to a global ``codegen`` target that can be
|
| 226 |
+
used to execute the custom command while avoiding the majority of the
|
| 227 |
+
build graph.
|
| 228 |
+
|
| 229 |
+
This option is supported only by :ref:`Ninja Generators` and
|
| 230 |
+
:ref:`Makefile Generators`, and is ignored by other generators.
|
| 231 |
+
Furthermore, this option is allowed only if policy :policy:`CMP0171`
|
| 232 |
+
is set to ``NEW``.
|
| 233 |
+
|
| 234 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 235 |
+
It can only be set on the first call to ``add_custom_command(OUTPUT...)``
|
| 236 |
+
for the output files.
|
| 237 |
+
|
| 238 |
+
``IMPLICIT_DEPENDS``
|
| 239 |
+
Request scanning of implicit dependencies of an input file.
|
| 240 |
+
The language given specifies the programming language whose
|
| 241 |
+
corresponding dependency scanner should be used.
|
| 242 |
+
Currently only ``C`` and ``CXX`` language scanners are supported.
|
| 243 |
+
The language has to be specified for every file in the
|
| 244 |
+
``IMPLICIT_DEPENDS`` list. Dependencies discovered from the
|
| 245 |
+
scanning are added to those of the custom command at build time.
|
| 246 |
+
Note that the ``IMPLICIT_DEPENDS`` option is currently supported
|
| 247 |
+
only for Makefile generators and will be ignored by other generators.
|
| 248 |
+
|
| 249 |
+
.. note::
|
| 250 |
+
|
| 251 |
+
This option cannot be specified at the same time as ``DEPFILE`` option.
|
| 252 |
+
|
| 253 |
+
``JOB_POOL``
|
| 254 |
+
.. versionadded:: 3.15
|
| 255 |
+
|
| 256 |
+
Specify a :prop_gbl:`pool <JOB_POOLS>` for the :generator:`Ninja`
|
| 257 |
+
generator. Incompatible with ``USES_TERMINAL``, which implies
|
| 258 |
+
the ``console`` pool.
|
| 259 |
+
Using a pool that is not defined by :prop_gbl:`JOB_POOLS` causes
|
| 260 |
+
an error by ninja at build time.
|
| 261 |
+
|
| 262 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 263 |
+
Job pools can only be specified in the first call to
|
| 264 |
+
``add_custom_command(OUTPUT...)`` for the output files.
|
| 265 |
+
|
| 266 |
+
``JOB_SERVER_AWARE``
|
| 267 |
+
.. versionadded:: 3.28
|
| 268 |
+
|
| 269 |
+
Specify that the command is GNU Make job server aware.
|
| 270 |
+
|
| 271 |
+
For the :generator:`Unix Makefiles`, :generator:`MSYS Makefiles`, and
|
| 272 |
+
:generator:`MinGW Makefiles` generators this will add the ``+`` prefix to the
|
| 273 |
+
recipe line. See the `GNU Make Documentation`_ for more information.
|
| 274 |
+
|
| 275 |
+
This option is silently ignored by other generators.
|
| 276 |
+
|
| 277 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 278 |
+
Job server awareness can only be specified in the first call to
|
| 279 |
+
``add_custom_command(OUTPUT...)`` for the output files.
|
| 280 |
+
|
| 281 |
+
.. _`GNU Make Documentation`: https://www.gnu.org/software/make/manual/html_node/MAKE-Variable.html
|
| 282 |
+
|
| 283 |
+
``MAIN_DEPENDENCY``
|
| 284 |
+
Specify the primary input source file to the command. This is
|
| 285 |
+
treated just like any value given to the ``DEPENDS`` option
|
| 286 |
+
but also suggests to Visual Studio generators where to hang
|
| 287 |
+
the custom command. Each source file may have at most one command
|
| 288 |
+
specifying it as its main dependency. A compile command (i.e. for a
|
| 289 |
+
library or an executable) counts as an implicit main dependency which
|
| 290 |
+
gets silently overwritten by a custom command specification.
|
| 291 |
+
|
| 292 |
+
This option is currently ignored if ``APPEND`` is given, but a future
|
| 293 |
+
version may use it.
|
| 294 |
+
|
| 295 |
+
``OUTPUT``
|
| 296 |
+
Specify the output files the command is expected to produce.
|
| 297 |
+
Each output file will be marked with the :prop_sf:`GENERATED`
|
| 298 |
+
source file property automatically.
|
| 299 |
+
If the output of the custom command is not actually created
|
| 300 |
+
as a file on disk it should be marked with the :prop_sf:`SYMBOLIC`
|
| 301 |
+
source file property.
|
| 302 |
+
|
| 303 |
+
If an output file name is a relative path, its absolute path is
|
| 304 |
+
determined by interpreting it relative to:
|
| 305 |
+
|
| 306 |
+
1. the build directory corresponding to the current source directory
|
| 307 |
+
(:variable:`CMAKE_CURRENT_BINARY_DIR`), or
|
| 308 |
+
|
| 309 |
+
2. the current source directory (:variable:`CMAKE_CURRENT_SOURCE_DIR`).
|
| 310 |
+
|
| 311 |
+
The path in the build directory is preferred unless the path in the
|
| 312 |
+
source tree is mentioned as an absolute source file path elsewhere
|
| 313 |
+
in the current directory.
|
| 314 |
+
|
| 315 |
+
The output file path may not contain ``<`` or ``>`` characters.
|
| 316 |
+
|
| 317 |
+
.. versionadded:: 3.20
|
| 318 |
+
Arguments to ``OUTPUT`` may use a restricted set of
|
| 319 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 320 |
+
:ref:`Target-dependent expressions <Target-Dependent Expressions>`
|
| 321 |
+
are not permitted.
|
| 322 |
+
|
| 323 |
+
.. versionchanged:: 3.28
|
| 324 |
+
In targets using :ref:`file sets`, custom command outputs are now
|
| 325 |
+
considered private unless they are listed in a non-private file set.
|
| 326 |
+
See policy :policy:`CMP0154`.
|
| 327 |
+
|
| 328 |
+
.. versionchanged:: 3.30
|
| 329 |
+
The output file path may now use ``#`` characters, except
|
| 330 |
+
when using the :generator:`Borland Makefiles` generator.
|
| 331 |
+
|
| 332 |
+
``USES_TERMINAL``
|
| 333 |
+
.. versionadded:: 3.2
|
| 334 |
+
|
| 335 |
+
The command will be given direct access to the terminal if possible.
|
| 336 |
+
With the :generator:`Ninja` generator, this places the command in
|
| 337 |
+
the ``console`` :prop_gbl:`pool <JOB_POOLS>`.
|
| 338 |
+
|
| 339 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 340 |
+
If the appended commands need access to the terminal, it must be set on
|
| 341 |
+
the first call to ``add_custom_command(OUTPUT...)`` for the output files.
|
| 342 |
+
|
| 343 |
+
``VERBATIM``
|
| 344 |
+
All arguments to the commands will be escaped properly for the
|
| 345 |
+
build tool so that the invoked command receives each argument
|
| 346 |
+
unchanged. Note that one level of escapes is still used by the
|
| 347 |
+
CMake language processor before add_custom_command even sees the
|
| 348 |
+
arguments. Use of ``VERBATIM`` is recommended as it enables
|
| 349 |
+
correct behavior. When ``VERBATIM`` is not given the behavior
|
| 350 |
+
is platform specific because there is no protection of
|
| 351 |
+
tool-specific special characters.
|
| 352 |
+
|
| 353 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 354 |
+
If the appended commands need to be treated as ``VERBATIM``, it must be set
|
| 355 |
+
on the first call to ``add_custom_command(OUTPUT...)`` for the output files.
|
| 356 |
+
|
| 357 |
+
``WORKING_DIRECTORY``
|
| 358 |
+
Execute the command with the given current working directory.
|
| 359 |
+
If it is a relative path, it will be interpreted relative to the
|
| 360 |
+
build tree directory corresponding to the current source directory.
|
| 361 |
+
|
| 362 |
+
This option is currently ignored if ``APPEND`` is given, but a future
|
| 363 |
+
version may use it.
|
| 364 |
+
|
| 365 |
+
.. versionadded:: 3.13
|
| 366 |
+
Arguments to ``WORKING_DIRECTORY`` may use
|
| 367 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 368 |
+
|
| 369 |
+
``DEPFILE``
|
| 370 |
+
.. versionadded:: 3.7
|
| 371 |
+
|
| 372 |
+
Specify a depfile which holds dependencies for the custom command. It is
|
| 373 |
+
usually emitted by the custom command itself. This keyword may only be used
|
| 374 |
+
if the generator supports it, as detailed below.
|
| 375 |
+
|
| 376 |
+
The expected format, compatible with what is generated by ``gcc`` with the
|
| 377 |
+
option ``-M``, is independent of the generator or platform.
|
| 378 |
+
|
| 379 |
+
The formal syntax, as specified using
|
| 380 |
+
`BNF <https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form>`_ notation with
|
| 381 |
+
the regular extensions, is the following:
|
| 382 |
+
|
| 383 |
+
.. raw:: latex
|
| 384 |
+
|
| 385 |
+
\begin{small}
|
| 386 |
+
|
| 387 |
+
.. productionlist:: depfile
|
| 388 |
+
depfile: `rule`*
|
| 389 |
+
rule: `targets` (':' (`separator` `dependencies`?)?)? `eol`
|
| 390 |
+
targets: `target` (`separator` `target`)* `separator`*
|
| 391 |
+
target: `pathname`
|
| 392 |
+
dependencies: `dependency` (`separator` `dependency`)* `separator`*
|
| 393 |
+
dependency: `pathname`
|
| 394 |
+
separator: (`space` | `line_continue`)+
|
| 395 |
+
line_continue: '\' `eol`
|
| 396 |
+
space: ' ' | '\t'
|
| 397 |
+
pathname: `character`+
|
| 398 |
+
character: `std_character` | `dollar` | `hash` | `whitespace`
|
| 399 |
+
std_character: <any character except '$', '#' or ' '>
|
| 400 |
+
dollar: '$$'
|
| 401 |
+
hash: '\#'
|
| 402 |
+
whitespace: '\ '
|
| 403 |
+
eol: '\r'? '\n'
|
| 404 |
+
|
| 405 |
+
.. raw:: latex
|
| 406 |
+
|
| 407 |
+
\end{small}
|
| 408 |
+
|
| 409 |
+
.. note::
|
| 410 |
+
|
| 411 |
+
As part of ``pathname``, any slash and backslash is interpreted as
|
| 412 |
+
a directory separator.
|
| 413 |
+
|
| 414 |
+
.. versionadded:: 3.7
|
| 415 |
+
The :generator:`Ninja` generator supports ``DEPFILE`` since the keyword
|
| 416 |
+
was first added.
|
| 417 |
+
|
| 418 |
+
.. versionadded:: 3.17
|
| 419 |
+
Added the :generator:`Ninja Multi-Config` generator, which included
|
| 420 |
+
support for the ``DEPFILE`` keyword.
|
| 421 |
+
|
| 422 |
+
.. versionadded:: 3.20
|
| 423 |
+
Added support for :ref:`Makefile Generators`.
|
| 424 |
+
|
| 425 |
+
.. note::
|
| 426 |
+
|
| 427 |
+
``DEPFILE`` cannot be specified at the same time as the
|
| 428 |
+
``IMPLICIT_DEPENDS`` option for :ref:`Makefile Generators`.
|
| 429 |
+
|
| 430 |
+
.. versionadded:: 3.21
|
| 431 |
+
Added support for :ref:`Visual Studio Generators` with VS 2012 and above,
|
| 432 |
+
and for the :generator:`Xcode` generator. Support for
|
| 433 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>` was also
|
| 434 |
+
added.
|
| 435 |
+
|
| 436 |
+
.. versionadded:: 3.29
|
| 437 |
+
The :ref:`Ninja Generators` will now incorporate the dependencies into its
|
| 438 |
+
"deps log" database if the file is not listed in ``OUTPUTS`` or
|
| 439 |
+
``BYPRODUCTS``.
|
| 440 |
+
|
| 441 |
+
Using ``DEPFILE`` with generators other than those listed above is an error.
|
| 442 |
+
|
| 443 |
+
If the ``DEPFILE`` argument is relative, it should be relative to
|
| 444 |
+
:variable:`CMAKE_CURRENT_BINARY_DIR`, and any relative paths inside the
|
| 445 |
+
``DEPFILE`` should also be relative to :variable:`CMAKE_CURRENT_BINARY_DIR`.
|
| 446 |
+
See policy :policy:`CMP0116`, which is always ``NEW`` for
|
| 447 |
+
:ref:`Makefile Generators`, :ref:`Visual Studio Generators`,
|
| 448 |
+
and the :generator:`Xcode` generator.
|
| 449 |
+
|
| 450 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 451 |
+
Depfiles can only be set on the first call to
|
| 452 |
+
``add_custom_command(OUTPUT...)`` for the output files.
|
| 453 |
+
|
| 454 |
+
``DEPENDS_EXPLICIT_ONLY``
|
| 455 |
+
|
| 456 |
+
.. versionadded:: 3.27
|
| 457 |
+
|
| 458 |
+
Indicates that the command's ``DEPENDS`` argument represents all files
|
| 459 |
+
required by the command and implicit dependencies are not required.
|
| 460 |
+
|
| 461 |
+
Without this option, if any target uses the output of the custom command,
|
| 462 |
+
CMake will consider that target's dependencies as implicit dependencies for
|
| 463 |
+
the custom command in case this custom command requires files implicitly
|
| 464 |
+
created by those targets.
|
| 465 |
+
|
| 466 |
+
This option can be enabled on all custom commands by setting
|
| 467 |
+
:variable:`CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` to ``ON``.
|
| 468 |
+
|
| 469 |
+
This keyword cannot be used with ``APPEND`` (see policy :policy:`CMP0175`).
|
| 470 |
+
It can only be set on the first call to ``add_custom_command(OUTPUT...)``
|
| 471 |
+
for the output files.
|
| 472 |
+
|
| 473 |
+
Only the :ref:`Ninja Generators` actually use this information to remove
|
| 474 |
+
unnecessary implicit dependencies.
|
| 475 |
+
|
| 476 |
+
See also the :prop_tgt:`OPTIMIZE_DEPENDENCIES` target property, which may
|
| 477 |
+
provide another way for reducing the impact of target dependencies in some
|
| 478 |
+
scenarios.
|
| 479 |
+
|
| 480 |
+
Examples: Generating Files
|
| 481 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 482 |
+
|
| 483 |
+
Custom commands may be used to generate source files.
|
| 484 |
+
For example, the code:
|
| 485 |
+
|
| 486 |
+
.. code-block:: cmake
|
| 487 |
+
|
| 488 |
+
add_custom_command(
|
| 489 |
+
OUTPUT out.c
|
| 490 |
+
COMMAND someTool -i ${CMAKE_CURRENT_SOURCE_DIR}/in.txt
|
| 491 |
+
-o out.c
|
| 492 |
+
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/in.txt
|
| 493 |
+
VERBATIM)
|
| 494 |
+
add_library(myLib out.c)
|
| 495 |
+
|
| 496 |
+
adds a custom command to run ``someTool`` to generate ``out.c`` and then
|
| 497 |
+
compile the generated source as part of a library. The generation rule
|
| 498 |
+
will re-run whenever ``in.txt`` changes.
|
| 499 |
+
|
| 500 |
+
.. versionadded:: 3.20
|
| 501 |
+
One may use generator expressions to specify per-configuration outputs.
|
| 502 |
+
For example, the code:
|
| 503 |
+
|
| 504 |
+
.. code-block:: cmake
|
| 505 |
+
|
| 506 |
+
add_custom_command(
|
| 507 |
+
OUTPUT "out-$<CONFIG>.c"
|
| 508 |
+
COMMAND someTool -i ${CMAKE_CURRENT_SOURCE_DIR}/in.txt
|
| 509 |
+
-o "out-$<CONFIG>.c"
|
| 510 |
+
-c "$<CONFIG>"
|
| 511 |
+
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/in.txt
|
| 512 |
+
VERBATIM)
|
| 513 |
+
add_library(myLib "out-$<CONFIG>.c")
|
| 514 |
+
|
| 515 |
+
adds a custom command to run ``someTool`` to generate ``out-<config>.c``,
|
| 516 |
+
where ``<config>`` is the build configuration, and then compile the generated
|
| 517 |
+
source as part of a library.
|
| 518 |
+
|
| 519 |
+
.. versionadded:: 3.31
|
| 520 |
+
Use the ``CODEGEN`` option to add a custom command's outputs to the builtin
|
| 521 |
+
``codegen`` target. This is useful to make generated code available for
|
| 522 |
+
static analysis without building the entire project. For example:
|
| 523 |
+
|
| 524 |
+
.. code-block:: cmake
|
| 525 |
+
|
| 526 |
+
add_executable(someTool someTool.c)
|
| 527 |
+
|
| 528 |
+
add_custom_command(
|
| 529 |
+
OUTPUT out.c
|
| 530 |
+
COMMAND someTool -o out.c
|
| 531 |
+
CODEGEN)
|
| 532 |
+
|
| 533 |
+
add_library(myLib out.c)
|
| 534 |
+
|
| 535 |
+
A user may build the ``codegen`` target to generate ``out.c``.
|
| 536 |
+
``someTool`` is built as dependency, but ``myLib`` is not built at all.
|
| 537 |
+
|
| 538 |
+
Example: Generating Files for Multiple Targets
|
| 539 |
+
""""""""""""""""""""""""""""""""""""""""""""""
|
| 540 |
+
|
| 541 |
+
If multiple independent targets need the same custom command output,
|
| 542 |
+
it must be attached to a single custom target on which they all depend.
|
| 543 |
+
Consider the following example:
|
| 544 |
+
|
| 545 |
+
.. code-block:: cmake
|
| 546 |
+
|
| 547 |
+
add_custom_command(
|
| 548 |
+
OUTPUT table.csv
|
| 549 |
+
COMMAND makeTable -i ${CMAKE_CURRENT_SOURCE_DIR}/input.dat
|
| 550 |
+
-o table.csv
|
| 551 |
+
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/input.dat
|
| 552 |
+
VERBATIM)
|
| 553 |
+
add_custom_target(generate_table_csv DEPENDS table.csv)
|
| 554 |
+
|
| 555 |
+
add_custom_command(
|
| 556 |
+
OUTPUT foo.cxx
|
| 557 |
+
COMMAND genFromTable -i table.csv -case foo -o foo.cxx
|
| 558 |
+
DEPENDS table.csv # file-level dependency
|
| 559 |
+
generate_table_csv # target-level dependency
|
| 560 |
+
VERBATIM)
|
| 561 |
+
add_library(foo foo.cxx)
|
| 562 |
+
|
| 563 |
+
add_custom_command(
|
| 564 |
+
OUTPUT bar.cxx
|
| 565 |
+
COMMAND genFromTable -i table.csv -case bar -o bar.cxx
|
| 566 |
+
DEPENDS table.csv # file-level dependency
|
| 567 |
+
generate_table_csv # target-level dependency
|
| 568 |
+
VERBATIM)
|
| 569 |
+
add_library(bar bar.cxx)
|
| 570 |
+
|
| 571 |
+
Output ``foo.cxx`` is needed only by target ``foo`` and output ``bar.cxx``
|
| 572 |
+
is needed only by target ``bar``, but *both* targets need ``table.csv``,
|
| 573 |
+
transitively. Since ``foo`` and ``bar`` are independent targets that may
|
| 574 |
+
build concurrently, we prevent them from racing to generate ``table.csv``
|
| 575 |
+
by placing its custom command in a separate target, ``generate_table_csv``.
|
| 576 |
+
The custom commands generating ``foo.cxx`` and ``bar.cxx`` each specify a
|
| 577 |
+
target-level dependency on ``generate_table_csv``, so the targets using them,
|
| 578 |
+
``foo`` and ``bar``, will not build until after target ``generate_table_csv``
|
| 579 |
+
is built.
|
| 580 |
+
|
| 581 |
+
.. _`add_custom_command(TARGET)`:
|
| 582 |
+
|
| 583 |
+
Build Events
|
| 584 |
+
^^^^^^^^^^^^
|
| 585 |
+
|
| 586 |
+
The second signature adds a custom command to a target such as a
|
| 587 |
+
library or executable. This is useful for performing an operation
|
| 588 |
+
before or after building the target. The command becomes part of the
|
| 589 |
+
target and will only execute when the target itself is built. If the
|
| 590 |
+
target is already built, the command will not execute.
|
| 591 |
+
|
| 592 |
+
.. code-block:: cmake
|
| 593 |
+
|
| 594 |
+
add_custom_command(TARGET <target>
|
| 595 |
+
PRE_BUILD | PRE_LINK | POST_BUILD
|
| 596 |
+
COMMAND command1 [ARGS] [args1...]
|
| 597 |
+
[COMMAND command2 [ARGS] [args2...] ...]
|
| 598 |
+
[BYPRODUCTS [files...]]
|
| 599 |
+
[WORKING_DIRECTORY dir]
|
| 600 |
+
[COMMENT comment]
|
| 601 |
+
[VERBATIM]
|
| 602 |
+
[COMMAND_EXPAND_LISTS]
|
| 603 |
+
[USES_TERMINAL])
|
| 604 |
+
|
| 605 |
+
This defines a new command that will be associated with building the
|
| 606 |
+
specified ``<target>``. The ``<target>`` must be defined in the current
|
| 607 |
+
directory; targets defined in other directories may not be specified.
|
| 608 |
+
|
| 609 |
+
When the command will happen is determined by which
|
| 610 |
+
of the following is specified:
|
| 611 |
+
|
| 612 |
+
``PRE_BUILD``
|
| 613 |
+
This option has unique behavior for the :ref:`Visual Studio Generators`.
|
| 614 |
+
When using one of the Visual Studio generators, the command will run before
|
| 615 |
+
any other rules are executed within the target. With all other generators,
|
| 616 |
+
this option behaves the same as ``PRE_LINK`` instead. Because of this,
|
| 617 |
+
it is recommended to avoid using ``PRE_BUILD`` except when it is known that
|
| 618 |
+
a Visual Studio generator is being used.
|
| 619 |
+
``PRE_LINK``
|
| 620 |
+
Run after sources have been compiled but before linking the binary
|
| 621 |
+
or running the librarian or archiver tool of a static library.
|
| 622 |
+
This is not defined for targets created by the
|
| 623 |
+
:command:`add_custom_target` command.
|
| 624 |
+
``POST_BUILD``
|
| 625 |
+
Run after all other rules within the target have been executed.
|
| 626 |
+
|
| 627 |
+
Projects should always specify one of the above three keywords when using
|
| 628 |
+
the ``TARGET`` form. See policy :policy:`CMP0175`.
|
| 629 |
+
|
| 630 |
+
All other keywords shown in the signature above have the same meaning as they
|
| 631 |
+
do for the :command:`add_custom_command(OUTPUT)` form of the command.
|
| 632 |
+
At least one ``COMMAND`` must be given, see policy :policy:`CMP0175`.
|
| 633 |
+
|
| 634 |
+
.. note::
|
| 635 |
+
Because generator expressions can be used in custom commands,
|
| 636 |
+
it is possible to define ``COMMAND`` lines or whole custom commands
|
| 637 |
+
which evaluate to empty strings for certain configurations.
|
| 638 |
+
For :ref:`Visual Studio Generators` these command
|
| 639 |
+
lines or custom commands will be omitted for the specific
|
| 640 |
+
configuration and no "empty-string-command" will be added.
|
| 641 |
+
|
| 642 |
+
This allows adding individual build events for every configuration.
|
| 643 |
+
|
| 644 |
+
.. versionadded:: 3.21
|
| 645 |
+
Support for target-dependent generator expressions.
|
| 646 |
+
|
| 647 |
+
.. versionadded:: 3.29
|
| 648 |
+
The ``<target>`` may be an :ref:`ALIAS target <Alias Targets>`.
|
| 649 |
+
|
| 650 |
+
Examples: Build Events
|
| 651 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 652 |
+
|
| 653 |
+
A ``POST_BUILD`` event may be used to post-process a binary after linking.
|
| 654 |
+
For example, the code:
|
| 655 |
+
|
| 656 |
+
.. code-block:: cmake
|
| 657 |
+
|
| 658 |
+
add_executable(myExe myExe.c)
|
| 659 |
+
add_custom_command(
|
| 660 |
+
TARGET myExe POST_BUILD
|
| 661 |
+
COMMAND someHasher -i "$<TARGET_FILE:myExe>"
|
| 662 |
+
-o "$<TARGET_FILE:myExe>.hash"
|
| 663 |
+
VERBATIM)
|
| 664 |
+
|
| 665 |
+
will run ``someHasher`` to produce a ``.hash`` file next to the executable
|
| 666 |
+
after linking.
|
| 667 |
+
|
| 668 |
+
.. versionadded:: 3.20
|
| 669 |
+
One may use generator expressions to specify per-configuration byproducts.
|
| 670 |
+
For example, the code:
|
| 671 |
+
|
| 672 |
+
.. code-block:: cmake
|
| 673 |
+
|
| 674 |
+
add_library(myPlugin MODULE myPlugin.c)
|
| 675 |
+
add_custom_command(
|
| 676 |
+
TARGET myPlugin POST_BUILD
|
| 677 |
+
COMMAND someHasher -i "$<TARGET_FILE:myPlugin>"
|
| 678 |
+
--as-code "myPlugin-hash-$<CONFIG>.c"
|
| 679 |
+
BYPRODUCTS "myPlugin-hash-$<CONFIG>.c"
|
| 680 |
+
VERBATIM)
|
| 681 |
+
add_executable(myExe myExe.c "myPlugin-hash-$<CONFIG>.c")
|
| 682 |
+
|
| 683 |
+
will run ``someHasher`` after linking ``myPlugin``, e.g. to produce a ``.c``
|
| 684 |
+
file containing code to check the hash of ``myPlugin`` that the ``myExe``
|
| 685 |
+
executable can use to verify it before loading.
|
| 686 |
+
|
| 687 |
+
Ninja Multi-Config
|
| 688 |
+
^^^^^^^^^^^^^^^^^^
|
| 689 |
+
|
| 690 |
+
.. versionadded:: 3.20
|
| 691 |
+
|
| 692 |
+
``add_custom_command`` supports the :generator:`Ninja Multi-Config`
|
| 693 |
+
generator's cross-config capabilities. See the generator documentation
|
| 694 |
+
for more information.
|
| 695 |
+
|
| 696 |
+
See Also
|
| 697 |
+
^^^^^^^^
|
| 698 |
+
|
| 699 |
+
* :command:`add_custom_target`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_custom_target.rst
ADDED
|
@@ -0,0 +1,211 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_custom_target
|
| 2 |
+
-----------------
|
| 3 |
+
|
| 4 |
+
Add a target with no output so it will always be built.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
add_custom_target(Name [ALL] [command1 [args1...]]
|
| 9 |
+
[COMMAND command2 [args2...] ...]
|
| 10 |
+
[DEPENDS depend depend depend ... ]
|
| 11 |
+
[BYPRODUCTS [files...]]
|
| 12 |
+
[WORKING_DIRECTORY dir]
|
| 13 |
+
[COMMENT comment]
|
| 14 |
+
[JOB_POOL job_pool]
|
| 15 |
+
[JOB_SERVER_AWARE <bool>]
|
| 16 |
+
[VERBATIM] [USES_TERMINAL]
|
| 17 |
+
[COMMAND_EXPAND_LISTS]
|
| 18 |
+
[SOURCES src1 [src2...]])
|
| 19 |
+
|
| 20 |
+
Adds a target with the given name that executes the given commands.
|
| 21 |
+
The target has no output file and is *always considered out of date*
|
| 22 |
+
even if the commands try to create a file with the name of the target.
|
| 23 |
+
Use the :command:`add_custom_command` command to generate a file with
|
| 24 |
+
dependencies. By default nothing depends on the custom target. Use
|
| 25 |
+
the :command:`add_dependencies` command to add dependencies to or
|
| 26 |
+
from other targets.
|
| 27 |
+
|
| 28 |
+
The options are:
|
| 29 |
+
|
| 30 |
+
``ALL``
|
| 31 |
+
Indicate that this target should be added to the default build
|
| 32 |
+
target so that it will be run every time (the command cannot be
|
| 33 |
+
called ``ALL``).
|
| 34 |
+
|
| 35 |
+
``BYPRODUCTS``
|
| 36 |
+
.. versionadded:: 3.2
|
| 37 |
+
|
| 38 |
+
Specify the files the command is expected to produce but whose
|
| 39 |
+
modification time may or may not be updated on subsequent builds.
|
| 40 |
+
If a byproduct name is a relative path it will be interpreted
|
| 41 |
+
relative to the build tree directory corresponding to the
|
| 42 |
+
current source directory.
|
| 43 |
+
Each byproduct file will be marked with the :prop_sf:`GENERATED`
|
| 44 |
+
source file property automatically.
|
| 45 |
+
|
| 46 |
+
*See policy* :policy:`CMP0058` *for the motivation behind this feature.*
|
| 47 |
+
|
| 48 |
+
Explicit specification of byproducts is supported by the
|
| 49 |
+
:generator:`Ninja` generator to tell the ``ninja`` build tool
|
| 50 |
+
how to regenerate byproducts when they are missing. It is
|
| 51 |
+
also useful when other build rules (e.g. custom commands)
|
| 52 |
+
depend on the byproducts. Ninja requires a build rule for any
|
| 53 |
+
generated file on which another rule depends even if there are
|
| 54 |
+
order-only dependencies to ensure the byproducts will be
|
| 55 |
+
available before their dependents build.
|
| 56 |
+
|
| 57 |
+
The :ref:`Makefile Generators` will remove ``BYPRODUCTS`` and other
|
| 58 |
+
:prop_sf:`GENERATED` files during ``make clean``.
|
| 59 |
+
|
| 60 |
+
.. versionadded:: 3.20
|
| 61 |
+
Arguments to ``BYPRODUCTS`` may use a restricted set of
|
| 62 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 63 |
+
:ref:`Target-dependent expressions <Target-Dependent Expressions>`
|
| 64 |
+
are not permitted.
|
| 65 |
+
|
| 66 |
+
.. versionchanged:: 3.28
|
| 67 |
+
In custom targets using :ref:`file sets`, byproducts are now
|
| 68 |
+
considered private unless they are listed in a non-private file set.
|
| 69 |
+
See policy :policy:`CMP0154`.
|
| 70 |
+
|
| 71 |
+
``COMMAND``
|
| 72 |
+
Specify the command-line(s) to execute at build time.
|
| 73 |
+
If more than one ``COMMAND`` is specified they will be executed in order,
|
| 74 |
+
but *not* necessarily composed into a stateful shell or batch script.
|
| 75 |
+
(To run a full script, use the :command:`configure_file` command or the
|
| 76 |
+
:command:`file(GENERATE)` command to create it, and then specify
|
| 77 |
+
a ``COMMAND`` to launch it.)
|
| 78 |
+
|
| 79 |
+
If ``COMMAND`` specifies an executable target name (created by the
|
| 80 |
+
:command:`add_executable` command), it will automatically be replaced
|
| 81 |
+
by the location of the executable created at build time if either of
|
| 82 |
+
the following is true:
|
| 83 |
+
|
| 84 |
+
* The target is not being cross-compiled (i.e. the
|
| 85 |
+
:variable:`CMAKE_CROSSCOMPILING` variable is not set to true).
|
| 86 |
+
* .. versionadded:: 3.6
|
| 87 |
+
The target is being cross-compiled and an emulator is provided (i.e.
|
| 88 |
+
its :prop_tgt:`CROSSCOMPILING_EMULATOR` target property is set).
|
| 89 |
+
In this case, the contents of :prop_tgt:`CROSSCOMPILING_EMULATOR` will be
|
| 90 |
+
prepended to the command before the location of the target executable.
|
| 91 |
+
|
| 92 |
+
If neither of the above conditions are met, it is assumed that the
|
| 93 |
+
command name is a program to be found on the ``PATH`` at build time.
|
| 94 |
+
|
| 95 |
+
Arguments to ``COMMAND`` may use
|
| 96 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 97 |
+
Use the :genex:`TARGET_FILE` generator expression to refer to the location
|
| 98 |
+
of a target later in the command line (i.e. as a command argument rather
|
| 99 |
+
than as the command to execute).
|
| 100 |
+
|
| 101 |
+
Whenever one of the following target based generator expressions are used as
|
| 102 |
+
a command to execute or is mentioned in a command argument, a target-level
|
| 103 |
+
dependency will be added automatically so that the mentioned target will be
|
| 104 |
+
built before this custom target (see policy :policy:`CMP0112`).
|
| 105 |
+
|
| 106 |
+
* ``TARGET_FILE``
|
| 107 |
+
* ``TARGET_LINKER_FILE``
|
| 108 |
+
* ``TARGET_SONAME_FILE``
|
| 109 |
+
* ``TARGET_PDB_FILE``
|
| 110 |
+
|
| 111 |
+
The command and arguments are optional and if not specified an empty
|
| 112 |
+
target will be created.
|
| 113 |
+
|
| 114 |
+
``COMMENT``
|
| 115 |
+
Display the given message before the commands are executed at
|
| 116 |
+
build time.
|
| 117 |
+
|
| 118 |
+
.. versionadded:: 3.26
|
| 119 |
+
Arguments to ``COMMENT`` may use
|
| 120 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 121 |
+
|
| 122 |
+
``DEPENDS``
|
| 123 |
+
Reference files and outputs of custom commands created with
|
| 124 |
+
:command:`add_custom_command` command calls in the same directory
|
| 125 |
+
(``CMakeLists.txt`` file). They will be brought up to date when
|
| 126 |
+
the target is built.
|
| 127 |
+
|
| 128 |
+
.. versionchanged:: 3.16
|
| 129 |
+
A target-level dependency is added if any dependency is a byproduct
|
| 130 |
+
of a target or any of its build events in the same directory to ensure
|
| 131 |
+
the byproducts will be available before this target is built.
|
| 132 |
+
|
| 133 |
+
Use the :command:`add_dependencies` command to add dependencies
|
| 134 |
+
on other targets.
|
| 135 |
+
|
| 136 |
+
``COMMAND_EXPAND_LISTS``
|
| 137 |
+
.. versionadded:: 3.8
|
| 138 |
+
|
| 139 |
+
Lists in ``COMMAND`` arguments will be expanded, including those
|
| 140 |
+
created with
|
| 141 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`,
|
| 142 |
+
allowing ``COMMAND`` arguments such as
|
| 143 |
+
``${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc``
|
| 144 |
+
to be properly expanded.
|
| 145 |
+
|
| 146 |
+
``JOB_POOL``
|
| 147 |
+
.. versionadded:: 3.15
|
| 148 |
+
|
| 149 |
+
Specify a :prop_gbl:`pool <JOB_POOLS>` for the :generator:`Ninja`
|
| 150 |
+
generator. Incompatible with ``USES_TERMINAL``, which implies
|
| 151 |
+
the ``console`` pool.
|
| 152 |
+
Using a pool that is not defined by :prop_gbl:`JOB_POOLS` causes
|
| 153 |
+
an error by ninja at build time.
|
| 154 |
+
|
| 155 |
+
``JOB_SERVER_AWARE``
|
| 156 |
+
.. versionadded:: 3.28
|
| 157 |
+
|
| 158 |
+
Specify that the command is GNU Make job server aware.
|
| 159 |
+
|
| 160 |
+
For the :generator:`Unix Makefiles`, :generator:`MSYS Makefiles`, and
|
| 161 |
+
:generator:`MinGW Makefiles` generators this will add the ``+`` prefix to the
|
| 162 |
+
recipe line. See the `GNU Make Documentation`_ for more information.
|
| 163 |
+
|
| 164 |
+
This option is silently ignored by other generators.
|
| 165 |
+
|
| 166 |
+
.. _`GNU Make Documentation`: https://www.gnu.org/software/make/manual/html_node/MAKE-Variable.html
|
| 167 |
+
|
| 168 |
+
``SOURCES``
|
| 169 |
+
Specify additional source files to be included in the custom target.
|
| 170 |
+
Specified source files will be added to IDE project files for
|
| 171 |
+
convenience in editing even if they have no build rules.
|
| 172 |
+
|
| 173 |
+
``VERBATIM``
|
| 174 |
+
All arguments to the commands will be escaped properly for the
|
| 175 |
+
build tool so that the invoked command receives each argument
|
| 176 |
+
unchanged. Note that one level of escapes is still used by the
|
| 177 |
+
CMake language processor before ``add_custom_target`` even sees
|
| 178 |
+
the arguments. Use of ``VERBATIM`` is recommended as it enables
|
| 179 |
+
correct behavior. When ``VERBATIM`` is not given the behavior
|
| 180 |
+
is platform specific because there is no protection of
|
| 181 |
+
tool-specific special characters.
|
| 182 |
+
|
| 183 |
+
``USES_TERMINAL``
|
| 184 |
+
.. versionadded:: 3.2
|
| 185 |
+
|
| 186 |
+
The command will be given direct access to the terminal if possible.
|
| 187 |
+
With the :generator:`Ninja` generator, this places the command in
|
| 188 |
+
the ``console`` :prop_gbl:`pool <JOB_POOLS>`.
|
| 189 |
+
|
| 190 |
+
``WORKING_DIRECTORY``
|
| 191 |
+
Execute the command with the given current working directory.
|
| 192 |
+
If it is a relative path it will be interpreted relative to the
|
| 193 |
+
build tree directory corresponding to the current source directory.
|
| 194 |
+
|
| 195 |
+
.. versionadded:: 3.13
|
| 196 |
+
Arguments to ``WORKING_DIRECTORY`` may use
|
| 197 |
+
:manual:`generator expressions <cmake-generator-expressions(7)>`.
|
| 198 |
+
|
| 199 |
+
Ninja Multi-Config
|
| 200 |
+
^^^^^^^^^^^^^^^^^^
|
| 201 |
+
|
| 202 |
+
.. versionadded:: 3.20
|
| 203 |
+
|
| 204 |
+
``add_custom_target`` supports the :generator:`Ninja Multi-Config`
|
| 205 |
+
generator's cross-config capabilities. See the generator documentation
|
| 206 |
+
for more information.
|
| 207 |
+
|
| 208 |
+
See Also
|
| 209 |
+
^^^^^^^^
|
| 210 |
+
|
| 211 |
+
* :command:`add_custom_command`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_dependencies.rst
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_dependencies
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
Add a dependency between top-level targets.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
add_dependencies(<target> [<target-dependency>]...)
|
| 9 |
+
|
| 10 |
+
Makes a top-level ``<target>`` depend on other top-level targets to
|
| 11 |
+
ensure that they build before ``<target>`` does. A top-level target
|
| 12 |
+
is one created by one of the :command:`add_executable`,
|
| 13 |
+
:command:`add_library`, or :command:`add_custom_target` commands
|
| 14 |
+
(but not targets generated by CMake like ``install``).
|
| 15 |
+
|
| 16 |
+
Dependencies added to an :ref:`imported target <Imported Targets>`
|
| 17 |
+
or an :ref:`interface library <Interface Libraries>` are followed
|
| 18 |
+
transitively in its place since the target itself does not build.
|
| 19 |
+
|
| 20 |
+
.. versionadded:: 3.3
|
| 21 |
+
Allow adding dependencies to interface libraries.
|
| 22 |
+
|
| 23 |
+
.. versionadded:: 3.8
|
| 24 |
+
Dependencies will populate the :prop_tgt:`MANUALLY_ADDED_DEPENDENCIES`
|
| 25 |
+
property of ``<target>``.
|
| 26 |
+
|
| 27 |
+
.. versionchanged:: 3.9
|
| 28 |
+
The :ref:`Ninja Generators` use weaker ordering than
|
| 29 |
+
other generators in order to improve available concurrency.
|
| 30 |
+
They only guarantee that the dependencies' custom commands are
|
| 31 |
+
finished before sources in ``<target>`` start compiling; this
|
| 32 |
+
ensures generated sources are available.
|
| 33 |
+
|
| 34 |
+
See Also
|
| 35 |
+
^^^^^^^^
|
| 36 |
+
|
| 37 |
+
* The ``DEPENDS`` option of :command:`add_custom_target` and
|
| 38 |
+
:command:`add_custom_command` commands for adding file-level
|
| 39 |
+
dependencies in custom rules.
|
| 40 |
+
|
| 41 |
+
* The :prop_sf:`OBJECT_DEPENDS` source file property to add
|
| 42 |
+
file-level dependencies to object files.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/build_command.rst
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
build_command
|
| 2 |
+
-------------
|
| 3 |
+
|
| 4 |
+
Get a command line to build the current project.
|
| 5 |
+
This is mainly intended for internal use by the :module:`CTest` module.
|
| 6 |
+
|
| 7 |
+
.. code-block:: cmake
|
| 8 |
+
|
| 9 |
+
build_command(<variable>
|
| 10 |
+
[CONFIGURATION <config>]
|
| 11 |
+
[PARALLEL_LEVEL <parallel>]
|
| 12 |
+
[TARGET <target>]
|
| 13 |
+
[PROJECT_NAME <projname>] # legacy, causes warning
|
| 14 |
+
)
|
| 15 |
+
|
| 16 |
+
Sets the given ``<variable>`` to a command-line string of the form::
|
| 17 |
+
|
| 18 |
+
<cmake> --build . [--config <config>] [--parallel <parallel>] [--target <target>...] [-- -i]
|
| 19 |
+
|
| 20 |
+
where ``<cmake>`` is the location of the :manual:`cmake(1)` command-line
|
| 21 |
+
tool, and ``<config>``, ``<parallel>`` and ``<target>`` are the values
|
| 22 |
+
provided to the ``CONFIGURATION``, ``PARALLEL_LEVEL`` and ``TARGET``
|
| 23 |
+
options, if any. The trailing ``-- -i`` option is added for
|
| 24 |
+
:ref:`Makefile Generators` if policy :policy:`CMP0061` is not set to
|
| 25 |
+
``NEW``.
|
| 26 |
+
|
| 27 |
+
When invoked, this :option:`cmake --build` command line will launch the
|
| 28 |
+
underlying build system tool.
|
| 29 |
+
|
| 30 |
+
.. versionadded:: 3.21
|
| 31 |
+
The ``PARALLEL_LEVEL`` argument can be used to set the
|
| 32 |
+
:option:`--parallel <cmake--build --parallel>` flag.
|
| 33 |
+
|
| 34 |
+
.. code-block:: cmake
|
| 35 |
+
|
| 36 |
+
build_command(<cachevariable> <makecommand>)
|
| 37 |
+
|
| 38 |
+
This second signature is deprecated, but still available for backwards
|
| 39 |
+
compatibility. Use the first signature instead.
|
| 40 |
+
|
| 41 |
+
It sets the given ``<cachevariable>`` to a command-line string as
|
| 42 |
+
above but without the :option:`--target <cmake--build --target>` option.
|
| 43 |
+
The ``<makecommand>`` is ignored but should be the full path to
|
| 44 |
+
devenv, nmake, make or one of the end user build tools
|
| 45 |
+
for legacy invocations.
|
| 46 |
+
|
| 47 |
+
.. note::
|
| 48 |
+
In CMake versions prior to 3.0 this command returned a command
|
| 49 |
+
line that directly invokes the native build tool for the current
|
| 50 |
+
generator. Their implementation of the ``PROJECT_NAME`` option
|
| 51 |
+
had no useful effects, so CMake now warns on use of the option.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_host_system_information.rst
ADDED
|
@@ -0,0 +1,403 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_host_system_information
|
| 2 |
+
-----------------------------
|
| 3 |
+
|
| 4 |
+
Query various host system information.
|
| 5 |
+
|
| 6 |
+
Synopsis
|
| 7 |
+
^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. parsed-literal::
|
| 10 |
+
|
| 11 |
+
`Query host system specific information`_
|
| 12 |
+
cmake_host_system_information(RESULT <variable> QUERY <key> ...)
|
| 13 |
+
|
| 14 |
+
`Query Windows registry`_
|
| 15 |
+
cmake_host_system_information(RESULT <variable> QUERY WINDOWS_REGISTRY <key> ...)
|
| 16 |
+
|
| 17 |
+
Query host system specific information
|
| 18 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 19 |
+
|
| 20 |
+
.. code-block:: cmake
|
| 21 |
+
|
| 22 |
+
cmake_host_system_information(RESULT <variable> QUERY <key> ...)
|
| 23 |
+
|
| 24 |
+
Queries system information of the host system on which cmake runs.
|
| 25 |
+
One or more ``<key>`` can be provided to select the information to be
|
| 26 |
+
queried. The list of queried values is stored in ``<variable>``.
|
| 27 |
+
|
| 28 |
+
``<key>`` can be one of the following values:
|
| 29 |
+
|
| 30 |
+
``NUMBER_OF_LOGICAL_CORES``
|
| 31 |
+
Number of logical cores
|
| 32 |
+
|
| 33 |
+
``NUMBER_OF_PHYSICAL_CORES``
|
| 34 |
+
Number of physical cores
|
| 35 |
+
|
| 36 |
+
``HOSTNAME``
|
| 37 |
+
Hostname
|
| 38 |
+
|
| 39 |
+
``FQDN``
|
| 40 |
+
Fully qualified domain name
|
| 41 |
+
|
| 42 |
+
``TOTAL_VIRTUAL_MEMORY``
|
| 43 |
+
Total virtual memory in MiB [#mebibytes]_
|
| 44 |
+
|
| 45 |
+
``AVAILABLE_VIRTUAL_MEMORY``
|
| 46 |
+
Available virtual memory in MiB [#mebibytes]_
|
| 47 |
+
|
| 48 |
+
``TOTAL_PHYSICAL_MEMORY``
|
| 49 |
+
Total physical memory in MiB [#mebibytes]_
|
| 50 |
+
|
| 51 |
+
``AVAILABLE_PHYSICAL_MEMORY``
|
| 52 |
+
Available physical memory in MiB [#mebibytes]_
|
| 53 |
+
|
| 54 |
+
``IS_64BIT``
|
| 55 |
+
.. versionadded:: 3.10
|
| 56 |
+
|
| 57 |
+
One if processor is 64Bit
|
| 58 |
+
|
| 59 |
+
``HAS_FPU``
|
| 60 |
+
.. versionadded:: 3.10
|
| 61 |
+
|
| 62 |
+
One if processor has floating point unit
|
| 63 |
+
|
| 64 |
+
``HAS_MMX``
|
| 65 |
+
.. versionadded:: 3.10
|
| 66 |
+
|
| 67 |
+
One if processor supports MMX instructions
|
| 68 |
+
|
| 69 |
+
``HAS_MMX_PLUS``
|
| 70 |
+
.. versionadded:: 3.10
|
| 71 |
+
|
| 72 |
+
One if processor supports Ext. MMX instructions
|
| 73 |
+
|
| 74 |
+
``HAS_SSE``
|
| 75 |
+
.. versionadded:: 3.10
|
| 76 |
+
|
| 77 |
+
One if processor supports SSE instructions
|
| 78 |
+
|
| 79 |
+
``HAS_SSE2``
|
| 80 |
+
.. versionadded:: 3.10
|
| 81 |
+
|
| 82 |
+
One if processor supports SSE2 instructions
|
| 83 |
+
|
| 84 |
+
``HAS_SSE_FP``
|
| 85 |
+
.. versionadded:: 3.10
|
| 86 |
+
|
| 87 |
+
One if processor supports SSE FP instructions
|
| 88 |
+
|
| 89 |
+
``HAS_SSE_MMX``
|
| 90 |
+
.. versionadded:: 3.10
|
| 91 |
+
|
| 92 |
+
One if processor supports SSE MMX instructions
|
| 93 |
+
|
| 94 |
+
``HAS_AMD_3DNOW``
|
| 95 |
+
.. versionadded:: 3.10
|
| 96 |
+
|
| 97 |
+
One if processor supports 3DNow instructions
|
| 98 |
+
|
| 99 |
+
``HAS_AMD_3DNOW_PLUS``
|
| 100 |
+
.. versionadded:: 3.10
|
| 101 |
+
|
| 102 |
+
One if processor supports 3DNow+ instructions
|
| 103 |
+
|
| 104 |
+
``HAS_IA64``
|
| 105 |
+
.. versionadded:: 3.10
|
| 106 |
+
|
| 107 |
+
One if IA64 processor emulating x86
|
| 108 |
+
|
| 109 |
+
``HAS_SERIAL_NUMBER``
|
| 110 |
+
.. versionadded:: 3.10
|
| 111 |
+
|
| 112 |
+
One if processor has serial number
|
| 113 |
+
|
| 114 |
+
``PROCESSOR_SERIAL_NUMBER``
|
| 115 |
+
.. versionadded:: 3.10
|
| 116 |
+
|
| 117 |
+
Processor serial number
|
| 118 |
+
|
| 119 |
+
``PROCESSOR_NAME``
|
| 120 |
+
.. versionadded:: 3.10
|
| 121 |
+
|
| 122 |
+
Human readable processor name
|
| 123 |
+
|
| 124 |
+
``PROCESSOR_DESCRIPTION``
|
| 125 |
+
.. versionadded:: 3.10
|
| 126 |
+
|
| 127 |
+
Human readable full processor description
|
| 128 |
+
|
| 129 |
+
``OS_NAME``
|
| 130 |
+
.. versionadded:: 3.10
|
| 131 |
+
|
| 132 |
+
See :variable:`CMAKE_HOST_SYSTEM_NAME`
|
| 133 |
+
|
| 134 |
+
``OS_RELEASE``
|
| 135 |
+
.. versionadded:: 3.10
|
| 136 |
+
|
| 137 |
+
The OS sub-type e.g. on Windows ``Professional``
|
| 138 |
+
|
| 139 |
+
``OS_VERSION``
|
| 140 |
+
.. versionadded:: 3.10
|
| 141 |
+
|
| 142 |
+
The OS build ID
|
| 143 |
+
|
| 144 |
+
``OS_PLATFORM``
|
| 145 |
+
.. versionadded:: 3.10
|
| 146 |
+
|
| 147 |
+
See :variable:`CMAKE_HOST_SYSTEM_PROCESSOR`
|
| 148 |
+
|
| 149 |
+
``MSYSTEM_PREFIX``
|
| 150 |
+
.. versionadded:: 3.28
|
| 151 |
+
|
| 152 |
+
Available only on Windows hosts. In a MSYS or MinGW development
|
| 153 |
+
environment that sets the ``MSYSTEM`` environment variable, this
|
| 154 |
+
is its installation prefix. Otherwise, this is the empty string.
|
| 155 |
+
|
| 156 |
+
``DISTRIB_INFO``
|
| 157 |
+
.. versionadded:: 3.22
|
| 158 |
+
|
| 159 |
+
Read :file:`/etc/os-release` file and define the given ``<variable>``
|
| 160 |
+
into a list of read variables
|
| 161 |
+
|
| 162 |
+
``DISTRIB_<name>``
|
| 163 |
+
.. versionadded:: 3.22
|
| 164 |
+
|
| 165 |
+
Get the ``<name>`` variable (see `man 5 os-release`_) if it exists in the
|
| 166 |
+
:file:`/etc/os-release` file
|
| 167 |
+
|
| 168 |
+
Example:
|
| 169 |
+
|
| 170 |
+
.. code-block:: cmake
|
| 171 |
+
|
| 172 |
+
cmake_host_system_information(RESULT PRETTY_NAME QUERY DISTRIB_PRETTY_NAME)
|
| 173 |
+
message(STATUS "${PRETTY_NAME}")
|
| 174 |
+
|
| 175 |
+
cmake_host_system_information(RESULT DISTRO QUERY DISTRIB_INFO)
|
| 176 |
+
|
| 177 |
+
foreach(VAR IN LISTS DISTRO)
|
| 178 |
+
message(STATUS "${VAR}=`${${VAR}}`")
|
| 179 |
+
endforeach()
|
| 180 |
+
|
| 181 |
+
|
| 182 |
+
Output::
|
| 183 |
+
|
| 184 |
+
-- Ubuntu 20.04.2 LTS
|
| 185 |
+
-- DISTRO_BUG_REPORT_URL=`https://bugs.launchpad.net/ubuntu/`
|
| 186 |
+
-- DISTRO_HOME_URL=`https://www.ubuntu.com/`
|
| 187 |
+
-- DISTRO_ID=`ubuntu`
|
| 188 |
+
-- DISTRO_ID_LIKE=`debian`
|
| 189 |
+
-- DISTRO_NAME=`Ubuntu`
|
| 190 |
+
-- DISTRO_PRETTY_NAME=`Ubuntu 20.04.2 LTS`
|
| 191 |
+
-- DISTRO_PRIVACY_POLICY_URL=`https://www.ubuntu.com/legal/terms-and-policies/privacy-policy`
|
| 192 |
+
-- DISTRO_SUPPORT_URL=`https://help.ubuntu.com/`
|
| 193 |
+
-- DISTRO_UBUNTU_CODENAME=`focal`
|
| 194 |
+
-- DISTRO_VERSION=`20.04.2 LTS (Focal Fossa)`
|
| 195 |
+
-- DISTRO_VERSION_CODENAME=`focal`
|
| 196 |
+
-- DISTRO_VERSION_ID=`20.04`
|
| 197 |
+
|
| 198 |
+
If :file:`/etc/os-release` file is not found, the command tries to gather OS
|
| 199 |
+
identification via fallback scripts. The fallback script can use `various
|
| 200 |
+
distribution-specific files`_ to collect OS identification data and map it
|
| 201 |
+
into `man 5 os-release`_ variables.
|
| 202 |
+
|
| 203 |
+
Fallback Interface Variables
|
| 204 |
+
""""""""""""""""""""""""""""
|
| 205 |
+
|
| 206 |
+
.. variable:: CMAKE_GET_OS_RELEASE_FALLBACK_SCRIPTS
|
| 207 |
+
|
| 208 |
+
In addition to the scripts shipped with CMake, a user may append full
|
| 209 |
+
paths to his script(s) to the this list. The script filename has the
|
| 210 |
+
following format: ``NNN-<name>.cmake``, where ``NNN`` is three digits
|
| 211 |
+
used to apply collected scripts in a specific order.
|
| 212 |
+
|
| 213 |
+
.. variable:: CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_<varname>
|
| 214 |
+
|
| 215 |
+
Variables collected by the user provided fallback script
|
| 216 |
+
ought to be assigned to CMake variables using this naming
|
| 217 |
+
convention. Example, the ``ID`` variable from the manual becomes
|
| 218 |
+
``CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID``.
|
| 219 |
+
|
| 220 |
+
.. variable:: CMAKE_GET_OS_RELEASE_FALLBACK_RESULT
|
| 221 |
+
|
| 222 |
+
The fallback script ought to store names of all assigned
|
| 223 |
+
``CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_<varname>`` variables in this list.
|
| 224 |
+
|
| 225 |
+
Example:
|
| 226 |
+
|
| 227 |
+
.. code-block:: cmake
|
| 228 |
+
|
| 229 |
+
# Try to detect some old distribution
|
| 230 |
+
# See also
|
| 231 |
+
# - http://linuxmafia.com/faq/Admin/release-files.html
|
| 232 |
+
#
|
| 233 |
+
if(NOT EXISTS "${CMAKE_SYSROOT}/etc/foobar-release")
|
| 234 |
+
return()
|
| 235 |
+
endif()
|
| 236 |
+
# Get the first string only
|
| 237 |
+
file(
|
| 238 |
+
STRINGS "${CMAKE_SYSROOT}/etc/foobar-release" CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT
|
| 239 |
+
LIMIT_COUNT 1
|
| 240 |
+
)
|
| 241 |
+
#
|
| 242 |
+
# Example:
|
| 243 |
+
#
|
| 244 |
+
# Foobar distribution release 1.2.3 (server)
|
| 245 |
+
#
|
| 246 |
+
if(CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT MATCHES "Foobar distribution release ([0-9\.]+) .*")
|
| 247 |
+
set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_NAME Foobar)
|
| 248 |
+
set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_PRETTY_NAME "${CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT}")
|
| 249 |
+
set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID foobar)
|
| 250 |
+
set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION ${CMAKE_MATCH_1})
|
| 251 |
+
set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION_ID ${CMAKE_MATCH_1})
|
| 252 |
+
list(
|
| 253 |
+
APPEND CMAKE_GET_OS_RELEASE_FALLBACK_RESULT
|
| 254 |
+
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_NAME
|
| 255 |
+
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_PRETTY_NAME
|
| 256 |
+
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID
|
| 257 |
+
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION
|
| 258 |
+
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION_ID
|
| 259 |
+
)
|
| 260 |
+
endif()
|
| 261 |
+
unset(CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT)
|
| 262 |
+
|
| 263 |
+
|
| 264 |
+
.. rubric:: Footnotes
|
| 265 |
+
|
| 266 |
+
.. [#mebibytes] One MiB (mebibyte) is equal to 1024x1024 bytes.
|
| 267 |
+
|
| 268 |
+
.. _man 5 os-release: https://www.freedesktop.org/software/systemd/man/latest/os-release.html
|
| 269 |
+
.. _various distribution-specific files: http://linuxmafia.com/faq/Admin/release-files.html
|
| 270 |
+
|
| 271 |
+
.. _Query Windows registry:
|
| 272 |
+
|
| 273 |
+
Query Windows registry
|
| 274 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 275 |
+
|
| 276 |
+
.. versionadded:: 3.24
|
| 277 |
+
|
| 278 |
+
::
|
| 279 |
+
|
| 280 |
+
cmake_host_system_information(RESULT <variable>
|
| 281 |
+
QUERY WINDOWS_REGISTRY <key> [VALUE_NAMES|SUBKEYS|VALUE <name>]
|
| 282 |
+
[VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
| 283 |
+
[SEPARATOR <separator>]
|
| 284 |
+
[ERROR_VARIABLE <result>])
|
| 285 |
+
|
| 286 |
+
Performs query operations on local computer registry subkey. Returns a list of
|
| 287 |
+
subkeys or value names that are located under the specified subkey in the
|
| 288 |
+
registry or the data of the specified value name. The result of the queried
|
| 289 |
+
entity is stored in ``<variable>``.
|
| 290 |
+
|
| 291 |
+
.. note::
|
| 292 |
+
|
| 293 |
+
Querying registry for any other platforms than ``Windows``, including
|
| 294 |
+
``CYGWIN``, will always returns an empty string and sets an error message in
|
| 295 |
+
the variable specified with sub-option ``ERROR_VARIABLE``.
|
| 296 |
+
|
| 297 |
+
``<key>`` specify the full path of a subkey on the local computer. The
|
| 298 |
+
``<key>`` must include a valid root key. Valid root keys for the local computer
|
| 299 |
+
are:
|
| 300 |
+
|
| 301 |
+
* ``HKLM`` or ``HKEY_LOCAL_MACHINE``
|
| 302 |
+
* ``HKCU`` or ``HKEY_CURRENT_USER``
|
| 303 |
+
* ``HKCR`` or ``HKEY_CLASSES_ROOT``
|
| 304 |
+
* ``HKU`` or ``HKEY_USERS``
|
| 305 |
+
* ``HKCC`` or ``HKEY_CURRENT_CONFIG``
|
| 306 |
+
|
| 307 |
+
And, optionally, the path to a subkey under the specified root key. The path
|
| 308 |
+
separator can be the slash or the backslash. ``<key>`` is not case sensitive.
|
| 309 |
+
For example:
|
| 310 |
+
|
| 311 |
+
.. code-block:: cmake
|
| 312 |
+
|
| 313 |
+
cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKLM")
|
| 314 |
+
cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware")
|
| 315 |
+
cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKCU\\SOFTWARE\\Kitware")
|
| 316 |
+
|
| 317 |
+
``VALUE_NAMES``
|
| 318 |
+
Request the list of value names defined under ``<key>``. If a default value
|
| 319 |
+
is defined, it will be identified with the special name ``(default)``.
|
| 320 |
+
|
| 321 |
+
``SUBKEYS``
|
| 322 |
+
Request the list of subkeys defined under ``<key>``.
|
| 323 |
+
|
| 324 |
+
``VALUE <name>``
|
| 325 |
+
Request the data stored in value named ``<name>``. If ``VALUE`` is not
|
| 326 |
+
specified or argument is the special name ``(default)``, the content of the
|
| 327 |
+
default value, if any, will be returned.
|
| 328 |
+
|
| 329 |
+
.. code-block:: cmake
|
| 330 |
+
|
| 331 |
+
# query default value for HKLM/SOFTWARE/Kitware key
|
| 332 |
+
cmake_host_system_information(RESULT result
|
| 333 |
+
QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware")
|
| 334 |
+
|
| 335 |
+
# query default value for HKLM/SOFTWARE/Kitware key using special value name
|
| 336 |
+
cmake_host_system_information(RESULT result
|
| 337 |
+
QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware"
|
| 338 |
+
VALUE "(default)")
|
| 339 |
+
|
| 340 |
+
Supported types are:
|
| 341 |
+
|
| 342 |
+
* ``REG_SZ``.
|
| 343 |
+
* ``REG_EXPAND_SZ``. The returned data is expanded.
|
| 344 |
+
* ``REG_MULTI_SZ``. The returned is expressed as a CMake list. See also
|
| 345 |
+
``SEPARATOR`` sub-option.
|
| 346 |
+
* ``REG_DWORD``.
|
| 347 |
+
* ``REG_QWORD``.
|
| 348 |
+
|
| 349 |
+
For all other types, an empty string is returned.
|
| 350 |
+
|
| 351 |
+
``VIEW``
|
| 352 |
+
Specify which registry views must be queried. When not specified, ``BOTH``
|
| 353 |
+
view is used.
|
| 354 |
+
|
| 355 |
+
``64``
|
| 356 |
+
Query the 64bit registry. On ``32bit Windows``, returns always an empty
|
| 357 |
+
string.
|
| 358 |
+
|
| 359 |
+
``32``
|
| 360 |
+
Query the 32bit registry.
|
| 361 |
+
|
| 362 |
+
``64_32``
|
| 363 |
+
For ``VALUE`` sub-option or default value, query the registry using view
|
| 364 |
+
``64``, and if the request failed, query the registry using view ``32``.
|
| 365 |
+
For ``VALUE_NAMES`` and ``SUBKEYS`` sub-options, query both views (``64``
|
| 366 |
+
and ``32``) and merge the results (sorted and duplicates removed).
|
| 367 |
+
|
| 368 |
+
``32_64``
|
| 369 |
+
For ``VALUE`` sub-option or default value, query the registry using view
|
| 370 |
+
``32``, and if the request failed, query the registry using view ``64``.
|
| 371 |
+
For ``VALUE_NAMES`` and ``SUBKEYS`` sub-options, query both views (``32``
|
| 372 |
+
and ``64``) and merge the results (sorted and duplicates removed).
|
| 373 |
+
|
| 374 |
+
``HOST``
|
| 375 |
+
Query the registry matching the architecture of the host: ``64`` on ``64bit
|
| 376 |
+
Windows`` and ``32`` on ``32bit Windows``.
|
| 377 |
+
|
| 378 |
+
``TARGET``
|
| 379 |
+
Query the registry matching the architecture specified by
|
| 380 |
+
:variable:`CMAKE_SIZEOF_VOID_P` variable. If not defined, fallback to
|
| 381 |
+
``HOST`` view.
|
| 382 |
+
|
| 383 |
+
``BOTH``
|
| 384 |
+
Query both views (``32`` and ``64``). The order depends of the following
|
| 385 |
+
rules: If :variable:`CMAKE_SIZEOF_VOID_P` variable is defined. Use the
|
| 386 |
+
following view depending of the content of this variable:
|
| 387 |
+
|
| 388 |
+
* ``8``: ``64_32``
|
| 389 |
+
* ``4``: ``32_64``
|
| 390 |
+
|
| 391 |
+
If :variable:`CMAKE_SIZEOF_VOID_P` variable is not defined, rely on
|
| 392 |
+
architecture of the host:
|
| 393 |
+
|
| 394 |
+
* ``64bit``: ``64_32``
|
| 395 |
+
* ``32bit``: ``32``
|
| 396 |
+
|
| 397 |
+
``SEPARATOR``
|
| 398 |
+
Specify the separator character for ``REG_MULTI_SZ`` type. When not
|
| 399 |
+
specified, the character ``\0`` is used.
|
| 400 |
+
|
| 401 |
+
``ERROR_VARIABLE <result>``
|
| 402 |
+
Returns any error raised during query operation. In case of success, the
|
| 403 |
+
variable holds an empty string.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/configure_file.rst
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
configure_file
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Copy a file to another location and modify its contents.
|
| 9 |
+
|
| 10 |
+
.. code-block:: cmake
|
| 11 |
+
|
| 12 |
+
configure_file(<input> <output>
|
| 13 |
+
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
|
| 14 |
+
FILE_PERMISSIONS <permissions>...]
|
| 15 |
+
[COPYONLY] [ESCAPE_QUOTES] [@ONLY]
|
| 16 |
+
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
|
| 17 |
+
|
| 18 |
+
Copies an ``<input>`` file to an ``<output>`` file while performing
|
| 19 |
+
`transformations`_ of the input file content.
|
| 20 |
+
|
| 21 |
+
If the input file is modified the build system will re-run CMake to
|
| 22 |
+
re-configure the file and generate the build system again.
|
| 23 |
+
The generated file is modified and its timestamp updated on subsequent
|
| 24 |
+
cmake runs only if its content is changed.
|
| 25 |
+
|
| 26 |
+
Options
|
| 27 |
+
^^^^^^^
|
| 28 |
+
|
| 29 |
+
The options are:
|
| 30 |
+
|
| 31 |
+
``<input>``
|
| 32 |
+
Path to the input file. A relative path is treated with respect to
|
| 33 |
+
the value of :variable:`CMAKE_CURRENT_SOURCE_DIR`. The input path
|
| 34 |
+
must be a file, not a directory.
|
| 35 |
+
|
| 36 |
+
``<output>``
|
| 37 |
+
Path to the output file or directory. A relative path is treated
|
| 38 |
+
with respect to the value of :variable:`CMAKE_CURRENT_BINARY_DIR`.
|
| 39 |
+
If the path names an existing directory the output file is placed
|
| 40 |
+
in that directory with the same file name as the input file.
|
| 41 |
+
If the path contains non-existent directories, they are created.
|
| 42 |
+
|
| 43 |
+
``NO_SOURCE_PERMISSIONS``
|
| 44 |
+
.. versionadded:: 3.19
|
| 45 |
+
|
| 46 |
+
Do not transfer the permissions of the input file to the output file.
|
| 47 |
+
The copied file permissions default to the standard 644 value
|
| 48 |
+
(-rw-r--r--).
|
| 49 |
+
|
| 50 |
+
``USE_SOURCE_PERMISSIONS``
|
| 51 |
+
.. versionadded:: 3.20
|
| 52 |
+
|
| 53 |
+
Transfer the permissions of the input file to the output file.
|
| 54 |
+
This is already the default behavior if none of the three permissions-related
|
| 55 |
+
keywords are given (``NO_SOURCE_PERMISSIONS``, ``USE_SOURCE_PERMISSIONS``
|
| 56 |
+
or ``FILE_PERMISSIONS``). The ``USE_SOURCE_PERMISSIONS`` keyword mostly
|
| 57 |
+
serves as a way of making the intended behavior clearer at the call site.
|
| 58 |
+
|
| 59 |
+
``FILE_PERMISSIONS <permissions>...``
|
| 60 |
+
.. versionadded:: 3.20
|
| 61 |
+
|
| 62 |
+
Ignore the input file's permissions and use the specified ``<permissions>``
|
| 63 |
+
for the output file instead.
|
| 64 |
+
|
| 65 |
+
``COPYONLY``
|
| 66 |
+
Copy the file without replacing any variable references or other
|
| 67 |
+
content. This option may not be used with ``NEWLINE_STYLE``.
|
| 68 |
+
|
| 69 |
+
``ESCAPE_QUOTES``
|
| 70 |
+
Escape any substituted quotes with backslashes (C-style).
|
| 71 |
+
|
| 72 |
+
``@ONLY``
|
| 73 |
+
Restrict variable replacement to references of the form ``@VAR@``.
|
| 74 |
+
This is useful for configuring scripts that use ``${VAR}`` syntax.
|
| 75 |
+
|
| 76 |
+
``NEWLINE_STYLE <style>``
|
| 77 |
+
Specify the newline style for the output file. Specify
|
| 78 |
+
``UNIX`` or ``LF`` for ``\n`` newlines, or specify
|
| 79 |
+
``DOS``, ``WIN32``, or ``CRLF`` for ``\r\n`` newlines.
|
| 80 |
+
This option may not be used with ``COPYONLY``.
|
| 81 |
+
|
| 82 |
+
Transformations
|
| 83 |
+
^^^^^^^^^^^^^^^
|
| 84 |
+
|
| 85 |
+
:ref:`Variables <CMake Language Variables>` referenced in the input
|
| 86 |
+
file content as ``@VAR@``, ``${VAR}``, ``$CACHE{VAR}``, and
|
| 87 |
+
:ref:`environment variables <CMake Language Environment Variables>`
|
| 88 |
+
referenced as ``$ENV{VAR}``, will each be replaced with the current value
|
| 89 |
+
of the variable, or the empty string if the variable is not defined.
|
| 90 |
+
Furthermore, input lines of the form
|
| 91 |
+
|
| 92 |
+
.. code-block:: c
|
| 93 |
+
|
| 94 |
+
#cmakedefine VAR ...
|
| 95 |
+
|
| 96 |
+
will be replaced with either
|
| 97 |
+
|
| 98 |
+
.. code-block:: c
|
| 99 |
+
|
| 100 |
+
#define VAR ...
|
| 101 |
+
|
| 102 |
+
or
|
| 103 |
+
|
| 104 |
+
.. code-block:: c
|
| 105 |
+
|
| 106 |
+
/* #undef VAR */
|
| 107 |
+
|
| 108 |
+
depending on whether ``VAR`` is set in CMake to any value not considered
|
| 109 |
+
a false constant by the :command:`if` command. The "..." content on the
|
| 110 |
+
line after the variable name, if any, is processed as above.
|
| 111 |
+
|
| 112 |
+
Unlike lines of the form ``#cmakedefine VAR ...``, in lines of the form
|
| 113 |
+
``#cmakedefine01 VAR``, ``VAR`` itself will expand to ``VAR 0`` or ``VAR 1``
|
| 114 |
+
rather than being assigned the value ``...``. Therefore, input lines of the form
|
| 115 |
+
|
| 116 |
+
.. code-block:: c
|
| 117 |
+
|
| 118 |
+
#cmakedefine01 VAR
|
| 119 |
+
|
| 120 |
+
will be replaced with either
|
| 121 |
+
|
| 122 |
+
.. code-block:: c
|
| 123 |
+
|
| 124 |
+
#define VAR 0
|
| 125 |
+
|
| 126 |
+
or
|
| 127 |
+
|
| 128 |
+
.. code-block:: c
|
| 129 |
+
|
| 130 |
+
#define VAR 1
|
| 131 |
+
|
| 132 |
+
Input lines of the form ``#cmakedefine01 VAR ...`` will expand
|
| 133 |
+
as ``#cmakedefine01 VAR ... 0`` or ``#cmakedefine01 VAR ... 1``,
|
| 134 |
+
which may lead to undefined behavior.
|
| 135 |
+
|
| 136 |
+
.. versionadded:: 3.10
|
| 137 |
+
The result lines (with the exception of the ``#undef`` comments) can be
|
| 138 |
+
indented using spaces and/or tabs between the ``#`` character
|
| 139 |
+
and the ``cmakedefine`` or ``cmakedefine01`` words. This whitespace
|
| 140 |
+
indentation will be preserved in the output lines:
|
| 141 |
+
|
| 142 |
+
.. code-block:: c
|
| 143 |
+
|
| 144 |
+
# cmakedefine VAR
|
| 145 |
+
# cmakedefine01 VAR
|
| 146 |
+
|
| 147 |
+
will be replaced, if ``VAR`` is defined, with
|
| 148 |
+
|
| 149 |
+
.. code-block:: c
|
| 150 |
+
|
| 151 |
+
# define VAR
|
| 152 |
+
# define VAR 1
|
| 153 |
+
|
| 154 |
+
Example
|
| 155 |
+
^^^^^^^
|
| 156 |
+
|
| 157 |
+
Consider a source tree containing a ``foo.h.in`` file:
|
| 158 |
+
|
| 159 |
+
.. code-block:: c
|
| 160 |
+
|
| 161 |
+
#cmakedefine FOO_ENABLE
|
| 162 |
+
#cmakedefine FOO_STRING "@FOO_STRING@"
|
| 163 |
+
|
| 164 |
+
An adjacent ``CMakeLists.txt`` may use ``configure_file`` to
|
| 165 |
+
configure the header:
|
| 166 |
+
|
| 167 |
+
.. code-block:: cmake
|
| 168 |
+
|
| 169 |
+
option(FOO_ENABLE "Enable Foo" ON)
|
| 170 |
+
if(FOO_ENABLE)
|
| 171 |
+
set(FOO_STRING "foo")
|
| 172 |
+
endif()
|
| 173 |
+
configure_file(foo.h.in foo.h @ONLY)
|
| 174 |
+
|
| 175 |
+
This creates a ``foo.h`` in the build directory corresponding to
|
| 176 |
+
this source directory. If the ``FOO_ENABLE`` option is on, the
|
| 177 |
+
configured file will contain:
|
| 178 |
+
|
| 179 |
+
.. code-block:: c
|
| 180 |
+
|
| 181 |
+
#define FOO_ENABLE
|
| 182 |
+
#define FOO_STRING "foo"
|
| 183 |
+
|
| 184 |
+
Otherwise it will contain:
|
| 185 |
+
|
| 186 |
+
.. code-block:: c
|
| 187 |
+
|
| 188 |
+
/* #undef FOO_ENABLE */
|
| 189 |
+
/* #undef FOO_STRING */
|
| 190 |
+
|
| 191 |
+
One may then use the :command:`target_include_directories` command to
|
| 192 |
+
specify the output directory as an include directory:
|
| 193 |
+
|
| 194 |
+
.. code-block:: cmake
|
| 195 |
+
|
| 196 |
+
target_include_directories(<target> [SYSTEM] <INTERFACE|PUBLIC|PRIVATE> "${CMAKE_CURRENT_BINARY_DIR}")
|
| 197 |
+
|
| 198 |
+
so that sources may include the header as ``#include <foo.h>``.
|
| 199 |
+
|
| 200 |
+
See Also
|
| 201 |
+
^^^^^^^^
|
| 202 |
+
|
| 203 |
+
* :command:`file(GENERATE)`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/continue.rst
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
continue
|
| 2 |
+
--------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.2
|
| 5 |
+
|
| 6 |
+
Continue to the top of enclosing foreach or while loop.
|
| 7 |
+
|
| 8 |
+
.. code-block:: cmake
|
| 9 |
+
|
| 10 |
+
continue()
|
| 11 |
+
|
| 12 |
+
The ``continue()`` command allows a cmake script to abort the rest of the
|
| 13 |
+
current iteration of a :command:`foreach` or :command:`while` loop, and start
|
| 14 |
+
at the top of the next iteration.
|
| 15 |
+
|
| 16 |
+
See also the :command:`break` command.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_coverage.rst
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_coverage
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest Coverage Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_coverage([BUILD <build-dir>] [APPEND]
|
| 9 |
+
[LABELS <label>...]
|
| 10 |
+
[RETURN_VALUE <result-var>]
|
| 11 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 12 |
+
[QUIET]
|
| 13 |
+
)
|
| 14 |
+
|
| 15 |
+
Collect coverage tool results and stores them in ``Coverage.xml``
|
| 16 |
+
for submission with the :command:`ctest_submit` command.
|
| 17 |
+
|
| 18 |
+
The options are:
|
| 19 |
+
|
| 20 |
+
``BUILD <build-dir>``
|
| 21 |
+
Specify the top-level build directory. If not given, the
|
| 22 |
+
:variable:`CTEST_BINARY_DIRECTORY` variable is used.
|
| 23 |
+
|
| 24 |
+
``APPEND``
|
| 25 |
+
Mark ``Coverage.xml`` for append to results previously submitted to a
|
| 26 |
+
dashboard server since the last :command:`ctest_start` call.
|
| 27 |
+
Append semantics are defined by the dashboard server in use.
|
| 28 |
+
This does *not* cause results to be appended to a ``.xml`` file
|
| 29 |
+
produced by a previous call to this command.
|
| 30 |
+
|
| 31 |
+
``LABELS``
|
| 32 |
+
Filter the coverage report to include only source files labeled
|
| 33 |
+
with at least one of the labels specified.
|
| 34 |
+
|
| 35 |
+
``RETURN_VALUE <result-var>``
|
| 36 |
+
Store in the ``<result-var>`` variable ``0`` if coverage tools
|
| 37 |
+
ran without error and non-zero otherwise.
|
| 38 |
+
|
| 39 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 40 |
+
.. versionadded:: 3.7
|
| 41 |
+
|
| 42 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 43 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
| 44 |
+
|
| 45 |
+
``QUIET``
|
| 46 |
+
.. versionadded:: 3.3
|
| 47 |
+
|
| 48 |
+
Suppress any CTest-specific non-error output that would have been
|
| 49 |
+
printed to the console otherwise. The summary indicating how many
|
| 50 |
+
lines of code were covered is unaffected by this option.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_empty_binary_directory.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_empty_binary_directory
|
| 2 |
+
----------------------------
|
| 3 |
+
|
| 4 |
+
empties the binary directory
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_empty_binary_directory(<directory>)
|
| 9 |
+
|
| 10 |
+
Removes a binary directory. This command will perform some checks
|
| 11 |
+
prior to deleting the directory in an attempt to avoid malicious or
|
| 12 |
+
accidental directory deletion.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_memcheck.rst
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_memcheck
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest MemCheck Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_memcheck([BUILD <build-dir>] [APPEND]
|
| 9 |
+
[START <start-number>]
|
| 10 |
+
[END <end-number>]
|
| 11 |
+
[STRIDE <stride-number>]
|
| 12 |
+
[EXCLUDE <exclude-regex>]
|
| 13 |
+
[INCLUDE <include-regex>]
|
| 14 |
+
[EXCLUDE_LABEL <label-exclude-regex>]
|
| 15 |
+
[INCLUDE_LABEL <label-include-regex>]
|
| 16 |
+
[EXCLUDE_FIXTURE <regex>]
|
| 17 |
+
[EXCLUDE_FIXTURE_SETUP <regex>]
|
| 18 |
+
[EXCLUDE_FIXTURE_CLEANUP <regex>]
|
| 19 |
+
[PARALLEL_LEVEL <level>]
|
| 20 |
+
[RESOURCE_SPEC_FILE <file>]
|
| 21 |
+
[TEST_LOAD <threshold>]
|
| 22 |
+
[SCHEDULE_RANDOM <ON|OFF>]
|
| 23 |
+
[STOP_ON_FAILURE]
|
| 24 |
+
[STOP_TIME <time-of-day>]
|
| 25 |
+
[RETURN_VALUE <result-var>]
|
| 26 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 27 |
+
[REPEAT <mode>:<n>]
|
| 28 |
+
[OUTPUT_JUNIT <file>]
|
| 29 |
+
[DEFECT_COUNT <defect-count-var>]
|
| 30 |
+
[QUIET]
|
| 31 |
+
)
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
Run tests with a dynamic analysis tool and store results in
|
| 35 |
+
``MemCheck.xml`` for submission with the :command:`ctest_submit`
|
| 36 |
+
command.
|
| 37 |
+
|
| 38 |
+
Most options are the same as those for the :command:`ctest_test` command.
|
| 39 |
+
|
| 40 |
+
The options unique to this command are:
|
| 41 |
+
|
| 42 |
+
``DEFECT_COUNT <defect-count-var>``
|
| 43 |
+
.. versionadded:: 3.8
|
| 44 |
+
|
| 45 |
+
Store in the ``<defect-count-var>`` the number of defects found.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_read_custom_files.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_read_custom_files
|
| 2 |
+
-----------------------
|
| 3 |
+
|
| 4 |
+
read CTestCustom files.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_read_custom_files(<directory>...)
|
| 9 |
+
|
| 10 |
+
Read all the CTestCustom.ctest or CTestCustom.cmake files from the
|
| 11 |
+
given directory.
|
| 12 |
+
|
| 13 |
+
By default, invoking :manual:`ctest(1)` without a script will read custom
|
| 14 |
+
files from the binary directory.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_sleep.rst
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_sleep
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
sleeps for some amount of time
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_sleep(<seconds>)
|
| 9 |
+
|
| 10 |
+
Sleep for given number of seconds.
|
| 11 |
+
|
| 12 |
+
.. code-block:: cmake
|
| 13 |
+
|
| 14 |
+
ctest_sleep(<time1> <duration> <time2>)
|
| 15 |
+
|
| 16 |
+
Sleep for t=(time1 + duration - time2) seconds if t > 0.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_test.rst
ADDED
|
@@ -0,0 +1,329 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_test
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest Test Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_test([BUILD <build-dir>] [APPEND]
|
| 9 |
+
[START <start-number>]
|
| 10 |
+
[END <end-number>]
|
| 11 |
+
[STRIDE <stride-number>]
|
| 12 |
+
[EXCLUDE <exclude-regex>]
|
| 13 |
+
[INCLUDE <include-regex>]
|
| 14 |
+
[EXCLUDE_LABEL <label-exclude-regex>]
|
| 15 |
+
[INCLUDE_LABEL <label-include-regex>]
|
| 16 |
+
[EXCLUDE_FROM_FILE <filename>]
|
| 17 |
+
[INCLUDE_FROM_FILE <filename>]
|
| 18 |
+
[EXCLUDE_FIXTURE <regex>]
|
| 19 |
+
[EXCLUDE_FIXTURE_SETUP <regex>]
|
| 20 |
+
[EXCLUDE_FIXTURE_CLEANUP <regex>]
|
| 21 |
+
[PARALLEL_LEVEL [<level>]]
|
| 22 |
+
[RESOURCE_SPEC_FILE <file>]
|
| 23 |
+
[TEST_LOAD <threshold>]
|
| 24 |
+
[SCHEDULE_RANDOM <ON|OFF>]
|
| 25 |
+
[STOP_ON_FAILURE]
|
| 26 |
+
[STOP_TIME <time-of-day>]
|
| 27 |
+
[RETURN_VALUE <result-var>]
|
| 28 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 29 |
+
[REPEAT <mode>:<n>]
|
| 30 |
+
[OUTPUT_JUNIT <file>]
|
| 31 |
+
[QUIET]
|
| 32 |
+
)
|
| 33 |
+
|
| 34 |
+
..
|
| 35 |
+
NOTE If updating the argument list here, please also update the argument
|
| 36 |
+
list documentation for :command:`ctest_memcheck` as well.
|
| 37 |
+
|
| 38 |
+
Run tests in the project build tree and store results in
|
| 39 |
+
``Test.xml`` for submission with the :command:`ctest_submit` command.
|
| 40 |
+
|
| 41 |
+
The options are:
|
| 42 |
+
|
| 43 |
+
``BUILD <build-dir>``
|
| 44 |
+
Specify the top-level build directory. If not given, the
|
| 45 |
+
:variable:`CTEST_BINARY_DIRECTORY` variable is used.
|
| 46 |
+
|
| 47 |
+
``APPEND``
|
| 48 |
+
Mark ``Test.xml`` for append to results previously submitted to a
|
| 49 |
+
dashboard server since the last :command:`ctest_start` call.
|
| 50 |
+
Append semantics are defined by the dashboard server in use.
|
| 51 |
+
This does *not* cause results to be appended to a ``.xml`` file
|
| 52 |
+
produced by a previous call to this command.
|
| 53 |
+
|
| 54 |
+
``START <start-number>``
|
| 55 |
+
Specify the beginning of a range of test numbers.
|
| 56 |
+
|
| 57 |
+
``END <end-number>``
|
| 58 |
+
Specify the end of a range of test numbers.
|
| 59 |
+
|
| 60 |
+
``STRIDE <stride-number>``
|
| 61 |
+
Specify the stride by which to step across a range of test numbers.
|
| 62 |
+
|
| 63 |
+
``EXCLUDE <exclude-regex>``
|
| 64 |
+
Specify a regular expression matching test names to exclude.
|
| 65 |
+
|
| 66 |
+
``INCLUDE <include-regex>``
|
| 67 |
+
Specify a regular expression matching test names to include.
|
| 68 |
+
Tests not matching this expression are excluded.
|
| 69 |
+
|
| 70 |
+
``EXCLUDE_LABEL <label-exclude-regex>``
|
| 71 |
+
Specify a regular expression matching test labels to exclude.
|
| 72 |
+
|
| 73 |
+
``INCLUDE_LABEL <label-include-regex>``
|
| 74 |
+
Specify a regular expression matching test labels to include.
|
| 75 |
+
Tests not matching this expression are excluded.
|
| 76 |
+
|
| 77 |
+
``EXCLUDE_FROM_FILE <filename>``
|
| 78 |
+
.. versionadded:: 3.29
|
| 79 |
+
|
| 80 |
+
Do NOT run tests listed with their exact name in the given file.
|
| 81 |
+
|
| 82 |
+
``INCLUDE_FROM_FILE <filename>``
|
| 83 |
+
.. versionadded:: 3.29
|
| 84 |
+
|
| 85 |
+
Only run the tests listed with their exact name in the given file.
|
| 86 |
+
|
| 87 |
+
``EXCLUDE_FIXTURE <regex>``
|
| 88 |
+
.. versionadded:: 3.7
|
| 89 |
+
|
| 90 |
+
If a test in the set of tests to be executed requires a particular fixture,
|
| 91 |
+
that fixture's setup and cleanup tests would normally be added to the test
|
| 92 |
+
set automatically. This option prevents adding setup or cleanup tests for
|
| 93 |
+
fixtures matching the ``<regex>``. Note that all other fixture behavior is
|
| 94 |
+
retained, including test dependencies and skipping tests that have fixture
|
| 95 |
+
setup tests that fail.
|
| 96 |
+
|
| 97 |
+
``EXCLUDE_FIXTURE_SETUP <regex>``
|
| 98 |
+
.. versionadded:: 3.7
|
| 99 |
+
|
| 100 |
+
Same as ``EXCLUDE_FIXTURE`` except only matching setup tests are excluded.
|
| 101 |
+
|
| 102 |
+
``EXCLUDE_FIXTURE_CLEANUP <regex>``
|
| 103 |
+
.. versionadded:: 3.7
|
| 104 |
+
|
| 105 |
+
Same as ``EXCLUDE_FIXTURE`` except only matching cleanup tests are excluded.
|
| 106 |
+
|
| 107 |
+
``PARALLEL_LEVEL [<level>]``
|
| 108 |
+
Run tests in parallel, limited to a given level of parallelism.
|
| 109 |
+
|
| 110 |
+
.. versionadded:: 3.29
|
| 111 |
+
|
| 112 |
+
The ``<level>`` may be omitted, or ``0``, to let ctest use a default
|
| 113 |
+
level of parallelism, or unbounded parallelism, respectively, as
|
| 114 |
+
documented by the :option:`ctest --parallel` option.
|
| 115 |
+
|
| 116 |
+
``RESOURCE_SPEC_FILE <file>``
|
| 117 |
+
.. versionadded:: 3.16
|
| 118 |
+
|
| 119 |
+
Specify a
|
| 120 |
+
:ref:`resource specification file <ctest-resource-specification-file>`. See
|
| 121 |
+
:ref:`ctest-resource-allocation` for more information.
|
| 122 |
+
|
| 123 |
+
``TEST_LOAD <threshold>``
|
| 124 |
+
.. versionadded:: 3.4
|
| 125 |
+
|
| 126 |
+
While running tests in parallel, try not to start tests when they
|
| 127 |
+
may cause the CPU load to pass above a given threshold. If not
|
| 128 |
+
specified the :variable:`CTEST_TEST_LOAD` variable will be checked,
|
| 129 |
+
and then the :option:`--test-load <ctest --test-load>` command-line
|
| 130 |
+
argument to :manual:`ctest(1)`. See also the ``TestLoad`` setting
|
| 131 |
+
in the :ref:`CTest Test Step`.
|
| 132 |
+
|
| 133 |
+
``REPEAT <mode>:<n>``
|
| 134 |
+
.. versionadded:: 3.17
|
| 135 |
+
|
| 136 |
+
Run tests repeatedly based on the given ``<mode>`` up to ``<n>`` times.
|
| 137 |
+
The modes are:
|
| 138 |
+
|
| 139 |
+
``UNTIL_FAIL``
|
| 140 |
+
Require each test to run ``<n>`` times without failing in order to pass.
|
| 141 |
+
This is useful in finding sporadic failures in test cases.
|
| 142 |
+
|
| 143 |
+
``UNTIL_PASS``
|
| 144 |
+
Allow each test to run up to ``<n>`` times in order to pass.
|
| 145 |
+
Repeats tests if they fail for any reason.
|
| 146 |
+
This is useful in tolerating sporadic failures in test cases.
|
| 147 |
+
|
| 148 |
+
``AFTER_TIMEOUT``
|
| 149 |
+
Allow each test to run up to ``<n>`` times in order to pass.
|
| 150 |
+
Repeats tests only if they timeout.
|
| 151 |
+
This is useful in tolerating sporadic timeouts in test cases
|
| 152 |
+
on busy machines.
|
| 153 |
+
|
| 154 |
+
``SCHEDULE_RANDOM <ON|OFF>``
|
| 155 |
+
Launch tests in a random order. This may be useful for detecting
|
| 156 |
+
implicit test dependencies.
|
| 157 |
+
|
| 158 |
+
``STOP_ON_FAILURE``
|
| 159 |
+
.. versionadded:: 3.18
|
| 160 |
+
|
| 161 |
+
Stop the execution of the tests once one has failed.
|
| 162 |
+
|
| 163 |
+
``STOP_TIME <time-of-day>``
|
| 164 |
+
Specify a time of day at which the tests should all stop running.
|
| 165 |
+
|
| 166 |
+
``RETURN_VALUE <result-var>``
|
| 167 |
+
Store in the ``<result-var>`` variable ``0`` if all tests passed.
|
| 168 |
+
Store non-zero if anything went wrong.
|
| 169 |
+
|
| 170 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 171 |
+
.. versionadded:: 3.7
|
| 172 |
+
|
| 173 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 174 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
| 175 |
+
|
| 176 |
+
``OUTPUT_JUNIT <file>``
|
| 177 |
+
.. versionadded:: 3.21
|
| 178 |
+
|
| 179 |
+
Write test results to ``<file>`` in JUnit XML format. If ``<file>`` is a
|
| 180 |
+
relative path, it will be placed in the build directory. If ``<file>``
|
| 181 |
+
already exists, it will be overwritten. Note that the resulting JUnit XML
|
| 182 |
+
file is **not** uploaded to CDash because it would be redundant with
|
| 183 |
+
CTest's ``Test.xml`` file.
|
| 184 |
+
|
| 185 |
+
``QUIET``
|
| 186 |
+
.. versionadded:: 3.3
|
| 187 |
+
|
| 188 |
+
Suppress any CTest-specific non-error messages that would have otherwise
|
| 189 |
+
been printed to the console. Output from the underlying test command is not
|
| 190 |
+
affected. Summary info detailing the percentage of passing tests is also
|
| 191 |
+
unaffected by the ``QUIET`` option.
|
| 192 |
+
|
| 193 |
+
See also the :variable:`CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE`,
|
| 194 |
+
:variable:`CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE` and
|
| 195 |
+
:variable:`CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variables, along with their
|
| 196 |
+
corresponding :manual:`ctest(1)` command line options
|
| 197 |
+
:option:`--test-output-size-passed <ctest --test-output-size-passed>`,
|
| 198 |
+
:option:`--test-output-size-failed <ctest --test-output-size-failed>`, and
|
| 199 |
+
:option:`--test-output-truncation <ctest --test-output-truncation>`.
|
| 200 |
+
|
| 201 |
+
.. _`Additional Test Measurements`:
|
| 202 |
+
|
| 203 |
+
Additional Test Measurements
|
| 204 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 205 |
+
|
| 206 |
+
CTest can parse the output of your tests for extra measurements to report
|
| 207 |
+
to CDash.
|
| 208 |
+
|
| 209 |
+
When run as a :ref:`Dashboard Client`, CTest will include these custom
|
| 210 |
+
measurements in the ``Test.xml`` file that gets uploaded to CDash.
|
| 211 |
+
|
| 212 |
+
Check the `CDash test measurement documentation
|
| 213 |
+
<https://github.com/Kitware/CDash/blob/master/docs/test_measurements.md>`_
|
| 214 |
+
for more information on the types of test measurements that CDash recognizes.
|
| 215 |
+
|
| 216 |
+
.. versionadded: 3.22
|
| 217 |
+
CTest can parse custom measurements from tags named
|
| 218 |
+
``<CTestMeasurement>`` or ``<CTestMeasurementFile>``. The older names
|
| 219 |
+
``<DartMeasurement>`` and ``<DartMeasurementFile>`` are still supported.
|
| 220 |
+
|
| 221 |
+
The following example demonstrates how to output a variety of custom test
|
| 222 |
+
measurements.
|
| 223 |
+
|
| 224 |
+
.. code-block:: c++
|
| 225 |
+
|
| 226 |
+
std::cout <<
|
| 227 |
+
"<CTestMeasurement type=\"numeric/double\" name=\"score\">28.3</CTestMeasurement>"
|
| 228 |
+
<< std::endl;
|
| 229 |
+
|
| 230 |
+
std::cout <<
|
| 231 |
+
"<CTestMeasurement type=\"text/string\" name=\"color\">red</CTestMeasurement>"
|
| 232 |
+
<< std::endl;
|
| 233 |
+
|
| 234 |
+
std::cout <<
|
| 235 |
+
"<CTestMeasurement type=\"text/link\" name=\"CMake URL\">https://cmake.org</CTestMeasurement>"
|
| 236 |
+
<< std::endl;
|
| 237 |
+
|
| 238 |
+
std::cout <<
|
| 239 |
+
"<CTestMeasurement type=\"text/preformatted\" name=\"Console Output\">" <<
|
| 240 |
+
"line 1.\n" <<
|
| 241 |
+
" \033[31;1m line 2. Bold red, and indented!\033[0;0ml\n" <<
|
| 242 |
+
"line 3. Not bold or indented...\n" <<
|
| 243 |
+
"</CTestMeasurement>" << std::endl;
|
| 244 |
+
|
| 245 |
+
Image Measurements
|
| 246 |
+
""""""""""""""""""
|
| 247 |
+
|
| 248 |
+
The following example demonstrates how to upload test images to CDash.
|
| 249 |
+
|
| 250 |
+
.. code-block:: c++
|
| 251 |
+
|
| 252 |
+
std::cout <<
|
| 253 |
+
"<CTestMeasurementFile type=\"image/jpg\" name=\"TestImage\">" <<
|
| 254 |
+
"/dir/to/test_img.jpg</CTestMeasurementFile>" << std::endl;
|
| 255 |
+
|
| 256 |
+
std::cout <<
|
| 257 |
+
"<CTestMeasurementFile type=\"image/gif\" name=\"ValidImage\">" <<
|
| 258 |
+
"/dir/to/valid_img.gif</CTestMeasurementFile>" << std::endl;
|
| 259 |
+
|
| 260 |
+
std::cout <<
|
| 261 |
+
"<CTestMeasurementFile type=\"image/png\" name=\"AlgoResult\">" <<
|
| 262 |
+
"/dir/to/img.png</CTestMeasurementFile>"
|
| 263 |
+
<< std::endl;
|
| 264 |
+
|
| 265 |
+
Images will be displayed together in an interactive comparison mode on CDash
|
| 266 |
+
if they are provided with two or more of the following names.
|
| 267 |
+
|
| 268 |
+
* ``TestImage``
|
| 269 |
+
* ``ValidImage``
|
| 270 |
+
* ``BaselineImage``
|
| 271 |
+
* ``DifferenceImage2``
|
| 272 |
+
|
| 273 |
+
By convention, ``TestImage`` is the image generated by your test, and
|
| 274 |
+
``ValidImage`` (or ``BaselineImage``) is basis of comparison used to determine
|
| 275 |
+
if the test passed or failed.
|
| 276 |
+
|
| 277 |
+
If another image name is used it will be displayed by CDash as a static image
|
| 278 |
+
separate from the interactive comparison UI.
|
| 279 |
+
|
| 280 |
+
Attached Files
|
| 281 |
+
""""""""""""""
|
| 282 |
+
|
| 283 |
+
.. versionadded:: 3.21
|
| 284 |
+
|
| 285 |
+
The following example demonstrates how to upload non-image files to CDash.
|
| 286 |
+
|
| 287 |
+
.. code-block:: c++
|
| 288 |
+
|
| 289 |
+
std::cout <<
|
| 290 |
+
"<CTestMeasurementFile type=\"file\" name=\"TestInputData1\">" <<
|
| 291 |
+
"/dir/to/data1.csv</CTestMeasurementFile>\n" <<
|
| 292 |
+
"<CTestMeasurementFile type=\"file\" name=\"TestInputData2\">" <<
|
| 293 |
+
"/dir/to/data2.csv</CTestMeasurementFile>" << std::endl;
|
| 294 |
+
|
| 295 |
+
If the name of the file to upload is known at configure time, you can use the
|
| 296 |
+
:prop_test:`ATTACHED_FILES` or :prop_test:`ATTACHED_FILES_ON_FAIL` test
|
| 297 |
+
properties instead.
|
| 298 |
+
|
| 299 |
+
Custom Details
|
| 300 |
+
""""""""""""""
|
| 301 |
+
|
| 302 |
+
.. versionadded:: 3.21
|
| 303 |
+
|
| 304 |
+
The following example demonstrates how to specify a custom value for the
|
| 305 |
+
``Test Details`` field displayed on CDash.
|
| 306 |
+
|
| 307 |
+
.. code-block:: c++
|
| 308 |
+
|
| 309 |
+
std::cout <<
|
| 310 |
+
"<CTestDetails>My Custom Details Value</CTestDetails>" << std::endl;
|
| 311 |
+
|
| 312 |
+
.. _`Additional Labels`:
|
| 313 |
+
|
| 314 |
+
Additional Labels
|
| 315 |
+
"""""""""""""""""
|
| 316 |
+
|
| 317 |
+
.. versionadded:: 3.22
|
| 318 |
+
|
| 319 |
+
The following example demonstrates how to add additional labels to a test
|
| 320 |
+
at runtime.
|
| 321 |
+
|
| 322 |
+
.. code-block:: c++
|
| 323 |
+
|
| 324 |
+
std::cout <<
|
| 325 |
+
"<CTestLabel>Custom Label 1</CTestLabel>\n" <<
|
| 326 |
+
"<CTestLabel>Custom Label 2</CTestLabel>" << std::endl;
|
| 327 |
+
|
| 328 |
+
Use the :prop_test:`LABELS` test property instead for labels that can be
|
| 329 |
+
determined at configure time.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_update.rst
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_update
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_update([SOURCE <source-dir>]
|
| 9 |
+
[RETURN_VALUE <result-var>]
|
| 10 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 11 |
+
[QUIET])
|
| 12 |
+
|
| 13 |
+
Update the source tree from version control and record results in
|
| 14 |
+
``Update.xml`` for submission with the :command:`ctest_submit` command.
|
| 15 |
+
|
| 16 |
+
The options are:
|
| 17 |
+
|
| 18 |
+
``SOURCE <source-dir>``
|
| 19 |
+
Specify the source directory. If not given, the
|
| 20 |
+
:variable:`CTEST_SOURCE_DIRECTORY` variable is used.
|
| 21 |
+
|
| 22 |
+
``RETURN_VALUE <result-var>``
|
| 23 |
+
Store in the ``<result-var>`` variable the number of files
|
| 24 |
+
updated or ``-1`` on error.
|
| 25 |
+
|
| 26 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 27 |
+
.. versionadded:: 3.13
|
| 28 |
+
|
| 29 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 30 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
| 31 |
+
|
| 32 |
+
``QUIET``
|
| 33 |
+
.. versionadded:: 3.3
|
| 34 |
+
|
| 35 |
+
Tell CTest to suppress most non-error messages that it would
|
| 36 |
+
have otherwise printed to the console. CTest will still report
|
| 37 |
+
the new revision of the repository and any conflicting files
|
| 38 |
+
that were found.
|
| 39 |
+
|
| 40 |
+
The update always follows the version control branch currently checked
|
| 41 |
+
out in the source directory. See the :ref:`CTest Update Step`
|
| 42 |
+
documentation for information about variables that change the behavior
|
| 43 |
+
of ``ctest_update()``.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_upload.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_upload
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Upload files to a dashboard server as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_upload(FILES <file>... [QUIET] [CAPTURE_CMAKE_ERROR <result-var>])
|
| 9 |
+
|
| 10 |
+
The options are:
|
| 11 |
+
|
| 12 |
+
``FILES <file>...``
|
| 13 |
+
Specify a list of files to be sent along with the build results to the
|
| 14 |
+
dashboard server.
|
| 15 |
+
|
| 16 |
+
``QUIET``
|
| 17 |
+
.. versionadded:: 3.3
|
| 18 |
+
|
| 19 |
+
Suppress any CTest-specific non-error output that would have been
|
| 20 |
+
printed to the console otherwise.
|
| 21 |
+
|
| 22 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 23 |
+
.. versionadded:: 3.7
|
| 24 |
+
|
| 25 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 26 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/enable_testing.rst
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
enable_testing
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
Enable testing for current directory and below.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
enable_testing()
|
| 9 |
+
|
| 10 |
+
Enables testing for this directory and below.
|
| 11 |
+
|
| 12 |
+
This command should be in the source directory root
|
| 13 |
+
because ctest expects to find a test file in the build
|
| 14 |
+
directory root.
|
| 15 |
+
|
| 16 |
+
This command is automatically invoked when the :module:`CTest`
|
| 17 |
+
module is included, except if the ``BUILD_TESTING`` option is
|
| 18 |
+
turned off.
|
| 19 |
+
|
| 20 |
+
See also the :command:`add_test` command.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endfunction.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
endfunction
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
Ends a list of commands in a function block.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
endfunction([<name>])
|
| 9 |
+
|
| 10 |
+
See the :command:`function` command.
|
| 11 |
+
|
| 12 |
+
The optional ``<name>`` argument is supported for backward compatibility
|
| 13 |
+
only. If used it must be a verbatim repeat of the ``<name>`` argument
|
| 14 |
+
of the opening ``function`` command.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_file.rst
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
find_file
|
| 2 |
+
---------
|
| 3 |
+
|
| 4 |
+
.. |FIND_XXX| replace:: find_file
|
| 5 |
+
.. |NAMES| replace:: NAMES name1 [name2 ...]
|
| 6 |
+
.. |SEARCH_XXX| replace:: full path to a file
|
| 7 |
+
.. |SEARCH_XXX_DESC| replace:: full path to named file
|
| 8 |
+
.. |prefix_XXX_SUBDIR| replace:: ``<prefix>/include``
|
| 9 |
+
.. |entry_XXX_SUBDIR| replace:: ``<entry>/include``
|
| 10 |
+
|
| 11 |
+
.. |FIND_XXX_REGISTRY_VIEW_DEFAULT| replace:: ``TARGET``
|
| 12 |
+
|
| 13 |
+
.. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| replace::
|
| 14 |
+
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
|
| 15 |
+
is set, and |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR|
|
| 16 |
+
.. |CMAKE_PREFIX_PATH_XXX| replace::
|
| 17 |
+
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
|
| 18 |
+
is set, and |CMAKE_PREFIX_PATH_XXX_SUBDIR|
|
| 19 |
+
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH`
|
| 20 |
+
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
|
| 21 |
+
|
| 22 |
+
.. |ENV_CMAKE_PREFIX_PATH_XXX| replace::
|
| 23 |
+
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
|
| 24 |
+
and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR|
|
| 25 |
+
.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_INCLUDE_PATH`
|
| 26 |
+
.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH`
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE``
|
| 30 |
+
and ``PATH``.
|
| 31 |
+
.. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace::
|
| 32 |
+
On Windows hosts, CMake 3.3 through 3.27 searched additional paths:
|
| 33 |
+
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
|
| 34 |
+
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.
|
| 35 |
+
This behavior was removed by CMake 3.28.
|
| 36 |
+
|
| 37 |
+
.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace::
|
| 38 |
+
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
|
| 39 |
+
is set, and |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR|
|
| 40 |
+
.. |CMAKE_SYSTEM_XXX_PATH| replace::
|
| 41 |
+
:variable:`CMAKE_SYSTEM_INCLUDE_PATH`
|
| 42 |
+
.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace::
|
| 43 |
+
:variable:`CMAKE_SYSTEM_FRAMEWORK_PATH`
|
| 44 |
+
|
| 45 |
+
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
| 46 |
+
:variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE`
|
| 47 |
+
|
| 48 |
+
.. include:: FIND_XXX.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/include.rst
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
include
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Load and run CMake code from a file or module.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>]
|
| 9 |
+
[NO_POLICY_SCOPE])
|
| 10 |
+
|
| 11 |
+
Loads and runs CMake code from the file given. Variable reads and
|
| 12 |
+
writes access the scope of the caller (dynamic scoping). If ``OPTIONAL``
|
| 13 |
+
is present, then no error is raised if the file does not exist. If
|
| 14 |
+
``RESULT_VARIABLE`` is given the variable ``<var>`` will be set to the
|
| 15 |
+
full filename which has been included or ``NOTFOUND`` if it failed.
|
| 16 |
+
|
| 17 |
+
If a module is specified instead of a file, the file with name
|
| 18 |
+
``<modulename>.cmake`` is searched first in :variable:`CMAKE_MODULE_PATH`,
|
| 19 |
+
then in the CMake module directory. There is one exception to this: if
|
| 20 |
+
the file which calls ``include()`` is located itself in the CMake builtin
|
| 21 |
+
module directory, then first the CMake builtin module directory is searched and
|
| 22 |
+
:variable:`CMAKE_MODULE_PATH` afterwards. See also policy :policy:`CMP0017`.
|
| 23 |
+
|
| 24 |
+
See the :command:`cmake_policy` command documentation for discussion of the
|
| 25 |
+
``NO_POLICY_SCOPE`` option.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/install_programs.rst
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
install_programs
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.0
|
| 5 |
+
|
| 6 |
+
Use the :command:`install(PROGRAMS)` command instead.
|
| 7 |
+
|
| 8 |
+
This command has been superseded by the :command:`install` command. It is
|
| 9 |
+
provided for compatibility with older CMake code. The ``FILES`` form is
|
| 10 |
+
directly replaced by the ``PROGRAMS`` form of the :command:`install`
|
| 11 |
+
command. The regexp form can be expressed more clearly using the ``GLOB``
|
| 12 |
+
form of the :command:`file` command.
|
| 13 |
+
|
| 14 |
+
.. code-block:: cmake
|
| 15 |
+
|
| 16 |
+
install_programs(<dir> file1 file2 [file3 ...])
|
| 17 |
+
install_programs(<dir> FILES file1 [file2 ...])
|
| 18 |
+
|
| 19 |
+
Create rules to install the listed programs into the given directory.
|
| 20 |
+
Use the ``FILES`` argument to guarantee that the file list version of the
|
| 21 |
+
command will be used even when there is only one argument.
|
| 22 |
+
|
| 23 |
+
.. code-block:: cmake
|
| 24 |
+
|
| 25 |
+
install_programs(<dir> regexp)
|
| 26 |
+
|
| 27 |
+
In the second form any program in the current source directory that
|
| 28 |
+
matches the regular expression will be installed.
|
| 29 |
+
|
| 30 |
+
This command is intended to install programs that are not built by
|
| 31 |
+
cmake, such as shell scripts. See the ``TARGETS`` form of the
|
| 32 |
+
:command:`install` command to create installation rules for targets built
|
| 33 |
+
by cmake.
|
| 34 |
+
|
| 35 |
+
The directory ``<dir>`` is relative to the installation prefix, which is
|
| 36 |
+
stored in the variable :variable:`CMAKE_INSTALL_PREFIX`.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/link_libraries.rst
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
link_libraries
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
Link libraries to all targets added later.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
link_libraries([item1 [item2 [...]]]
|
| 9 |
+
[[debug|optimized|general] <item>] ...)
|
| 10 |
+
|
| 11 |
+
Specify libraries or flags to use when linking any targets created later in
|
| 12 |
+
the current directory or below by commands such as :command:`add_executable`
|
| 13 |
+
or :command:`add_library`. See the :command:`target_link_libraries` command
|
| 14 |
+
for meaning of arguments.
|
| 15 |
+
|
| 16 |
+
.. note::
|
| 17 |
+
The :command:`target_link_libraries` command should be preferred whenever
|
| 18 |
+
possible. Library dependencies are chained automatically, so directory-wide
|
| 19 |
+
specification of link libraries is rarely needed.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/load_cache.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
load_cache
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
Load in the values from another project's CMake cache.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
load_cache(pathToBuildDirectory READ_WITH_PREFIX prefix entry1...)
|
| 9 |
+
|
| 10 |
+
Reads the cache and store the requested entries in variables with their
|
| 11 |
+
name prefixed with the given prefix. This only reads the values, and
|
| 12 |
+
does not create entries in the local project's cache.
|
| 13 |
+
|
| 14 |
+
.. code-block:: cmake
|
| 15 |
+
|
| 16 |
+
load_cache(pathToBuildDirectory [EXCLUDE entry1...]
|
| 17 |
+
[INCLUDE_INTERNALS entry1...])
|
| 18 |
+
|
| 19 |
+
Loads in the values from another cache and store them in the local
|
| 20 |
+
project's cache as internal entries. This is useful for a project
|
| 21 |
+
that depends on another project built in a different tree. ``EXCLUDE``
|
| 22 |
+
option can be used to provide a list of entries to be excluded.
|
| 23 |
+
``INCLUDE_INTERNALS`` can be used to provide a list of internal entries to
|
| 24 |
+
be included. Normally, no internal entries are brought in. Use of
|
| 25 |
+
this form of the command is strongly discouraged, but it is provided
|
| 26 |
+
for backward compatibility.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/project.rst
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
project
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Set the name of the project.
|
| 5 |
+
|
| 6 |
+
Synopsis
|
| 7 |
+
^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. code-block:: cmake
|
| 10 |
+
|
| 11 |
+
project(<PROJECT-NAME> [<language-name>...])
|
| 12 |
+
project(<PROJECT-NAME>
|
| 13 |
+
[VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
|
| 14 |
+
[DESCRIPTION <project-description-string>]
|
| 15 |
+
[HOMEPAGE_URL <url-string>]
|
| 16 |
+
[LANGUAGES <language-name>...])
|
| 17 |
+
|
| 18 |
+
Sets the name of the project, and stores it in the variable
|
| 19 |
+
:variable:`PROJECT_NAME`. When called from the top-level
|
| 20 |
+
``CMakeLists.txt`` also stores the project name in the
|
| 21 |
+
variable :variable:`CMAKE_PROJECT_NAME`.
|
| 22 |
+
|
| 23 |
+
Also sets the variables:
|
| 24 |
+
|
| 25 |
+
:variable:`PROJECT_SOURCE_DIR`, :variable:`<PROJECT-NAME>_SOURCE_DIR`
|
| 26 |
+
Absolute path to the source directory for the project.
|
| 27 |
+
|
| 28 |
+
:variable:`PROJECT_BINARY_DIR`, :variable:`<PROJECT-NAME>_BINARY_DIR`
|
| 29 |
+
Absolute path to the binary directory for the project.
|
| 30 |
+
|
| 31 |
+
:variable:`PROJECT_IS_TOP_LEVEL`, :variable:`<PROJECT-NAME>_IS_TOP_LEVEL`
|
| 32 |
+
.. versionadded:: 3.21
|
| 33 |
+
|
| 34 |
+
Boolean value indicating whether the project is top-level.
|
| 35 |
+
|
| 36 |
+
Further variables are set by the optional arguments described in `Options`_
|
| 37 |
+
further below. Where an option is not given, its corresponding variable is
|
| 38 |
+
set to the empty string.
|
| 39 |
+
|
| 40 |
+
Note that variables of the form ``<name>_SOURCE_DIR`` and ``<name>_BINARY_DIR``
|
| 41 |
+
may also be set by other commands before ``project()`` is called (see the
|
| 42 |
+
:command:`FetchContent_MakeAvailable` command for one example).
|
| 43 |
+
Projects should not rely on ``<PROJECT-NAME>_SOURCE_DIR`` or
|
| 44 |
+
``<PROJECT-NAME>_BINARY_DIR`` holding a particular value outside of the scope
|
| 45 |
+
of the call to ``project()`` or one of its child scopes.
|
| 46 |
+
|
| 47 |
+
.. versionchanged:: 3.30
|
| 48 |
+
``<PROJECT-NAME>_SOURCE_DIR``, ``<PROJECT-NAME>_BINARY_DIR``, and
|
| 49 |
+
``<PROJECT-NAME>_IS_TOP_LEVEL``, if already set as normal variables when
|
| 50 |
+
``project(<PROJECT-NAME> ...)`` is called, are updated by the call.
|
| 51 |
+
Cache entries by the same names are always set as before.
|
| 52 |
+
See release notes for 3.30.3, 3.30.4, and 3.30.5 for details.
|
| 53 |
+
|
| 54 |
+
.. versionchanged:: 3.31
|
| 55 |
+
``<PROJECT-NAME>_SOURCE_DIR``, ``<PROJECT-NAME>_BINARY_DIR``, and
|
| 56 |
+
``<PROJECT-NAME>_IS_TOP_LEVEL`` are always set as normal variables by
|
| 57 |
+
``project(<PROJECT-NAME> ...)``. See policy :policy:`CMP0180`.
|
| 58 |
+
Cache entries by the same names are always set as before.
|
| 59 |
+
|
| 60 |
+
Options
|
| 61 |
+
^^^^^^^
|
| 62 |
+
|
| 63 |
+
The options are:
|
| 64 |
+
|
| 65 |
+
``VERSION <version>``
|
| 66 |
+
Optional; may not be used unless policy :policy:`CMP0048` is
|
| 67 |
+
set to ``NEW``.
|
| 68 |
+
|
| 69 |
+
Takes a ``<version>`` argument composed of non-negative integer components,
|
| 70 |
+
i.e. ``<major>[.<minor>[.<patch>[.<tweak>]]]``,
|
| 71 |
+
and sets the variables
|
| 72 |
+
|
| 73 |
+
* :variable:`PROJECT_VERSION`,
|
| 74 |
+
:variable:`<PROJECT-NAME>_VERSION`
|
| 75 |
+
* :variable:`PROJECT_VERSION_MAJOR`,
|
| 76 |
+
:variable:`<PROJECT-NAME>_VERSION_MAJOR`
|
| 77 |
+
* :variable:`PROJECT_VERSION_MINOR`,
|
| 78 |
+
:variable:`<PROJECT-NAME>_VERSION_MINOR`
|
| 79 |
+
* :variable:`PROJECT_VERSION_PATCH`,
|
| 80 |
+
:variable:`<PROJECT-NAME>_VERSION_PATCH`
|
| 81 |
+
* :variable:`PROJECT_VERSION_TWEAK`,
|
| 82 |
+
:variable:`<PROJECT-NAME>_VERSION_TWEAK`.
|
| 83 |
+
|
| 84 |
+
.. versionadded:: 3.12
|
| 85 |
+
When the ``project()`` command is called from the top-level
|
| 86 |
+
``CMakeLists.txt``, then the version is also stored in the variable
|
| 87 |
+
:variable:`CMAKE_PROJECT_VERSION`.
|
| 88 |
+
|
| 89 |
+
``DESCRIPTION <project-description-string>``
|
| 90 |
+
.. versionadded:: 3.9
|
| 91 |
+
|
| 92 |
+
Optional.
|
| 93 |
+
Sets the variables
|
| 94 |
+
|
| 95 |
+
* :variable:`PROJECT_DESCRIPTION`, :variable:`<PROJECT-NAME>_DESCRIPTION`
|
| 96 |
+
|
| 97 |
+
to ``<project-description-string>``.
|
| 98 |
+
It is recommended that this description is a relatively short string,
|
| 99 |
+
usually no more than a few words.
|
| 100 |
+
|
| 101 |
+
When the ``project()`` command is called from the top-level ``CMakeLists.txt``,
|
| 102 |
+
then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`.
|
| 103 |
+
|
| 104 |
+
.. versionadded:: 3.12
|
| 105 |
+
Added the ``<PROJECT-NAME>_DESCRIPTION`` variable.
|
| 106 |
+
|
| 107 |
+
``HOMEPAGE_URL <url-string>``
|
| 108 |
+
.. versionadded:: 3.12
|
| 109 |
+
|
| 110 |
+
Optional.
|
| 111 |
+
Sets the variables
|
| 112 |
+
|
| 113 |
+
* :variable:`PROJECT_HOMEPAGE_URL`, :variable:`<PROJECT-NAME>_HOMEPAGE_URL`
|
| 114 |
+
|
| 115 |
+
to ``<url-string>``, which should be the canonical home URL for the project.
|
| 116 |
+
|
| 117 |
+
When the ``project()`` command is called from the top-level ``CMakeLists.txt``,
|
| 118 |
+
then the URL also is stored in the variable :variable:`CMAKE_PROJECT_HOMEPAGE_URL`.
|
| 119 |
+
|
| 120 |
+
``LANGUAGES <language-name>...``
|
| 121 |
+
Optional.
|
| 122 |
+
Can also be specified without ``LANGUAGES`` keyword per the first, short signature.
|
| 123 |
+
|
| 124 |
+
Selects which programming languages are needed to build the project.
|
| 125 |
+
|
| 126 |
+
.. include:: SUPPORTED_LANGUAGES.txt
|
| 127 |
+
|
| 128 |
+
By default ``C`` and ``CXX`` are enabled if no language options are given.
|
| 129 |
+
Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages,
|
| 130 |
+
to skip enabling any languages.
|
| 131 |
+
|
| 132 |
+
The variables set through the ``VERSION``, ``DESCRIPTION`` and ``HOMEPAGE_URL``
|
| 133 |
+
options are intended for use as default values in package metadata and documentation.
|
| 134 |
+
|
| 135 |
+
.. _`Code Injection`:
|
| 136 |
+
|
| 137 |
+
Code Injection
|
| 138 |
+
^^^^^^^^^^^^^^
|
| 139 |
+
|
| 140 |
+
A number of variables can be defined by the user to specify files to include
|
| 141 |
+
at different points during the execution of the ``project()`` command.
|
| 142 |
+
The following outlines the steps performed during a ``project()`` call:
|
| 143 |
+
|
| 144 |
+
* .. versionadded:: 3.15
|
| 145 |
+
For every ``project()`` call regardless of the project
|
| 146 |
+
name, include the file(s) and module(s) named by
|
| 147 |
+
:variable:`CMAKE_PROJECT_INCLUDE_BEFORE`, if set.
|
| 148 |
+
|
| 149 |
+
* .. versionadded:: 3.17
|
| 150 |
+
If the ``project()`` command specifies ``<PROJECT-NAME>`` as its project
|
| 151 |
+
name, include the file(s) and module(s) named by
|
| 152 |
+
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`, if set.
|
| 153 |
+
|
| 154 |
+
* Set the various project-specific variables detailed in the `Synopsis`_
|
| 155 |
+
and `Options`_ sections above.
|
| 156 |
+
|
| 157 |
+
* For the very first ``project()`` call only:
|
| 158 |
+
|
| 159 |
+
* If :variable:`CMAKE_TOOLCHAIN_FILE` is set, read it at least once.
|
| 160 |
+
It may be read multiple times and it may also be read again when
|
| 161 |
+
enabling languages later (see below).
|
| 162 |
+
|
| 163 |
+
* Set the variables describing the host and target platforms.
|
| 164 |
+
Language-specific variables might or might not be set at this point.
|
| 165 |
+
On the first run, the only language-specific variables that might be
|
| 166 |
+
defined are those a toolchain file may have set. On subsequent runs,
|
| 167 |
+
language-specific variables cached from a previous run may be set.
|
| 168 |
+
|
| 169 |
+
* .. versionadded:: 3.24
|
| 170 |
+
Include each file listed in :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES`,
|
| 171 |
+
if set. The variable is ignored by CMake thereafter.
|
| 172 |
+
|
| 173 |
+
* Enable any languages specified in the call, or the default languages if
|
| 174 |
+
none were provided. The toolchain file may be re-read when enabling a
|
| 175 |
+
language for the first time.
|
| 176 |
+
|
| 177 |
+
* .. versionadded:: 3.15
|
| 178 |
+
For every ``project()`` call regardless of the project
|
| 179 |
+
name, include the file(s) and module(s) named by
|
| 180 |
+
:variable:`CMAKE_PROJECT_INCLUDE`, if set.
|
| 181 |
+
|
| 182 |
+
* If the ``project()`` command specifies ``<PROJECT-NAME>`` as its project
|
| 183 |
+
name, include the file(s) and module(s) named by
|
| 184 |
+
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`, if set.
|
| 185 |
+
|
| 186 |
+
Usage
|
| 187 |
+
^^^^^
|
| 188 |
+
|
| 189 |
+
The top-level ``CMakeLists.txt`` file for a project must contain a
|
| 190 |
+
literal, direct call to the ``project()`` command; loading one
|
| 191 |
+
through the :command:`include` command is not sufficient. If no such
|
| 192 |
+
call exists, CMake will issue a warning and pretend there is a
|
| 193 |
+
``project(Project)`` at the top to enable the default languages
|
| 194 |
+
(``C`` and ``CXX``).
|
| 195 |
+
|
| 196 |
+
.. note::
|
| 197 |
+
Call the ``project()`` command near the top of the top-level
|
| 198 |
+
``CMakeLists.txt``, but *after* calling :command:`cmake_minimum_required`.
|
| 199 |
+
It is important to establish version and policy settings before invoking
|
| 200 |
+
other commands whose behavior they may affect and for this reason the
|
| 201 |
+
``project()`` command will issue a warning if this order is not kept.
|
| 202 |
+
See also policy :policy:`CMP0000`.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/remove_definitions.rst
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
remove_definitions
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
Remove -D define flags added by :command:`add_definitions`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
remove_definitions(-DFOO -DBAR ...)
|
| 9 |
+
|
| 10 |
+
Removes flags (added by :command:`add_definitions`) from the compiler
|
| 11 |
+
command line for sources in the current directory and below.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_source_files_properties.rst
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
set_source_files_properties
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
Source files can have properties that affect how they are built.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
set_source_files_properties(<files> ...
|
| 9 |
+
[DIRECTORY <dirs> ...]
|
| 10 |
+
[TARGET_DIRECTORY <targets> ...]
|
| 11 |
+
PROPERTIES <prop1> <value1>
|
| 12 |
+
[<prop2> <value2>] ...)
|
| 13 |
+
|
| 14 |
+
Sets properties associated with source files using a key/value paired
|
| 15 |
+
list.
|
| 16 |
+
|
| 17 |
+
.. versionadded:: 3.18
|
| 18 |
+
By default, source file properties are only visible to targets added in the
|
| 19 |
+
same directory (``CMakeLists.txt``). Visibility can be set in other directory
|
| 20 |
+
scopes using one or both of the following options:
|
| 21 |
+
|
| 22 |
+
``DIRECTORY <dirs>...``
|
| 23 |
+
The source file properties will be set in each of the ``<dirs>``
|
| 24 |
+
directories' scopes. CMake must already know about each of these
|
| 25 |
+
source directories, either by having added them through a call to
|
| 26 |
+
:command:`add_subdirectory` or it being the top level source directory.
|
| 27 |
+
Relative paths are treated as relative to the current source directory.
|
| 28 |
+
|
| 29 |
+
``TARGET_DIRECTORY <targets>...``
|
| 30 |
+
The source file properties will be set in each of the directory scopes
|
| 31 |
+
where any of the specified ``<targets>`` were created (the ``<targets>``
|
| 32 |
+
must therefore already exist).
|
| 33 |
+
|
| 34 |
+
Use :command:`get_source_file_property` to get property values.
|
| 35 |
+
See also the :command:`set_property(SOURCE)` command.
|
| 36 |
+
|
| 37 |
+
.. note::
|
| 38 |
+
|
| 39 |
+
The :prop_sf:`GENERATED` source file property may be globally visible.
|
| 40 |
+
See its documentation for details.
|
| 41 |
+
|
| 42 |
+
See Also
|
| 43 |
+
^^^^^^^^
|
| 44 |
+
|
| 45 |
+
* :command:`define_property`
|
| 46 |
+
* :command:`get_source_file_property`
|
| 47 |
+
* :ref:`Source File Properties` for the list of properties known
|
| 48 |
+
to CMake
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_compile_features.rst
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
target_compile_features
|
| 2 |
+
-----------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.1
|
| 5 |
+
|
| 6 |
+
Add expected compiler features to a target.
|
| 7 |
+
|
| 8 |
+
.. code-block:: cmake
|
| 9 |
+
|
| 10 |
+
target_compile_features(<target> <PRIVATE|PUBLIC|INTERFACE> <feature> [...])
|
| 11 |
+
|
| 12 |
+
Specifies compiler features required when compiling a given target. If the
|
| 13 |
+
feature is not listed in the :variable:`CMAKE_C_COMPILE_FEATURES`,
|
| 14 |
+
:variable:`CMAKE_CUDA_COMPILE_FEATURES`, or :variable:`CMAKE_CXX_COMPILE_FEATURES`
|
| 15 |
+
variables, then an error will be reported by CMake. If the use of the feature requires
|
| 16 |
+
an additional compiler flag, such as ``-std=gnu++11``, the flag will be added
|
| 17 |
+
automatically.
|
| 18 |
+
|
| 19 |
+
The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
|
| 20 |
+
specify the scope of the features. ``PRIVATE`` and ``PUBLIC`` items will
|
| 21 |
+
populate the :prop_tgt:`COMPILE_FEATURES` property of ``<target>``.
|
| 22 |
+
``PUBLIC`` and ``INTERFACE`` items will populate the
|
| 23 |
+
:prop_tgt:`INTERFACE_COMPILE_FEATURES` property of ``<target>``.
|
| 24 |
+
Repeated calls for the same ``<target>`` append items.
|
| 25 |
+
|
| 26 |
+
.. versionadded:: 3.11
|
| 27 |
+
Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`.
|
| 28 |
+
|
| 29 |
+
The named ``<target>`` must have been created by a command such as
|
| 30 |
+
:command:`add_executable` or :command:`add_library` and must not be an
|
| 31 |
+
:ref:`ALIAS target <Alias Targets>`.
|
| 32 |
+
|
| 33 |
+
.. |command_name| replace:: ``target_compile_features``
|
| 34 |
+
.. |more_see_also| replace:: See the :manual:`cmake-compile-features(7)`
|
| 35 |
+
manual for information on compile features and a list of supported compilers.
|
| 36 |
+
.. include:: GENEX_NOTE.txt
|
| 37 |
+
:start-line: 1
|
| 38 |
+
|
| 39 |
+
See Also
|
| 40 |
+
^^^^^^^^
|
| 41 |
+
|
| 42 |
+
* :command:`target_compile_definitions`
|
| 43 |
+
* :command:`target_compile_options`
|
| 44 |
+
* :command:`target_include_directories`
|
| 45 |
+
* :command:`target_link_libraries`
|
| 46 |
+
* :command:`target_link_directories`
|
| 47 |
+
* :command:`target_link_options`
|
| 48 |
+
* :command:`target_precompile_headers`
|
| 49 |
+
* :command:`target_sources`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/target_link_options.rst
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
target_link_options
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.13
|
| 5 |
+
|
| 6 |
+
Add options to the link step for an executable, shared library or module
|
| 7 |
+
library target.
|
| 8 |
+
|
| 9 |
+
.. code-block:: cmake
|
| 10 |
+
|
| 11 |
+
target_link_options(<target> [BEFORE]
|
| 12 |
+
<INTERFACE|PUBLIC|PRIVATE> [items1...]
|
| 13 |
+
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
|
| 14 |
+
|
| 15 |
+
The named ``<target>`` must have been created by a command such as
|
| 16 |
+
:command:`add_executable` or :command:`add_library` and must not be an
|
| 17 |
+
:ref:`ALIAS target <Alias Targets>`.
|
| 18 |
+
|
| 19 |
+
This command can be used to add any link options, but alternative commands
|
| 20 |
+
exist to add libraries (:command:`target_link_libraries` or
|
| 21 |
+
:command:`link_libraries`). See documentation of the
|
| 22 |
+
:prop_dir:`directory <LINK_OPTIONS>` and
|
| 23 |
+
:prop_tgt:`target <LINK_OPTIONS>` ``LINK_OPTIONS`` properties.
|
| 24 |
+
|
| 25 |
+
.. note::
|
| 26 |
+
|
| 27 |
+
This command cannot be used to add options for static library targets,
|
| 28 |
+
since they do not use a linker. To add archiver or MSVC librarian flags,
|
| 29 |
+
see the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property.
|
| 30 |
+
|
| 31 |
+
If ``BEFORE`` is specified, the content will be prepended to the property
|
| 32 |
+
instead of being appended.
|
| 33 |
+
|
| 34 |
+
The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
|
| 35 |
+
specify the :ref:`scope <Target Command Scope>` of the following arguments.
|
| 36 |
+
``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`LINK_OPTIONS`
|
| 37 |
+
property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the
|
| 38 |
+
:prop_tgt:`INTERFACE_LINK_OPTIONS` property of ``<target>``.
|
| 39 |
+
The following arguments specify link options. Repeated calls for the same
|
| 40 |
+
``<target>`` append items in the order called.
|
| 41 |
+
|
| 42 |
+
.. note::
|
| 43 |
+
:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.
|
| 44 |
+
|
| 45 |
+
.. |command_name| replace:: ``target_link_options``
|
| 46 |
+
.. include:: GENEX_NOTE.txt
|
| 47 |
+
|
| 48 |
+
.. include:: DEVICE_LINK_OPTIONS.txt
|
| 49 |
+
|
| 50 |
+
.. include:: OPTIONS_SHELL.txt
|
| 51 |
+
|
| 52 |
+
.. include:: LINK_OPTIONS_LINKER.txt
|
| 53 |
+
|
| 54 |
+
See Also
|
| 55 |
+
^^^^^^^^
|
| 56 |
+
|
| 57 |
+
* :command:`target_compile_definitions`
|
| 58 |
+
* :command:`target_compile_features`
|
| 59 |
+
* :command:`target_compile_options`
|
| 60 |
+
* :command:`target_include_directories`
|
| 61 |
+
* :command:`target_link_libraries`
|
| 62 |
+
* :command:`target_link_directories`
|
| 63 |
+
* :command:`target_precompile_headers`
|
| 64 |
+
* :command:`target_sources`
|
| 65 |
+
|
| 66 |
+
* :variable:`CMAKE_<LANG>_FLAGS` and :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>`
|
| 67 |
+
add language-wide flags passed to all invocations of the compiler.
|
| 68 |
+
This includes invocations that drive compiling and those that drive linking.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/try_compile.rst
ADDED
|
@@ -0,0 +1,405 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
try_compile
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Try building some code.
|
| 9 |
+
|
| 10 |
+
.. _`Try Compiling Whole Projects`:
|
| 11 |
+
|
| 12 |
+
Try Compiling Whole Projects
|
| 13 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 14 |
+
|
| 15 |
+
.. code-block:: cmake
|
| 16 |
+
|
| 17 |
+
try_compile(<compileResultVar> PROJECT <projectName>
|
| 18 |
+
SOURCE_DIR <srcdir>
|
| 19 |
+
[BINARY_DIR <bindir>]
|
| 20 |
+
[TARGET <targetName>]
|
| 21 |
+
[LOG_DESCRIPTION <text>]
|
| 22 |
+
[NO_CACHE]
|
| 23 |
+
[NO_LOG]
|
| 24 |
+
[CMAKE_FLAGS <flags>...]
|
| 25 |
+
[OUTPUT_VARIABLE <var>])
|
| 26 |
+
|
| 27 |
+
.. versionadded:: 3.25
|
| 28 |
+
|
| 29 |
+
Try building a project. Build success returns ``TRUE`` and build failure
|
| 30 |
+
returns ``FALSE`` in ``<compileResultVar>``.
|
| 31 |
+
|
| 32 |
+
In this form, ``<srcdir>`` should contain a complete CMake project with a
|
| 33 |
+
``CMakeLists.txt`` file and all sources. The ``<bindir>`` and ``<srcdir>``
|
| 34 |
+
will not be deleted after this command is run. Specify ``<targetName>`` to
|
| 35 |
+
build a specific target instead of the ``all`` or ``ALL_BUILD`` target. See
|
| 36 |
+
below for the meaning of other options.
|
| 37 |
+
|
| 38 |
+
.. versionchanged:: 3.24
|
| 39 |
+
CMake variables describing platform settings, and those listed by the
|
| 40 |
+
:variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable, are propagated
|
| 41 |
+
into the project's build configuration. See policy :policy:`CMP0137`.
|
| 42 |
+
Previously this was only done by the
|
| 43 |
+
:ref:`source file <Try Compiling Source Files>` signature.
|
| 44 |
+
|
| 45 |
+
.. versionadded:: 3.26
|
| 46 |
+
This command records a
|
| 47 |
+
:ref:`configure-log try_compile event <try_compile configure-log event>`
|
| 48 |
+
if the ``NO_LOG`` option is not specified.
|
| 49 |
+
|
| 50 |
+
.. versionadded:: 3.30
|
| 51 |
+
If the :prop_gbl:`PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE` global
|
| 52 |
+
property is set to true, :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` is
|
| 53 |
+
propagated into the project's build configuration.
|
| 54 |
+
|
| 55 |
+
This command supports an alternate signature for CMake older than 3.25.
|
| 56 |
+
The signature above is recommended for clarity.
|
| 57 |
+
|
| 58 |
+
.. code-block:: cmake
|
| 59 |
+
|
| 60 |
+
try_compile(<compileResultVar> <bindir> <srcdir>
|
| 61 |
+
<projectName> [<targetName>]
|
| 62 |
+
[CMAKE_FLAGS <flags>...]
|
| 63 |
+
[OUTPUT_VARIABLE <var>])
|
| 64 |
+
|
| 65 |
+
.. _`Try Compiling Source Files`:
|
| 66 |
+
|
| 67 |
+
Try Compiling Source Files
|
| 68 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 69 |
+
|
| 70 |
+
.. code-block:: cmake
|
| 71 |
+
|
| 72 |
+
try_compile(<compileResultVar>
|
| 73 |
+
[SOURCES_TYPE <type>]
|
| 74 |
+
<SOURCES <srcfile...> |
|
| 75 |
+
SOURCE_FROM_CONTENT <name> <content> |
|
| 76 |
+
SOURCE_FROM_VAR <name> <var> |
|
| 77 |
+
SOURCE_FROM_FILE <name> <path> >...
|
| 78 |
+
[LOG_DESCRIPTION <text>]
|
| 79 |
+
[NO_CACHE]
|
| 80 |
+
[NO_LOG]
|
| 81 |
+
[CMAKE_FLAGS <flags>...]
|
| 82 |
+
[COMPILE_DEFINITIONS <defs>...]
|
| 83 |
+
[LINK_OPTIONS <options>...]
|
| 84 |
+
[LINK_LIBRARIES <libs>...]
|
| 85 |
+
[LINKER_LANGUAGE <lang>]
|
| 86 |
+
[OUTPUT_VARIABLE <var>]
|
| 87 |
+
[COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
|
| 88 |
+
[<LANG>_STANDARD <std>]
|
| 89 |
+
[<LANG>_STANDARD_REQUIRED <bool>]
|
| 90 |
+
[<LANG>_EXTENSIONS <bool>]
|
| 91 |
+
)
|
| 92 |
+
|
| 93 |
+
.. versionadded:: 3.25
|
| 94 |
+
|
| 95 |
+
Try building an executable or static library from one or more source files
|
| 96 |
+
(which one is determined by the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE`
|
| 97 |
+
variable). Build success returns ``TRUE`` and build failure returns ``FALSE``
|
| 98 |
+
in ``<compileResultVar>``.
|
| 99 |
+
|
| 100 |
+
In this form, one or more source files must be provided. Additionally, one of
|
| 101 |
+
``SOURCES`` and/or ``SOURCE_FROM_*`` must precede other keywords.
|
| 102 |
+
|
| 103 |
+
If :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is unset or is set to
|
| 104 |
+
``EXECUTABLE``, the sources must include a definition for ``main`` and CMake
|
| 105 |
+
will create a ``CMakeLists.txt`` file to build the source(s) as an executable.
|
| 106 |
+
If :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``STATIC_LIBRARY``,
|
| 107 |
+
a static library will be built instead and no definition for ``main`` is
|
| 108 |
+
required. For an executable, the generated ``CMakeLists.txt`` file would
|
| 109 |
+
contain something like the following:
|
| 110 |
+
|
| 111 |
+
.. code-block:: cmake
|
| 112 |
+
|
| 113 |
+
add_definitions(<expanded COMPILE_DEFINITIONS from caller>)
|
| 114 |
+
include_directories(${INCLUDE_DIRECTORIES})
|
| 115 |
+
link_directories(${LINK_DIRECTORIES})
|
| 116 |
+
add_executable(cmTryCompileExec <srcfile>...)
|
| 117 |
+
target_link_options(cmTryCompileExec PRIVATE <LINK_OPTIONS from caller>)
|
| 118 |
+
target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})
|
| 119 |
+
|
| 120 |
+
CMake automatically generates, for each ``try_compile`` operation, a
|
| 121 |
+
unique directory under ``${CMAKE_BINARY_DIR}/CMakeFiles/CMakeScratch``
|
| 122 |
+
with an unspecified name. These directories are cleaned automatically unless
|
| 123 |
+
:option:`--debug-trycompile <cmake --debug-trycompile>` is passed to :program:`cmake`.
|
| 124 |
+
Such directories from previous runs are also unconditionally cleaned at the
|
| 125 |
+
beginning of any :program:`cmake` execution.
|
| 126 |
+
|
| 127 |
+
This command supports an alternate signature for CMake older than 3.25.
|
| 128 |
+
The signature above is recommended for clarity.
|
| 129 |
+
|
| 130 |
+
.. code-block:: cmake
|
| 131 |
+
|
| 132 |
+
try_compile(<compileResultVar> <bindir> <srcfile|SOURCES srcfile...>
|
| 133 |
+
[CMAKE_FLAGS <flags>...]
|
| 134 |
+
[COMPILE_DEFINITIONS <defs>...]
|
| 135 |
+
[LINK_OPTIONS <options>...]
|
| 136 |
+
[LINK_LIBRARIES <libs>...]
|
| 137 |
+
[OUTPUT_VARIABLE <var>]
|
| 138 |
+
[COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
|
| 139 |
+
[<LANG>_STANDARD <std>]
|
| 140 |
+
[<LANG>_STANDARD_REQUIRED <bool>]
|
| 141 |
+
[<LANG>_EXTENSIONS <bool>]
|
| 142 |
+
)
|
| 143 |
+
|
| 144 |
+
In this version, ``try_compile`` will use ``<bindir>/CMakeFiles/CMakeTmp`` for
|
| 145 |
+
its operation, and all such files will be cleaned automatically.
|
| 146 |
+
For debugging, :option:`--debug-trycompile <cmake --debug-trycompile>` can be
|
| 147 |
+
passed to :program:`cmake` to avoid this clean. However, multiple sequential
|
| 148 |
+
``try_compile`` operations, if given the same ``<bindir>``, will reuse this
|
| 149 |
+
single output directory, such that you can only debug one such ``try_compile``
|
| 150 |
+
call at a time. Use of the newer signature is recommended to simplify
|
| 151 |
+
debugging of multiple ``try_compile`` operations.
|
| 152 |
+
|
| 153 |
+
.. _`try_compile Options`:
|
| 154 |
+
|
| 155 |
+
Options
|
| 156 |
+
^^^^^^^
|
| 157 |
+
|
| 158 |
+
The options for the above signatures are:
|
| 159 |
+
|
| 160 |
+
``CMAKE_FLAGS <flags>...``
|
| 161 |
+
Specify flags of the form :option:`-DVAR:TYPE=VALUE <cmake -D>` to be passed
|
| 162 |
+
to the :manual:`cmake(1)` command-line used to drive the test build.
|
| 163 |
+
The above example shows how values for variables
|
| 164 |
+
``COMPILE_DEFINITIONS``, ``INCLUDE_DIRECTORIES``, ``LINK_DIRECTORIES``,
|
| 165 |
+
``LINK_LIBRARIES``, and ``LINK_OPTIONS`` are used. Compiler options
|
| 166 |
+
can be passed in like `CMAKE_FLAGS -DCOMPILE_DEFINITIONS=-Werror`.
|
| 167 |
+
|
| 168 |
+
``COMPILE_DEFINITIONS <defs>...``
|
| 169 |
+
Specify ``-Ddefinition`` arguments to pass to :command:`add_definitions`
|
| 170 |
+
in the generated test project.
|
| 171 |
+
|
| 172 |
+
``COPY_FILE <fileName>``
|
| 173 |
+
Copy the built executable or static library to the given ``<fileName>``.
|
| 174 |
+
|
| 175 |
+
``COPY_FILE_ERROR <var>``
|
| 176 |
+
Use after ``COPY_FILE`` to capture into variable ``<var>`` any error
|
| 177 |
+
message encountered while trying to copy the file.
|
| 178 |
+
|
| 179 |
+
``LINK_LIBRARIES <libs>...``
|
| 180 |
+
Specify libraries to be linked in the generated project.
|
| 181 |
+
The list of libraries may refer to system libraries and to
|
| 182 |
+
:ref:`Imported Targets <Imported Targets>` from the calling project.
|
| 183 |
+
|
| 184 |
+
If this option is specified, any ``-DLINK_LIBRARIES=...`` value
|
| 185 |
+
given to the ``CMAKE_FLAGS`` option will be ignored.
|
| 186 |
+
|
| 187 |
+
.. versionadded:: 3.29
|
| 188 |
+
Alias targets to imported libraries are also supported.
|
| 189 |
+
|
| 190 |
+
``LINK_OPTIONS <options>...``
|
| 191 |
+
.. versionadded:: 3.14
|
| 192 |
+
|
| 193 |
+
Specify link step options to pass to :command:`target_link_options` or to
|
| 194 |
+
set the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property in the generated
|
| 195 |
+
project, depending on the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable.
|
| 196 |
+
|
| 197 |
+
``LINKER_LANGUAGE <lang>``
|
| 198 |
+
.. versionadded:: 3.29
|
| 199 |
+
|
| 200 |
+
Specify the :prop_tgt:`LINKER_LANGUAGE` target property of the generated
|
| 201 |
+
project. When using multiple source files with different languages, set
|
| 202 |
+
this to the language of the source file containing the program entry point,
|
| 203 |
+
e.g., ``main``.
|
| 204 |
+
|
| 205 |
+
``LOG_DESCRIPTION <text>``
|
| 206 |
+
.. versionadded:: 3.26
|
| 207 |
+
|
| 208 |
+
Specify a non-empty text description of the purpose of the check.
|
| 209 |
+
This is recorded in the :manual:`cmake-configure-log(7)` entry.
|
| 210 |
+
|
| 211 |
+
``NO_CACHE``
|
| 212 |
+
.. versionadded:: 3.25
|
| 213 |
+
|
| 214 |
+
The result will be stored in a normal variable rather than a cache entry.
|
| 215 |
+
|
| 216 |
+
The result variable is normally cached so that a simple pattern can be used
|
| 217 |
+
to avoid repeating the test on subsequent executions of CMake:
|
| 218 |
+
|
| 219 |
+
.. code-block:: cmake
|
| 220 |
+
|
| 221 |
+
if(NOT DEFINED RESULTVAR)
|
| 222 |
+
# ...(check-specific setup code)...
|
| 223 |
+
try_compile(RESULTVAR ...)
|
| 224 |
+
# ...(check-specific logging and cleanup code)...
|
| 225 |
+
endif()
|
| 226 |
+
|
| 227 |
+
If the guard variable and result variable are not the same (for example, if
|
| 228 |
+
the test is part of a larger inspection), ``NO_CACHE`` may be useful to avoid
|
| 229 |
+
leaking the intermediate result variable into the cache.
|
| 230 |
+
|
| 231 |
+
``NO_LOG``
|
| 232 |
+
.. versionadded:: 3.26
|
| 233 |
+
|
| 234 |
+
Do not record a :manual:`cmake-configure-log(7)` entry for this call.
|
| 235 |
+
|
| 236 |
+
``OUTPUT_VARIABLE <var>``
|
| 237 |
+
Store the output from the build process in the given variable.
|
| 238 |
+
|
| 239 |
+
``SOURCE_FROM_CONTENT <name> <content>``
|
| 240 |
+
.. versionadded:: 3.25
|
| 241 |
+
|
| 242 |
+
Write ``<content>`` to a file named ``<name>`` in the operation directory.
|
| 243 |
+
This can be used to bypass the need to separately write a source file when
|
| 244 |
+
the contents of the file are dynamically specified. The specified ``<name>``
|
| 245 |
+
is not allowed to contain path components.
|
| 246 |
+
|
| 247 |
+
``SOURCE_FROM_CONTENT`` may be specified multiple times.
|
| 248 |
+
|
| 249 |
+
``SOURCE_FROM_FILE <name> <path>``
|
| 250 |
+
.. versionadded:: 3.25
|
| 251 |
+
|
| 252 |
+
Copy ``<path>`` to a file named ``<name>`` in the operation directory. This
|
| 253 |
+
can be used to consolidate files into the operation directory, which may be
|
| 254 |
+
useful if a source which already exists (i.e. as a stand-alone file in a
|
| 255 |
+
project's source repository) needs to refer to other file(s) created by
|
| 256 |
+
``SOURCE_FROM_*``. (Otherwise, ``SOURCES`` is usually more convenient.) The
|
| 257 |
+
specified ``<name>`` is not allowed to contain path components.
|
| 258 |
+
|
| 259 |
+
``SOURCE_FROM_VAR <name> <var>``
|
| 260 |
+
.. versionadded:: 3.25
|
| 261 |
+
|
| 262 |
+
Write the contents of ``<var>`` to a file named ``<name>`` in the operation
|
| 263 |
+
directory. This is the same as ``SOURCE_FROM_CONTENT``, but takes the
|
| 264 |
+
contents from the specified CMake variable, rather than directly, which may
|
| 265 |
+
be useful when passing arguments through a function which wraps
|
| 266 |
+
``try_compile``. The specified ``<name>`` is not allowed to contain path
|
| 267 |
+
components.
|
| 268 |
+
|
| 269 |
+
``SOURCE_FROM_VAR`` may be specified multiple times.
|
| 270 |
+
|
| 271 |
+
``SOURCES_TYPE <type>``
|
| 272 |
+
.. versionadded:: 3.28
|
| 273 |
+
|
| 274 |
+
Sources may be classified using the ``SOURCES_TYPE`` argument. Once
|
| 275 |
+
specified, all subsequent sources specified will be treated as that type
|
| 276 |
+
until another ``SOURCES_TYPE`` is given. Available types are:
|
| 277 |
+
|
| 278 |
+
``NORMAL``
|
| 279 |
+
Sources are not added to any ``FILE_SET`` in the generated project.
|
| 280 |
+
|
| 281 |
+
``CXX_MODULE``
|
| 282 |
+
.. versionadded:: 3.28
|
| 283 |
+
|
| 284 |
+
Sources are added to a ``FILE_SET`` of type ``CXX_MODULES`` in the
|
| 285 |
+
generated project.
|
| 286 |
+
|
| 287 |
+
The default type of sources is ``NORMAL``.
|
| 288 |
+
|
| 289 |
+
``<LANG>_STANDARD <std>``
|
| 290 |
+
.. versionadded:: 3.8
|
| 291 |
+
|
| 292 |
+
Specify the :prop_tgt:`C_STANDARD`, :prop_tgt:`CXX_STANDARD`,
|
| 293 |
+
:prop_tgt:`OBJC_STANDARD`, :prop_tgt:`OBJCXX_STANDARD`,
|
| 294 |
+
or :prop_tgt:`CUDA_STANDARD` target property of the generated project.
|
| 295 |
+
|
| 296 |
+
``<LANG>_STANDARD_REQUIRED <bool>``
|
| 297 |
+
.. versionadded:: 3.8
|
| 298 |
+
|
| 299 |
+
Specify the :prop_tgt:`C_STANDARD_REQUIRED`,
|
| 300 |
+
:prop_tgt:`CXX_STANDARD_REQUIRED`, :prop_tgt:`OBJC_STANDARD_REQUIRED`,
|
| 301 |
+
:prop_tgt:`OBJCXX_STANDARD_REQUIRED`,or :prop_tgt:`CUDA_STANDARD_REQUIRED`
|
| 302 |
+
target property of the generated project.
|
| 303 |
+
|
| 304 |
+
``<LANG>_EXTENSIONS <bool>``
|
| 305 |
+
.. versionadded:: 3.8
|
| 306 |
+
|
| 307 |
+
Specify the :prop_tgt:`C_EXTENSIONS`, :prop_tgt:`CXX_EXTENSIONS`,
|
| 308 |
+
:prop_tgt:`OBJC_EXTENSIONS`, :prop_tgt:`OBJCXX_EXTENSIONS`,
|
| 309 |
+
or :prop_tgt:`CUDA_EXTENSIONS` target property of the generated project.
|
| 310 |
+
|
| 311 |
+
Other Behavior Settings
|
| 312 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 313 |
+
|
| 314 |
+
.. versionadded:: 3.4
|
| 315 |
+
If set, the following variables are passed in to the generated
|
| 316 |
+
try_compile CMakeLists.txt to initialize compile target properties with
|
| 317 |
+
default values:
|
| 318 |
+
|
| 319 |
+
* :variable:`CMAKE_CUDA_RUNTIME_LIBRARY`
|
| 320 |
+
* :variable:`CMAKE_ENABLE_EXPORTS`
|
| 321 |
+
* :variable:`CMAKE_LINK_SEARCH_START_STATIC`
|
| 322 |
+
* :variable:`CMAKE_LINK_SEARCH_END_STATIC`
|
| 323 |
+
* :variable:`CMAKE_MSVC_RUNTIME_LIBRARY`
|
| 324 |
+
* :variable:`CMAKE_POSITION_INDEPENDENT_CODE`
|
| 325 |
+
* :variable:`CMAKE_WATCOM_RUNTIME_LIBRARY`
|
| 326 |
+
|
| 327 |
+
If :policy:`CMP0056` is set to ``NEW``, then
|
| 328 |
+
:variable:`CMAKE_EXE_LINKER_FLAGS` is passed in as well.
|
| 329 |
+
|
| 330 |
+
.. versionchanged:: 3.14
|
| 331 |
+
If :policy:`CMP0083` is set to ``NEW``, then in order to obtain correct
|
| 332 |
+
behavior at link time, the ``check_pie_supported()`` command from the
|
| 333 |
+
:module:`CheckPIESupported` module must be called before using the
|
| 334 |
+
``try_compile`` command.
|
| 335 |
+
|
| 336 |
+
The current settings of :policy:`CMP0065` and :policy:`CMP0083` are propagated
|
| 337 |
+
through to the generated test project.
|
| 338 |
+
|
| 339 |
+
Set variable :variable:`CMAKE_TRY_COMPILE_CONFIGURATION` to choose a build
|
| 340 |
+
configuration:
|
| 341 |
+
|
| 342 |
+
* For multi-config generators, this selects which configuration to build.
|
| 343 |
+
|
| 344 |
+
* For single-config generators, this sets :variable:`CMAKE_BUILD_TYPE` in
|
| 345 |
+
the test project.
|
| 346 |
+
|
| 347 |
+
.. versionadded:: 3.6
|
| 348 |
+
Set the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable to specify
|
| 349 |
+
the type of target used for the source file signature.
|
| 350 |
+
|
| 351 |
+
.. versionadded:: 3.6
|
| 352 |
+
Set the :variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable to specify
|
| 353 |
+
variables that must be propagated into the test project. This variable is
|
| 354 |
+
meant for use only in toolchain files and is only honored by the
|
| 355 |
+
``try_compile()`` command for the source files form, not when given a whole
|
| 356 |
+
project.
|
| 357 |
+
|
| 358 |
+
.. versionchanged:: 3.8
|
| 359 |
+
If :policy:`CMP0067` is set to ``NEW``, or any of the ``<LANG>_STANDARD``,
|
| 360 |
+
``<LANG>_STANDARD_REQUIRED``, or ``<LANG>_EXTENSIONS`` options are used,
|
| 361 |
+
then the language standard variables are honored:
|
| 362 |
+
|
| 363 |
+
* :variable:`CMAKE_C_STANDARD`
|
| 364 |
+
* :variable:`CMAKE_C_STANDARD_REQUIRED`
|
| 365 |
+
* :variable:`CMAKE_C_EXTENSIONS`
|
| 366 |
+
* :variable:`CMAKE_CXX_STANDARD`
|
| 367 |
+
* :variable:`CMAKE_CXX_STANDARD_REQUIRED`
|
| 368 |
+
* :variable:`CMAKE_CXX_EXTENSIONS`
|
| 369 |
+
* :variable:`CMAKE_OBJC_STANDARD`
|
| 370 |
+
* :variable:`CMAKE_OBJC_STANDARD_REQUIRED`
|
| 371 |
+
* :variable:`CMAKE_OBJC_EXTENSIONS`
|
| 372 |
+
* :variable:`CMAKE_OBJCXX_STANDARD`
|
| 373 |
+
* :variable:`CMAKE_OBJCXX_STANDARD_REQUIRED`
|
| 374 |
+
* :variable:`CMAKE_OBJCXX_EXTENSIONS`
|
| 375 |
+
* :variable:`CMAKE_CUDA_STANDARD`
|
| 376 |
+
* :variable:`CMAKE_CUDA_STANDARD_REQUIRED`
|
| 377 |
+
* :variable:`CMAKE_CUDA_EXTENSIONS`
|
| 378 |
+
|
| 379 |
+
Their values are used to set the corresponding target properties in
|
| 380 |
+
the generated project (unless overridden by an explicit option).
|
| 381 |
+
|
| 382 |
+
.. versionchanged:: 3.14
|
| 383 |
+
For the :generator:`Green Hills MULTI` generator, the GHS toolset and target
|
| 384 |
+
system customization cache variables are also propagated into the test
|
| 385 |
+
project.
|
| 386 |
+
|
| 387 |
+
.. versionadded:: 3.24
|
| 388 |
+
The :variable:`CMAKE_TRY_COMPILE_NO_PLATFORM_VARIABLES` variable may be
|
| 389 |
+
set to disable passing platform variables into the test project.
|
| 390 |
+
|
| 391 |
+
.. versionadded:: 3.25
|
| 392 |
+
If :policy:`CMP0141` is set to ``NEW``, one can use
|
| 393 |
+
:variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` to specify the MSVC debug
|
| 394 |
+
information format.
|
| 395 |
+
|
| 396 |
+
.. versionadded:: 3.30
|
| 397 |
+
If the :prop_gbl:`PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE` global
|
| 398 |
+
property is set to true, :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` is
|
| 399 |
+
propagated into the test project's build configuration when using the
|
| 400 |
+
:ref:`whole-project signature <Try Compiling Whole Projects>`.
|
| 401 |
+
|
| 402 |
+
See Also
|
| 403 |
+
^^^^^^^^
|
| 404 |
+
|
| 405 |
+
* :command:`try_run`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/unset.rst
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
unset
|
| 2 |
+
-----
|
| 3 |
+
|
| 4 |
+
Unset a variable, cache variable, or environment variable.
|
| 5 |
+
|
| 6 |
+
Unset Normal Variable or Cache Entry
|
| 7 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. code-block:: cmake
|
| 10 |
+
|
| 11 |
+
unset(<variable> [CACHE | PARENT_SCOPE])
|
| 12 |
+
|
| 13 |
+
Removes a normal variable from the current scope, causing it
|
| 14 |
+
to become undefined. If ``CACHE`` is present, then a cache variable
|
| 15 |
+
is removed instead of a normal variable.
|
| 16 |
+
|
| 17 |
+
If ``PARENT_SCOPE`` is present then the variable is removed from the scope
|
| 18 |
+
above the current scope. See the same option in the :command:`set` command
|
| 19 |
+
for further details.
|
| 20 |
+
|
| 21 |
+
.. include:: UNSET_NOTE.txt
|
| 22 |
+
|
| 23 |
+
Unset Environment Variable
|
| 24 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 25 |
+
|
| 26 |
+
.. code-block:: cmake
|
| 27 |
+
|
| 28 |
+
unset(ENV{<variable>})
|
| 29 |
+
|
| 30 |
+
Removes ``<variable>`` from the currently available
|
| 31 |
+
:manual:`Environment Variables <cmake-env-variables(7)>`.
|
| 32 |
+
Subsequent calls of ``$ENV{<variable>}`` will return the empty string.
|
| 33 |
+
|
| 34 |
+
This command affects only the current CMake process, not the process
|
| 35 |
+
from which CMake was called, nor the system environment at large,
|
| 36 |
+
nor the environment of subsequent build or test processes.
|
| 37 |
+
|
| 38 |
+
See Also
|
| 39 |
+
^^^^^^^^
|
| 40 |
+
|
| 41 |
+
* :command:`set`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/write_file.rst
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
write_file
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.0
|
| 5 |
+
|
| 6 |
+
Use the :command:`file(WRITE)` command instead.
|
| 7 |
+
|
| 8 |
+
.. code-block:: cmake
|
| 9 |
+
|
| 10 |
+
write_file(filename "message to write"... [APPEND])
|
| 11 |
+
|
| 12 |
+
The first argument is the file name, the rest of the arguments are
|
| 13 |
+
messages to write. If the argument ``APPEND`` is specified, then the
|
| 14 |
+
message will be appended.
|
| 15 |
+
|
| 16 |
+
NOTE 1: :command:`file(WRITE)` and :command:`file(APPEND)` do exactly
|
| 17 |
+
the same as this one but add some more functionality.
|
| 18 |
+
|
| 19 |
+
NOTE 2: When using ``write_file`` the produced file cannot be used as an
|
| 20 |
+
input to CMake (CONFIGURE_FILE, source file ...) because it will lead
|
| 21 |
+
to an infinite loop. Use :command:`configure_file` if you want to
|
| 22 |
+
generate input files to CMake.
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_chunk_grad_outputs_efficient_attention_ops.h
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Operator.h
|
| 4 |
+
|
| 5 |
+
#include <tuple>
|
| 6 |
+
#include <vector>
|
| 7 |
+
|
| 8 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 9 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 10 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 11 |
+
#include <ATen/core/ATen_fwd.h>
|
| 12 |
+
|
| 13 |
+
namespace at {
|
| 14 |
+
namespace _ops {
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
struct TORCH_API _chunk_grad_outputs_efficient_attention {
|
| 18 |
+
using schema = bool (const at::Tensor &, const at::Tensor &, const at::Tensor &, bool);
|
| 19 |
+
using ptr_schema = schema*;
|
| 20 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 21 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_chunk_grad_outputs_efficient_attention")
|
| 22 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 23 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_chunk_grad_outputs_efficient_attention(Tensor query, Tensor key, Tensor value, bool is_causal=False) -> bool")
|
| 24 |
+
static bool call(const at::Tensor & query, const at::Tensor & key, const at::Tensor & value, bool is_causal);
|
| 25 |
+
static bool redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & query, const at::Tensor & key, const at::Tensor & value, bool is_causal);
|
| 26 |
+
};
|
| 27 |
+
|
| 28 |
+
}} // namespace at::_ops
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_copy_from_and_resize_ops.h
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Operator.h
|
| 4 |
+
|
| 5 |
+
#include <tuple>
|
| 6 |
+
#include <vector>
|
| 7 |
+
|
| 8 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 9 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 10 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 11 |
+
#include <ATen/core/ATen_fwd.h>
|
| 12 |
+
|
| 13 |
+
namespace at {
|
| 14 |
+
namespace _ops {
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
struct TORCH_API _copy_from_and_resize {
|
| 18 |
+
using schema = at::Tensor (const at::Tensor &, const at::Tensor &);
|
| 19 |
+
using ptr_schema = schema*;
|
| 20 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 21 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_copy_from_and_resize")
|
| 22 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 23 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_copy_from_and_resize(Tensor self, Tensor dst) -> Tensor")
|
| 24 |
+
static at::Tensor call(const at::Tensor & self, const at::Tensor & dst);
|
| 25 |
+
static at::Tensor redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & self, const at::Tensor & dst);
|
| 26 |
+
};
|
| 27 |
+
|
| 28 |
+
struct TORCH_API _copy_from_and_resize_out {
|
| 29 |
+
using schema = at::Tensor & (const at::Tensor &, const at::Tensor &, at::Tensor &);
|
| 30 |
+
using ptr_schema = schema*;
|
| 31 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 32 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_copy_from_and_resize")
|
| 33 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "out")
|
| 34 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_copy_from_and_resize.out(Tensor self, Tensor dst, *, Tensor(a!) out) -> Tensor(a!)")
|
| 35 |
+
static at::Tensor & call(const at::Tensor & self, const at::Tensor & dst, at::Tensor & out);
|
| 36 |
+
static at::Tensor & redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & self, const at::Tensor & dst, at::Tensor & out);
|
| 37 |
+
};
|
| 38 |
+
|
| 39 |
+
}} // namespace at::_ops
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_dirichlet_grad_cuda_dispatch.h
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace cuda {
|
| 19 |
+
|
| 20 |
+
TORCH_API at::Tensor _dirichlet_grad(const at::Tensor & x, const at::Tensor & alpha, const at::Tensor & total);
|
| 21 |
+
|
| 22 |
+
} // namespace cuda
|
| 23 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_embedding_bag_ops.h
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Operator.h
|
| 4 |
+
|
| 5 |
+
#include <tuple>
|
| 6 |
+
#include <vector>
|
| 7 |
+
|
| 8 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 9 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 10 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 11 |
+
#include <ATen/core/ATen_fwd.h>
|
| 12 |
+
|
| 13 |
+
namespace at {
|
| 14 |
+
namespace _ops {
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
struct TORCH_API _embedding_bag {
|
| 18 |
+
using schema = ::std::tuple<at::Tensor,at::Tensor,at::Tensor,at::Tensor> (const at::Tensor &, const at::Tensor &, const at::Tensor &, bool, int64_t, bool, const c10::optional<at::Tensor> &, bool, int64_t);
|
| 19 |
+
using ptr_schema = schema*;
|
| 20 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 21 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_embedding_bag")
|
| 22 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 23 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_embedding_bag(Tensor weight, Tensor indices, Tensor offsets, bool scale_grad_by_freq=False, int mode=0, bool sparse=False, Tensor? per_sample_weights=None, bool include_last_offset=False, int padding_idx=-1) -> (Tensor, Tensor, Tensor, Tensor)")
|
| 24 |
+
static ::std::tuple<at::Tensor,at::Tensor,at::Tensor,at::Tensor> call(const at::Tensor & weight, const at::Tensor & indices, const at::Tensor & offsets, bool scale_grad_by_freq, int64_t mode, bool sparse, const c10::optional<at::Tensor> & per_sample_weights, bool include_last_offset, int64_t padding_idx);
|
| 25 |
+
static ::std::tuple<at::Tensor,at::Tensor,at::Tensor,at::Tensor> redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & weight, const at::Tensor & indices, const at::Tensor & offsets, bool scale_grad_by_freq, int64_t mode, bool sparse, const c10::optional<at::Tensor> & per_sample_weights, bool include_last_offset, int64_t padding_idx);
|
| 26 |
+
};
|
| 27 |
+
|
| 28 |
+
struct TORCH_API _embedding_bag_out {
|
| 29 |
+
using schema = ::std::tuple<at::Tensor &,at::Tensor &,at::Tensor &,at::Tensor &> (const at::Tensor &, const at::Tensor &, const at::Tensor &, bool, int64_t, bool, const c10::optional<at::Tensor> &, bool, int64_t, at::Tensor &, at::Tensor &, at::Tensor &, at::Tensor &);
|
| 30 |
+
using ptr_schema = schema*;
|
| 31 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 32 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_embedding_bag")
|
| 33 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "out")
|
| 34 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_embedding_bag.out(Tensor weight, Tensor indices, Tensor offsets, bool scale_grad_by_freq=False, int mode=0, bool sparse=False, Tensor? per_sample_weights=None, bool include_last_offset=False, int padding_idx=-1, *, Tensor(a!) out0, Tensor(b!) out1, Tensor(c!) out2, Tensor(d!) out3) -> (Tensor(a!), Tensor(b!), Tensor(c!), Tensor(d!))")
|
| 35 |
+
static ::std::tuple<at::Tensor &,at::Tensor &,at::Tensor &,at::Tensor &> call(const at::Tensor & weight, const at::Tensor & indices, const at::Tensor & offsets, bool scale_grad_by_freq, int64_t mode, bool sparse, const c10::optional<at::Tensor> & per_sample_weights, bool include_last_offset, int64_t padding_idx, at::Tensor & out0, at::Tensor & out1, at::Tensor & out2, at::Tensor & out3);
|
| 36 |
+
static ::std::tuple<at::Tensor &,at::Tensor &,at::Tensor &,at::Tensor &> redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & weight, const at::Tensor & indices, const at::Tensor & offsets, bool scale_grad_by_freq, int64_t mode, bool sparse, const c10::optional<at::Tensor> & per_sample_weights, bool include_last_offset, int64_t padding_idx, at::Tensor & out0, at::Tensor & out1, at::Tensor & out2, at::Tensor & out3);
|
| 37 |
+
};
|
| 38 |
+
|
| 39 |
+
}} // namespace at::_ops
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_fake_quantize_learnable_per_tensor_affine.h
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Function.h
|
| 4 |
+
|
| 5 |
+
#include <ATen/Context.h>
|
| 6 |
+
#include <ATen/DeviceGuard.h>
|
| 7 |
+
#include <ATen/TensorUtils.h>
|
| 8 |
+
#include <ATen/TracerMode.h>
|
| 9 |
+
#include <ATen/core/Generator.h>
|
| 10 |
+
#include <ATen/core/Reduction.h>
|
| 11 |
+
#include <ATen/core/Tensor.h>
|
| 12 |
+
#include <c10/core/Scalar.h>
|
| 13 |
+
#include <c10/core/Storage.h>
|
| 14 |
+
#include <c10/core/TensorOptions.h>
|
| 15 |
+
#include <c10/util/Deprecated.h>
|
| 16 |
+
#include <c10/util/Optional.h>
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
#include <ATen/ops/_fake_quantize_learnable_per_tensor_affine_ops.h>
|
| 21 |
+
|
| 22 |
+
namespace at {
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
// aten::_fake_quantize_learnable_per_tensor_affine(Tensor self, Tensor scale, Tensor zero_point, int quant_min, int quant_max, float grad_factor=1.0) -> Tensor
|
| 26 |
+
inline at::Tensor _fake_quantize_learnable_per_tensor_affine(const at::Tensor & self, const at::Tensor & scale, const at::Tensor & zero_point, int64_t quant_min, int64_t quant_max, double grad_factor=1.0) {
|
| 27 |
+
return at::_ops::_fake_quantize_learnable_per_tensor_affine::call(self, scale, zero_point, quant_min, quant_max, grad_factor);
|
| 28 |
+
}
|
| 29 |
+
|
| 30 |
+
// aten::_fake_quantize_learnable_per_tensor_affine.out(Tensor self, Tensor scale, Tensor zero_point, int quant_min, int quant_max, float grad_factor=1.0, *, Tensor(a!) out) -> Tensor(a!)
|
| 31 |
+
inline at::Tensor & _fake_quantize_learnable_per_tensor_affine_out(at::Tensor & out, const at::Tensor & self, const at::Tensor & scale, const at::Tensor & zero_point, int64_t quant_min, int64_t quant_max, double grad_factor=1.0) {
|
| 32 |
+
return at::_ops::_fake_quantize_learnable_per_tensor_affine_out::call(self, scale, zero_point, quant_min, quant_max, grad_factor, out);
|
| 33 |
+
}
|
| 34 |
+
// aten::_fake_quantize_learnable_per_tensor_affine.out(Tensor self, Tensor scale, Tensor zero_point, int quant_min, int quant_max, float grad_factor=1.0, *, Tensor(a!) out) -> Tensor(a!)
|
| 35 |
+
inline at::Tensor & _fake_quantize_learnable_per_tensor_affine_outf(const at::Tensor & self, const at::Tensor & scale, const at::Tensor & zero_point, int64_t quant_min, int64_t quant_max, double grad_factor, at::Tensor & out) {
|
| 36 |
+
return at::_ops::_fake_quantize_learnable_per_tensor_affine_out::call(self, scale, zero_point, quant_min, quant_max, grad_factor, out);
|
| 37 |
+
}
|
| 38 |
+
|
| 39 |
+
}
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_foreach_tanh_ops.h
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Operator.h
|
| 4 |
+
|
| 5 |
+
#include <tuple>
|
| 6 |
+
#include <vector>
|
| 7 |
+
|
| 8 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 9 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 10 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 11 |
+
#include <ATen/core/ATen_fwd.h>
|
| 12 |
+
|
| 13 |
+
namespace at {
|
| 14 |
+
namespace _ops {
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
struct TORCH_API _foreach_tanh {
|
| 18 |
+
using schema = ::std::vector<at::Tensor> (at::TensorList);
|
| 19 |
+
using ptr_schema = schema*;
|
| 20 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 21 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_foreach_tanh")
|
| 22 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 23 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_foreach_tanh(Tensor[] self) -> Tensor[]")
|
| 24 |
+
static ::std::vector<at::Tensor> call(at::TensorList self);
|
| 25 |
+
static ::std::vector<at::Tensor> redispatch(c10::DispatchKeySet dispatchKeySet, at::TensorList self);
|
| 26 |
+
};
|
| 27 |
+
|
| 28 |
+
struct TORCH_API _foreach_tanh_ {
|
| 29 |
+
using schema = void (at::TensorList);
|
| 30 |
+
using ptr_schema = schema*;
|
| 31 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 32 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_foreach_tanh_")
|
| 33 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 34 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_foreach_tanh_(Tensor(a!)[] self) -> ()")
|
| 35 |
+
static void call(at::TensorList self);
|
| 36 |
+
static void redispatch(c10::DispatchKeySet dispatchKeySet, at::TensorList self);
|
| 37 |
+
};
|
| 38 |
+
|
| 39 |
+
struct TORCH_API _foreach_tanh_out {
|
| 40 |
+
using schema = void (at::TensorList, at::TensorList);
|
| 41 |
+
using ptr_schema = schema*;
|
| 42 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 43 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_foreach_tanh")
|
| 44 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "out")
|
| 45 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_foreach_tanh.out(Tensor[] self, *, Tensor(a!)[] out) -> ()")
|
| 46 |
+
static void call(at::TensorList self, at::TensorList out);
|
| 47 |
+
static void redispatch(c10::DispatchKeySet dispatchKeySet, at::TensorList self, at::TensorList out);
|
| 48 |
+
};
|
| 49 |
+
|
| 50 |
+
}} // namespace at::_ops
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_fused_moving_avg_obs_fq_helper_cuda_dispatch.h
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace cuda {
|
| 19 |
+
|
| 20 |
+
TORCH_API ::std::tuple<at::Tensor,at::Tensor> _fused_moving_avg_obs_fq_helper(const at::Tensor & self, const at::Tensor & observer_on, const at::Tensor & fake_quant_on, at::Tensor & running_min, at::Tensor & running_max, at::Tensor & scale, at::Tensor & zero_point, double averaging_const, int64_t quant_min, int64_t quant_max, int64_t ch_axis, bool per_row_fake_quant=false, bool symmetric_quant=false);
|
| 21 |
+
|
| 22 |
+
} // namespace cuda
|
| 23 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_has_compatible_shallow_copy_type_native.h
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from NativeFunction.h
|
| 4 |
+
|
| 5 |
+
#include <c10/core/Scalar.h>
|
| 6 |
+
#include <c10/core/Storage.h>
|
| 7 |
+
#include <c10/core/TensorOptions.h>
|
| 8 |
+
#include <c10/util/Deprecated.h>
|
| 9 |
+
#include <c10/util/Optional.h>
|
| 10 |
+
#include <c10/core/QScheme.h>
|
| 11 |
+
#include <ATen/core/Reduction.h>
|
| 12 |
+
#include <ATen/core/Tensor.h>
|
| 13 |
+
#include <tuple>
|
| 14 |
+
#include <vector>
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
namespace at {
|
| 18 |
+
namespace native {
|
| 19 |
+
TORCH_API bool _has_compatible_shallow_copy_type(const at::Tensor & self, const at::Tensor & from);
|
| 20 |
+
} // namespace native
|
| 21 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_indices_copy_compositeexplicitautogradnonfunctional_dispatch.h
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace compositeexplicitautogradnonfunctional {
|
| 19 |
+
|
| 20 |
+
TORCH_API at::Tensor _indices_copy(const at::Tensor & self);
|
| 21 |
+
|
| 22 |
+
} // namespace compositeexplicitautogradnonfunctional
|
| 23 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_linalg_slogdet_cuda_dispatch.h
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace cuda {
|
| 19 |
+
|
| 20 |
+
TORCH_API ::std::tuple<at::Tensor,at::Tensor,at::Tensor,at::Tensor> _linalg_slogdet(const at::Tensor & A);
|
| 21 |
+
TORCH_API ::std::tuple<at::Tensor &,at::Tensor &,at::Tensor &,at::Tensor &> _linalg_slogdet_out(at::Tensor & sign, at::Tensor & logabsdet, at::Tensor & LU, at::Tensor & pivots, const at::Tensor & A);
|
| 22 |
+
TORCH_API ::std::tuple<at::Tensor &,at::Tensor &,at::Tensor &,at::Tensor &> _linalg_slogdet_outf(const at::Tensor & A, at::Tensor & sign, at::Tensor & logabsdet, at::Tensor & LU, at::Tensor & pivots);
|
| 23 |
+
|
| 24 |
+
} // namespace cuda
|
| 25 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_masked_softmax_backward_ops.h
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Operator.h
|
| 4 |
+
|
| 5 |
+
#include <tuple>
|
| 6 |
+
#include <vector>
|
| 7 |
+
|
| 8 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 9 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 10 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 11 |
+
#include <ATen/core/ATen_fwd.h>
|
| 12 |
+
|
| 13 |
+
namespace at {
|
| 14 |
+
namespace _ops {
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
struct TORCH_API _masked_softmax_backward {
|
| 18 |
+
using schema = at::Tensor (const at::Tensor &, const at::Tensor &, const at::Tensor &, c10::optional<int64_t>);
|
| 19 |
+
using ptr_schema = schema*;
|
| 20 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 21 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_masked_softmax_backward")
|
| 22 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "")
|
| 23 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_masked_softmax_backward(Tensor grad_output, Tensor output, Tensor mask, int? dim=None) -> Tensor")
|
| 24 |
+
static at::Tensor call(const at::Tensor & grad_output, const at::Tensor & output, const at::Tensor & mask, c10::optional<int64_t> dim);
|
| 25 |
+
static at::Tensor redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & grad_output, const at::Tensor & output, const at::Tensor & mask, c10::optional<int64_t> dim);
|
| 26 |
+
};
|
| 27 |
+
|
| 28 |
+
struct TORCH_API _masked_softmax_backward_out {
|
| 29 |
+
using schema = at::Tensor & (const at::Tensor &, const at::Tensor &, const at::Tensor &, c10::optional<int64_t>, at::Tensor &);
|
| 30 |
+
using ptr_schema = schema*;
|
| 31 |
+
// See Note [static constexpr char* members for windows NVCC]
|
| 32 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(name, "aten::_masked_softmax_backward")
|
| 33 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(overload_name, "out")
|
| 34 |
+
STATIC_CONSTEXPR_STR_INL_EXCEPT_WIN_CUDA(schema_str, "_masked_softmax_backward.out(Tensor grad_output, Tensor output, Tensor mask, int? dim=None, *, Tensor(a!) out) -> Tensor(a!)")
|
| 35 |
+
static at::Tensor & call(const at::Tensor & grad_output, const at::Tensor & output, const at::Tensor & mask, c10::optional<int64_t> dim, at::Tensor & out);
|
| 36 |
+
static at::Tensor & redispatch(c10::DispatchKeySet dispatchKeySet, const at::Tensor & grad_output, const at::Tensor & output, const at::Tensor & mask, c10::optional<int64_t> dim, at::Tensor & out);
|
| 37 |
+
};
|
| 38 |
+
|
| 39 |
+
}} // namespace at::_ops
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_prelu_kernel_backward_cuda_dispatch.h
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace cuda {
|
| 19 |
+
|
| 20 |
+
TORCH_API ::std::tuple<at::Tensor,at::Tensor> _prelu_kernel_backward(const at::Tensor & grad_output, const at::Tensor & self, const at::Tensor & weight);
|
| 21 |
+
|
| 22 |
+
} // namespace cuda
|
| 23 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_sparse_coo_tensor_with_dims_and_tensors_meta_dispatch.h
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace meta {
|
| 19 |
+
|
| 20 |
+
TORCH_API at::Tensor _sparse_coo_tensor_with_dims_and_tensors(int64_t sparse_dim, int64_t dense_dim, at::IntArrayRef size, const at::Tensor & indices, const at::Tensor & values, at::TensorOptions options);
|
| 21 |
+
TORCH_API at::Tensor _sparse_coo_tensor_with_dims_and_tensors(int64_t sparse_dim, int64_t dense_dim, at::IntArrayRef size, const at::Tensor & indices, const at::Tensor & values, c10::optional<at::ScalarType> dtype, c10::optional<at::Layout> layout, c10::optional<at::Device> device, c10::optional<bool> pin_memory);
|
| 22 |
+
TORCH_API at::Tensor _sparse_coo_tensor_with_dims_and_tensors_symint(int64_t sparse_dim, int64_t dense_dim, c10::SymIntArrayRef size, const at::Tensor & indices, const at::Tensor & values, at::TensorOptions options);
|
| 23 |
+
TORCH_API at::Tensor _sparse_coo_tensor_with_dims_and_tensors_symint(int64_t sparse_dim, int64_t dense_dim, c10::SymIntArrayRef size, const at::Tensor & indices, const at::Tensor & values, c10::optional<at::ScalarType> dtype, c10::optional<at::Layout> layout, c10::optional<at::Device> device, c10::optional<bool> pin_memory);
|
| 24 |
+
|
| 25 |
+
} // namespace meta
|
| 26 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_upsample_bilinear2d_aa_meta_dispatch.h
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace meta {
|
| 19 |
+
|
| 20 |
+
TORCH_API at::Tensor _upsample_bilinear2d_aa(const at::Tensor & self, at::IntArrayRef output_size, bool align_corners, c10::optional<double> scales_h=c10::nullopt, c10::optional<double> scales_w=c10::nullopt);
|
| 21 |
+
TORCH_API at::Tensor _upsample_bilinear2d_aa_symint(const at::Tensor & self, c10::SymIntArrayRef output_size, bool align_corners, c10::optional<double> scales_h=c10::nullopt, c10::optional<double> scales_w=c10::nullopt);
|
| 22 |
+
TORCH_API at::Tensor & _upsample_bilinear2d_aa_out(at::Tensor & out, const at::Tensor & self, at::IntArrayRef output_size, bool align_corners, c10::optional<double> scales_h=c10::nullopt, c10::optional<double> scales_w=c10::nullopt);
|
| 23 |
+
TORCH_API at::Tensor & _upsample_bilinear2d_aa_outf(const at::Tensor & self, at::IntArrayRef output_size, bool align_corners, c10::optional<double> scales_h, c10::optional<double> scales_w, at::Tensor & out);
|
| 24 |
+
TORCH_API at::Tensor & _upsample_bilinear2d_aa_symint_out(at::Tensor & out, const at::Tensor & self, c10::SymIntArrayRef output_size, bool align_corners, c10::optional<double> scales_h=c10::nullopt, c10::optional<double> scales_w=c10::nullopt);
|
| 25 |
+
TORCH_API at::Tensor & _upsample_bilinear2d_aa_symint_outf(const at::Tensor & self, c10::SymIntArrayRef output_size, bool align_corners, c10::optional<double> scales_h, c10::optional<double> scales_w, at::Tensor & out);
|
| 26 |
+
|
| 27 |
+
} // namespace meta
|
| 28 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/_upsample_nearest_exact1d.h
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from Function.h
|
| 4 |
+
|
| 5 |
+
#include <ATen/Context.h>
|
| 6 |
+
#include <ATen/DeviceGuard.h>
|
| 7 |
+
#include <ATen/TensorUtils.h>
|
| 8 |
+
#include <ATen/TracerMode.h>
|
| 9 |
+
#include <ATen/core/Generator.h>
|
| 10 |
+
#include <ATen/core/Reduction.h>
|
| 11 |
+
#include <ATen/core/Tensor.h>
|
| 12 |
+
#include <c10/core/Scalar.h>
|
| 13 |
+
#include <c10/core/Storage.h>
|
| 14 |
+
#include <c10/core/TensorOptions.h>
|
| 15 |
+
#include <c10/util/Deprecated.h>
|
| 16 |
+
#include <c10/util/Optional.h>
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
#include <ATen/ops/_upsample_nearest_exact1d_ops.h>
|
| 21 |
+
|
| 22 |
+
namespace at {
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
// aten::_upsample_nearest_exact1d.vec(Tensor input, SymInt[]? output_size, float[]? scale_factors) -> Tensor
|
| 26 |
+
inline at::Tensor _upsample_nearest_exact1d(const at::Tensor & input, at::OptionalIntArrayRef output_size, c10::optional<at::ArrayRef<double>> scale_factors) {
|
| 27 |
+
return at::_ops::_upsample_nearest_exact1d_vec::call(input, output_size.has_value() ? c10::make_optional(c10::fromIntArrayRefSlow(*output_size)) : c10::nullopt, scale_factors);
|
| 28 |
+
}
|
| 29 |
+
namespace symint {
|
| 30 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, int64_t>::value>>
|
| 31 |
+
at::Tensor _upsample_nearest_exact1d(const at::Tensor & input, at::OptionalIntArrayRef output_size, c10::optional<at::ArrayRef<double>> scale_factors) {
|
| 32 |
+
return at::_ops::_upsample_nearest_exact1d_vec::call(input, output_size.has_value() ? c10::make_optional(c10::fromIntArrayRefSlow(*output_size)) : c10::nullopt, scale_factors);
|
| 33 |
+
}
|
| 34 |
+
}
|
| 35 |
+
|
| 36 |
+
// aten::_upsample_nearest_exact1d.vec(Tensor input, SymInt[]? output_size, float[]? scale_factors) -> Tensor
|
| 37 |
+
inline at::Tensor _upsample_nearest_exact1d_symint(const at::Tensor & input, at::OptionalSymIntArrayRef output_size, c10::optional<at::ArrayRef<double>> scale_factors) {
|
| 38 |
+
return at::_ops::_upsample_nearest_exact1d_vec::call(input, output_size, scale_factors);
|
| 39 |
+
}
|
| 40 |
+
namespace symint {
|
| 41 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, c10::SymInt>::value>>
|
| 42 |
+
at::Tensor _upsample_nearest_exact1d(const at::Tensor & input, at::OptionalSymIntArrayRef output_size, c10::optional<at::ArrayRef<double>> scale_factors) {
|
| 43 |
+
return at::_ops::_upsample_nearest_exact1d_vec::call(input, output_size, scale_factors);
|
| 44 |
+
}
|
| 45 |
+
}
|
| 46 |
+
|
| 47 |
+
// aten::_upsample_nearest_exact1d.out(Tensor self, SymInt[1] output_size, float? scales=None, *, Tensor(a!) out) -> Tensor(a!)
|
| 48 |
+
inline at::Tensor & _upsample_nearest_exact1d_out(at::Tensor & out, const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 49 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, c10::fromIntArrayRefSlow(output_size), scales, out);
|
| 50 |
+
}
|
| 51 |
+
namespace symint {
|
| 52 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, int64_t>::value>>
|
| 53 |
+
at::Tensor & _upsample_nearest_exact1d_out(at::Tensor & out, const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 54 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, c10::fromIntArrayRefSlow(output_size), scales, out);
|
| 55 |
+
}
|
| 56 |
+
}
|
| 57 |
+
|
| 58 |
+
// aten::_upsample_nearest_exact1d.out(Tensor self, SymInt[1] output_size, float? scales=None, *, Tensor(a!) out) -> Tensor(a!)
|
| 59 |
+
inline at::Tensor & _upsample_nearest_exact1d_outf(const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales, at::Tensor & out) {
|
| 60 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, c10::fromIntArrayRefSlow(output_size), scales, out);
|
| 61 |
+
}
|
| 62 |
+
namespace symint {
|
| 63 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, int64_t>::value>>
|
| 64 |
+
at::Tensor & _upsample_nearest_exact1d_outf(const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales, at::Tensor & out) {
|
| 65 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, c10::fromIntArrayRefSlow(output_size), scales, out);
|
| 66 |
+
}
|
| 67 |
+
}
|
| 68 |
+
|
| 69 |
+
// aten::_upsample_nearest_exact1d.out(Tensor self, SymInt[1] output_size, float? scales=None, *, Tensor(a!) out) -> Tensor(a!)
|
| 70 |
+
inline at::Tensor & _upsample_nearest_exact1d_symint_out(at::Tensor & out, const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 71 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, output_size, scales, out);
|
| 72 |
+
}
|
| 73 |
+
namespace symint {
|
| 74 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, c10::SymInt>::value>>
|
| 75 |
+
at::Tensor & _upsample_nearest_exact1d_out(at::Tensor & out, const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 76 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, output_size, scales, out);
|
| 77 |
+
}
|
| 78 |
+
}
|
| 79 |
+
|
| 80 |
+
// aten::_upsample_nearest_exact1d.out(Tensor self, SymInt[1] output_size, float? scales=None, *, Tensor(a!) out) -> Tensor(a!)
|
| 81 |
+
inline at::Tensor & _upsample_nearest_exact1d_symint_outf(const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales, at::Tensor & out) {
|
| 82 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, output_size, scales, out);
|
| 83 |
+
}
|
| 84 |
+
namespace symint {
|
| 85 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, c10::SymInt>::value>>
|
| 86 |
+
at::Tensor & _upsample_nearest_exact1d_outf(const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales, at::Tensor & out) {
|
| 87 |
+
return at::_ops::_upsample_nearest_exact1d_out::call(self, output_size, scales, out);
|
| 88 |
+
}
|
| 89 |
+
}
|
| 90 |
+
|
| 91 |
+
// aten::_upsample_nearest_exact1d(Tensor self, SymInt[1] output_size, float? scales=None) -> Tensor
|
| 92 |
+
inline at::Tensor _upsample_nearest_exact1d(const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 93 |
+
return at::_ops::_upsample_nearest_exact1d::call(self, c10::fromIntArrayRefSlow(output_size), scales);
|
| 94 |
+
}
|
| 95 |
+
namespace symint {
|
| 96 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, int64_t>::value>>
|
| 97 |
+
at::Tensor _upsample_nearest_exact1d(const at::Tensor & self, at::IntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 98 |
+
return at::_ops::_upsample_nearest_exact1d::call(self, c10::fromIntArrayRefSlow(output_size), scales);
|
| 99 |
+
}
|
| 100 |
+
}
|
| 101 |
+
|
| 102 |
+
// aten::_upsample_nearest_exact1d(Tensor self, SymInt[1] output_size, float? scales=None) -> Tensor
|
| 103 |
+
inline at::Tensor _upsample_nearest_exact1d_symint(const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 104 |
+
return at::_ops::_upsample_nearest_exact1d::call(self, output_size, scales);
|
| 105 |
+
}
|
| 106 |
+
namespace symint {
|
| 107 |
+
template <typename T, typename = std::enable_if_t<std::is_same<T, c10::SymInt>::value>>
|
| 108 |
+
at::Tensor _upsample_nearest_exact1d(const at::Tensor & self, c10::SymIntArrayRef output_size, c10::optional<double> scales=c10::nullopt) {
|
| 109 |
+
return at::_ops::_upsample_nearest_exact1d::call(self, output_size, scales);
|
| 110 |
+
}
|
| 111 |
+
}
|
| 112 |
+
|
| 113 |
+
}
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/adaptive_max_pool3d_backward_cpu_dispatch.h
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
// @generated by torchgen/gen.py from DispatchKeyFunction.h
|
| 3 |
+
|
| 4 |
+
// NB: The implementing C++ file is RegisterDispatchKey.cpp
|
| 5 |
+
|
| 6 |
+
// The only #includes we need are for custom classes that have defaults in the C++ API
|
| 7 |
+
#include <c10/core/MemoryFormat.h>
|
| 8 |
+
#include <c10/core/Scalar.h>
|
| 9 |
+
#include <ATen/core/Reduction.h>
|
| 10 |
+
|
| 11 |
+
// Forward declarations of any types needed in the operator signatures.
|
| 12 |
+
// We can't directly include these classes because it will cause circular include dependencies.
|
| 13 |
+
// This file is included by TensorBody.h, which defines the Tensor class.
|
| 14 |
+
#include <ATen/core/ATen_fwd.h>
|
| 15 |
+
|
| 16 |
+
namespace at {
|
| 17 |
+
|
| 18 |
+
namespace cpu {
|
| 19 |
+
|
| 20 |
+
TORCH_API at::Tensor adaptive_max_pool3d_backward(const at::Tensor & grad_output, const at::Tensor & self, const at::Tensor & indices);
|
| 21 |
+
TORCH_API at::Tensor & adaptive_max_pool3d_backward_out(at::Tensor & grad_input, const at::Tensor & grad_output, const at::Tensor & self, const at::Tensor & indices);
|
| 22 |
+
TORCH_API at::Tensor & adaptive_max_pool3d_backward_outf(const at::Tensor & grad_output, const at::Tensor & self, const at::Tensor & indices, at::Tensor & grad_input);
|
| 23 |
+
|
| 24 |
+
} // namespace cpu
|
| 25 |
+
} // namespace at
|
wemm/lib/python3.10/site-packages/torch/include/ATen/ops/arccosh_native.h
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#pragma once
|
| 2 |
+
|
| 3 |
+
// @generated by torchgen/gen.py from NativeFunction.h
|
| 4 |
+
|
| 5 |
+
#include <c10/core/Scalar.h>
|
| 6 |
+
#include <c10/core/Storage.h>
|
| 7 |
+
#include <c10/core/TensorOptions.h>
|
| 8 |
+
#include <c10/util/Deprecated.h>
|
| 9 |
+
#include <c10/util/Optional.h>
|
| 10 |
+
#include <c10/core/QScheme.h>
|
| 11 |
+
#include <ATen/core/Reduction.h>
|
| 12 |
+
#include <ATen/core/Tensor.h>
|
| 13 |
+
#include <tuple>
|
| 14 |
+
#include <vector>
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
namespace at {
|
| 18 |
+
namespace native {
|
| 19 |
+
TORCH_API at::Tensor arccosh(const at::Tensor & self);
|
| 20 |
+
TORCH_API at::Tensor & arccosh_out(const at::Tensor & self, at::Tensor & out);
|
| 21 |
+
TORCH_API at::Tensor & arccosh_(at::Tensor & self);
|
| 22 |
+
} // namespace native
|
| 23 |
+
} // namespace at
|