dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-08-12 12:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3d82ccbe0d90ed957ccc014d44993ead2bacd66f
CMake/Help/command
History
Matthew Woehlke 3d82ccbe0d Help: Add roles to abbreviate command-line options 
Add a handful of helper roles that allow many more command-line option
references to be written without explicit targets. Specifically, what
used to be written ':option:`--foo[=bar] <program --foo>` can now be
written ':program-option:`--foo`'. This allows many such references to
be significantly shortened.

For now, supported programs are 'cmake', 'cpack'. 'ctest',
'cmake--build' and 'cmake--install', which should cover most cases, but
more can be trivially added. Additionally, this does not make a
concerted effort to replace all existing uses, as it is intended mainly
for use in future updates.
2026-03-31 12:56:16 -04:00
..
include
Help: Clarify what policies a "policy version" sets to NEW
2026-02-27 16:57:36 -05:00
add_compile_definitions.rst
Help: Use *.rst extension for included files
2025-04-14 03:07:46 +04:00
add_compile_options.rst
Check{,C,CXX,Fortran,OBJC,OBJCXX}CompilerFlag: Update documentation
2025-05-29 00:16:39 +02:00
add_custom_command.rst
add_custom_command: Disallow exe-suffixed targets in DEPENDS
2026-03-23 09:50:46 -04:00
add_custom_target.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
add_definitions.rst
Help: Add _See Also_ sections to related CMake commands
2022-11-09 23:52:30 +04:00
add_dependencies.rst
add_dependencies: Allow calling with no dependencies
2025-02-24 13:56:31 -05:00
add_executable.rst
Help: Add cmake-buildsystem(7) subsections for each binary target type
2024-12-13 09:53:26 -05:00
add_library.rst
CPS: Add Symbolic Components
2025-10-02 10:46:02 -04:00
add_link_options.rst
Help: Use *.rst extension for included files
2025-04-14 03:07:46 +04:00
add_subdirectory.rst
Help: improve docs for the EXCLUDE_FROM_ALL directory property
2024-06-04 16:58:54 +02:00
add_test.rst
Help: The old add_test() form does not support TEST_LAUNCHER
2025-07-28 08:20:00 +02:00
aux_source_directory.rst
Help: Improve documentation links and formatting
2019-03-27 16:01:20 +01:00
block.rst
Diagnostics: Implement diagnostic stack
2026-03-18 14:32:21 -04:00
break.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
build_command.rst
Help: Add roles to abbreviate command-line options
2026-03-31 12:56:16 -04:00
build_name.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
cmake_diagnostic.rst
Diagnostics: Add cmake_diagnostic command
2026-03-19 11:29:44 -04:00
cmake_file_api.rst
cmake_file_api: New project command
2023-06-05 06:20:50 -04:00
cmake_host_system_information.rst
cmake_host_system_information: Add query for the locale's charset
2026-02-11 11:56:05 -05:00
cmake_instrumentation.rst
Experimental: Remove Instrumentation experimental gating
2026-02-05 14:05:42 -05:00
cmake_language.rst
Help: Fix cmake_language(TRACE) command anchor
2025-10-01 09:23:33 -04:00
cmake_minimum_required.rst
Help: Be more explicit about what ...<policy_max> does not mean
2025-12-02 15:25:47 -05:00
cmake_parse_arguments.rst
Help: Recommend good prefixes for cmake_parse_arguments, expand example
2024-08-31 18:33:14 +10:00
cmake_path.rst
Help/cmake_path: Clarify output variable behavior
2026-02-12 12:50:51 -05:00
cmake_pkg_config.rst
PkgC: Add NAME and PREFIX
2025-03-14 15:17:27 -04:00
cmake_policy.rst
Help: Be more explicit about what ...<policy_max> does not mean
2025-12-02 15:25:47 -05:00
configure_file.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
continue.rst
Help: clean up and clarify block() and return()
2022-11-08 00:05:55 +11:00
create_test_sourcelist.rst
TestDriver: Add '-N' option to print all tests
2026-03-26 10:36:22 -04:00
ctest_build.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_configure.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_coverage.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_empty_binary_directory.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_memcheck.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_read_custom_files.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_run_script.rst
CTest: Remove declarative scripting mode
2024-10-09 22:30:58 +02:00
ctest_sleep.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_start.rst
CTEST_CVS_CHECKOUT: Add deprecated directive to docs
2025-03-24 01:06:29 +01:00
ctest_submit.rst
Help: Convert some literal blocks into tables and lists
2025-01-31 12:23:29 -05:00
ctest_test.rst
Help: Fix typos in versionadded directives
2025-09-23 20:53:21 +02:00
ctest_update.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
ctest_upload.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
define_property.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
discover_tests.rst
discover_tests: Add documentation
2026-03-26 10:36:22 -04:00
else.rst
Remove optional arguments from else() and end*() commands
2025-01-28 03:01:23 +01:00
elseif.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
enable_language.rst
Help: Document that enable_language cannot be used in block()
2026-01-13 11:16:54 -05:00
enable_testing.rst
enable_testing: Update docs
2026-02-04 17:32:54 +01:00
endblock.rst
Add new flow-control commands for variables and policies scopes management
2022-08-22 16:25:53 +02:00
endforeach.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
endfunction.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
endif.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
endmacro.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
endwhile.rst
Help: Revise docs on Scripting Commands
2018-10-23 15:12:10 +02:00
exec_program.rst
exec_program: Add example how to upgrade to execute_process()
2025-04-17 01:02:47 +02:00
execute_process.rst
execute_process: Add options for modified environment
2026-03-12 19:17:24 +01:00
export_library_dependencies.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
export.rst
CPS: Remove experimental gate (mostly)
2026-02-11 16:10:29 -05:00
file.rst
file: Add ARCHIVE_* options to specify pathname encoding
2026-03-24 14:07:21 -04:00
find_file.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
find_library.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
find_package.rst
find_package: Clarify CPS search priority
2026-03-18 17:36:20 -04:00
find_path.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
find_program.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
fltk_wrap_ui.rst
Help: Remove stray spaces and one colon
2025-01-31 12:23:29 -05:00
foreach.rst
Help: Improve clarity of foreach behavior
2025-08-13 16:29:18 -04:00
function.rst
Help: Add _See Also_ sections to related CMake commands
2022-11-09 23:52:30 +04:00
get_cmake_property.rst
Help: Use <variable> consistently in property getter commands
2024-01-05 15:37:39 +11:00
get_directory_property.rst
Help: Add _See Also_ sections to related CMake commands
2022-11-09 23:52:30 +04:00
get_filename_component.rst
Help: Improve formatting for cmake_host_system_information
2026-01-15 20:30:17 -05:00
get_property.rst
FILE_SET: properties management
2026-01-27 18:15:26 +01:00
get_source_file_property.rst
Help: Fix wrong return values for unset inherited properties
2024-01-05 17:40:16 +11:00
get_target_property.rst
Help: Fix wrong return values for unset inherited properties
2024-01-05 17:40:16 +11:00
get_test_property.rst
Help: Fix wrong return values for unset inherited properties
2024-01-05 17:40:16 +11:00
if.rst
Help: Use signature directive for cmake_path command
2025-10-08 20:44:38 -04:00
include_directories.rst
Help: Use *.rst extension for included files
2025-04-14 03:07:46 +04:00
include_external_msproject.rst
Help: Explicitly state include_external_msproject is only for VS generators
2024-09-25 07:24:32 -04:00
include_guard.rst
Help: remove links from pages to themselves
2022-11-18 14:09:32 -05:00
include_regular_expression.rst
Help: Convert some literal blocks into tables and lists
2025-01-31 12:23:29 -05:00
include.rst
Diagnostics: Implement diagnostic stack
2026-03-18 14:32:21 -04:00
install_files.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
install_programs.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
install_targets.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
install.rst
Merge topic 'patch-sbom-2'
2026-03-23 10:33:32 -04:00
link_directories.rst
Help: add and make references to generators consistent
2025-06-12 21:25:24 +02:00
link_libraries.rst
Help: Apply syntax highlighting to project commands
2018-10-25 13:47:31 +02:00
list.rst
regex: Match ^ at most once in repeated searches
2025-02-13 20:00:02 +05:00
load_cache.rst
load_cache: Add note about export()
2025-01-28 15:22:29 +01:00
load_command.rst
Help: Convert some literal blocks into tables and lists
2025-01-31 12:23:29 -05:00
macro.rst
Help: Clarify argument handling for macros
2026-02-02 10:36:59 -05:00
make_directory.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
mark_as_advanced.rst
Help: Replace some versionadded directives with versionchanged
2020-11-12 09:44:01 +05:00
math.rst
Help: math: note that floating point inputs are invalid
2023-02-14 13:33:31 -05:00
message.rst
message: Add CONFIGURE_LOG mode to record a message in the configure log
2023-01-18 11:37:11 -05:00
option.rst
CMakeDependentOption: Sync documentation
2025-05-12 21:10:29 +02:00
output_required_files.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
project.rst
CPS: Remove experimental gate (mostly)
2026-02-11 16:10:29 -05:00
qt_wrap_cpp.rst
Autogen: Replace documentation links with their permanent redirects
2025-05-28 11:11:20 -04:00
qt_wrap_ui.rst
qt_wrap_*: Add deprecation notes to command docs
2019-01-16 08:08:38 +11:00
remove_definitions.rst
remove_definitions: Update documentation
2025-10-21 22:23:15 +02:00
remove.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
return.rst
Help: Fix example for return command
2024-02-15 10:42:25 -05:00
separate_arguments.rst
Help: Remove accidental blockquotes around lists
2025-01-31 12:23:29 -05:00
set_directory_properties.rst
Help: Use <xxx> for non-keyword arguments in property command signatures
2024-01-05 15:31:39 +11:00
set_property.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
set_source_files_properties.rst
Help: Remove accidental blockquotes around lists
2025-01-31 12:23:29 -05:00
set_target_properties.rst
Help: Use <xxx> for non-keyword arguments in property command signatures
2024-01-05 15:31:39 +11:00
set_tests_properties.rst
Help: Add missing DIRECTORY keyword to set_tests_properties() signature
2024-01-05 16:45:27 +11:00
set.rst
set/unset commands: add CACHE{variable} syntax support
2025-08-04 20:46:23 +02:00
site_name.rst
Help: Document site_name command use of HOSTNAME variable
2020-10-22 10:20:43 -04:00
source_group.rst
source_group: add genex support
2025-11-24 21:08:46 +03:00
string.rst
Help: Add 4.3 version tags for string JSON operations
2026-02-22 17:00:30 -05:00
subdir_depends.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
subdirs.rst
Help: Remove stray spaces and one colon
2025-01-31 12:23:29 -05:00
target_compile_definitions.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_compile_features.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_compile_options.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_include_directories.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_link_directories.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_link_libraries.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_link_options.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_precompile_headers.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
target_sources.rst
FILE_SET: enforce uniqueness of files
2026-03-23 08:37:05 -04:00
try_compile.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
try_run.rst
Help: Improve command usage formatting consistency
2026-02-13 12:54:37 -05:00
unset.rst
set/unset commands: add CACHE{variable} syntax support
2025-08-04 20:46:23 +02:00
use_mangled_mesa.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
utility_source.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
variable_requires.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00
variable_watch.rst
Help: Expand documentation of variable_watch()
2020-07-09 17:22:59 +02:00
while.rst
Help: Unindent _See Also_ related commands list
2022-11-07 22:55:06 +04:00
write_file.rst
Help: Use CMake highlighting for command synopsis
2022-11-09 23:52:30 +04:00