From 9784834b4cfa59aa77402e883fdd78362566ae49 Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Mon, 7 Apr 2025 21:30:55 +0400 Subject: Help: Use `*.rst` extension for included files So, editor(s) can correctly highlight the RST syntax in the included files. --- Help/command/DEPRECATED_POLICY_VERSIONS.txt | 31 --- Help/command/DEVICE_LINK_OPTIONS.txt | 12 - Help/command/FIND_XXX.txt | 265 --------------------- Help/command/FIND_XXX_ORDER.txt | 12 - Help/command/FIND_XXX_REGISTRY_VIEW.txt | 41 ---- Help/command/FIND_XXX_ROOT.txt | 29 --- Help/command/GENEX_NOTE.txt | 6 - Help/command/LINK_LIBRARIES_LINKER.txt | 24 -- Help/command/LINK_OPTIONS_LINKER.txt | 25 -- Help/command/OPTIONS_SHELL.txt | 15 -- Help/command/POLICY_VERSION.txt | 16 -- Help/command/SUPPORTED_LANGUAGES.txt | 25 -- Help/command/UNSET_NOTE.txt | 9 - Help/command/add_compile_definitions.rst | 2 +- Help/command/add_compile_options.rst | 4 +- Help/command/add_link_options.rst | 8 +- Help/command/cmake_minimum_required.rst | 4 +- Help/command/cmake_policy.rst | 6 +- Help/command/enable_language.rst | 2 +- Help/command/find_file.rst | 2 +- Help/command/find_library.rst | 2 +- Help/command/find_package.rst | 6 +- Help/command/find_path.rst | 2 +- Help/command/find_program.rst | 2 +- .../command/include/DEPRECATED_POLICY_VERSIONS.rst | 31 +++ Help/command/include/DEVICE_LINK_OPTIONS.rst | 12 + Help/command/include/FIND_XXX.rst | 265 +++++++++++++++++++++ Help/command/include/FIND_XXX_ORDER.rst | 12 + Help/command/include/FIND_XXX_REGISTRY_VIEW.rst | 41 ++++ Help/command/include/FIND_XXX_ROOT.rst | 29 +++ Help/command/include/GENEX_NOTE.rst | 6 + Help/command/include/LINK_LIBRARIES_LINKER.rst | 24 ++ Help/command/include/LINK_OPTIONS_LINKER.rst | 25 ++ Help/command/include/OPTIONS_SHELL.rst | 15 ++ Help/command/include/POLICY_VERSION.rst | 16 ++ Help/command/include/SUPPORTED_LANGUAGES.rst | 25 ++ Help/command/include/UNSET_NOTE.rst | 9 + Help/command/include_directories.rst | 2 +- Help/command/project.rst | 2 +- Help/command/set.rst | 2 +- Help/command/target_compile_definitions.rst | 2 +- Help/command/target_compile_features.rst | 2 +- Help/command/target_compile_options.rst | 4 +- Help/command/target_include_directories.rst | 4 +- Help/command/target_link_directories.rst | 2 +- Help/command/target_link_libraries.rst | 4 +- Help/command/target_link_options.rst | 8 +- Help/command/target_precompile_headers.rst | 2 +- Help/command/unset.rst | 2 +- Help/envvar/ADSP_ROOT.rst | 2 +- Help/envvar/ASM_DIALECT.rst | 2 +- Help/envvar/ASM_DIALECTFLAGS.rst | 4 +- Help/envvar/CC.rst | 2 +- Help/envvar/CFLAGS.rst | 4 +- Help/envvar/CLICOLOR.rst | 2 +- Help/envvar/CLICOLOR_FORCE.rst | 2 +- Help/envvar/CMAKE_APPBUNDLE_PATH.rst | 2 +- Help/envvar/CMAKE_APPLE_SILICON_PROCESSOR.rst | 2 +- Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst | 2 +- Help/envvar/CMAKE_BUILD_TYPE.rst | 2 +- Help/envvar/CMAKE_COLOR_DIAGNOSTICS.rst | 2 +- Help/envvar/CMAKE_CONFIGURATION_TYPES.rst | 2 +- Help/envvar/CMAKE_CONFIG_DIR.rst | 2 +- Help/envvar/CMAKE_CONFIG_TYPE.rst | 2 +- Help/envvar/CMAKE_CROSSCOMPILING_EMULATOR.rst | 2 +- Help/envvar/CMAKE_EXPORT_BUILD_DATABASE.rst | 2 +- Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst | 2 +- Help/envvar/CMAKE_FRAMEWORK_PATH.rst | 2 +- Help/envvar/CMAKE_GENERATOR.rst | 2 +- Help/envvar/CMAKE_GENERATOR_INSTANCE.rst | 2 +- Help/envvar/CMAKE_GENERATOR_PLATFORM.rst | 2 +- Help/envvar/CMAKE_GENERATOR_TOOLSET.rst | 2 +- Help/envvar/CMAKE_INCLUDE_PATH.rst | 2 +- Help/envvar/CMAKE_INSTALL_MODE.rst | 2 +- Help/envvar/CMAKE_INSTALL_PARALLEL_LEVEL.rst | 2 +- Help/envvar/CMAKE_INSTALL_PREFIX.rst | 2 +- Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst | 2 +- ...MAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE.rst | 2 +- Help/envvar/CMAKE_LANG_LINKER_LAUNCHER.rst | 2 +- Help/envvar/CMAKE_LIBRARY_PATH.rst | 2 +- Help/envvar/CMAKE_MAXIMUM_RECURSION_DEPTH.rst | 2 +- Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst | 2 +- Help/envvar/CMAKE_OSX_ARCHITECTURES.rst | 2 +- Help/envvar/CMAKE_POLICY_VERSION_MINIMUM.rst | 2 +- Help/envvar/CMAKE_PREFIX_PATH.rst | 2 +- Help/envvar/CMAKE_PROGRAM_PATH.rst | 2 +- Help/envvar/CMAKE_TEST_LAUNCHER.rst | 2 +- Help/envvar/CMAKE_TLS_VERIFY.rst | 2 +- Help/envvar/CMAKE_TLS_VERSION.rst | 2 +- Help/envvar/CMAKE_TOOLCHAIN_FILE.rst | 2 +- Help/envvar/CSFLAGS.rst | 4 +- Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst | 2 +- Help/envvar/CTEST_NO_TESTS_ACTION.rst | 2 +- Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst | 2 +- Help/envvar/CTEST_PARALLEL_LEVEL.rst | 2 +- Help/envvar/CTEST_PROGRESS_OUTPUT.rst | 2 +- Help/envvar/CTEST_USE_INSTRUMENTATION.rst | 2 +- Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst | 2 +- Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst | 2 +- Help/envvar/CUDAARCHS.rst | 2 +- Help/envvar/CUDACXX.rst | 2 +- Help/envvar/CUDAFLAGS.rst | 4 +- Help/envvar/CUDAHOSTCXX.rst | 2 +- Help/envvar/CXX.rst | 2 +- Help/envvar/CXXFLAGS.rst | 4 +- Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst | 2 +- Help/envvar/DESTDIR.rst | 2 +- Help/envvar/ENV_VAR.txt | 3 - Help/envvar/FC.rst | 2 +- Help/envvar/FFLAGS.rst | 4 +- Help/envvar/HIPCXX.rst | 2 +- Help/envvar/HIPFLAGS.rst | 4 +- Help/envvar/HIPHOSTCXX.rst | 2 +- Help/envvar/ISPC.rst | 2 +- Help/envvar/ISPCFLAGS.rst | 4 +- Help/envvar/LANG_FLAGS.txt | 6 - Help/envvar/LDFLAGS.rst | 2 +- Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst | 2 +- Help/envvar/OBJC.rst | 2 +- Help/envvar/OBJCFLAGS.rst | 4 +- Help/envvar/OBJCXX.rst | 2 +- Help/envvar/OBJCXXFLAGS.rst | 4 +- Help/envvar/PackageName_ROOT.rst | 2 +- Help/envvar/RC.rst | 2 +- Help/envvar/RCFLAGS.rst | 4 +- Help/envvar/SSL_CERT_DIR.rst | 2 +- Help/envvar/SSL_CERT_FILE.rst | 2 +- Help/envvar/SWIFTC.rst | 2 +- Help/envvar/include/ENV_VAR.rst | 3 + Help/envvar/include/LANG_FLAGS.rst | 6 + Help/generator/VS_TOOLSET_HOST_ARCH.txt | 7 - Help/generator/VS_TOOLSET_HOST_ARCH_LEGACY.txt | 11 - Help/generator/Visual Studio 14 2015.rst | 2 +- Help/generator/Visual Studio 15 2017.rst | 2 +- Help/generator/Visual Studio 16 2019.rst | 2 +- Help/generator/Visual Studio 17 2022.rst | 2 +- Help/generator/include/VS_TOOLSET_HOST_ARCH.rst | 7 + .../include/VS_TOOLSET_HOST_ARCH_LEGACY.rst | 11 + Help/guide/tutorial/index.rst | 5 +- Help/guide/tutorial/source.txt | 3 - Help/include/COMPILE_DEFINITIONS_DISCLAIMER.rst | 20 ++ Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt | 20 -- .../INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst | 18 ++ .../INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt | 18 -- Help/include/INTERFACE_LINK_LIBRARIES_WARNING.rst | 10 + Help/include/INTERFACE_LINK_LIBRARIES_WARNING.txt | 10 - Help/manual/ID_RESERVE.txt | 7 - Help/manual/LINKS.txt | 17 -- Help/manual/OPTIONS_BUILD.txt | 196 --------------- Help/manual/OPTIONS_HELP.txt | 169 ------------- Help/manual/ccmake.1.rst | 6 +- Help/manual/cmake-compile-features.7.rst | 2 +- Help/manual/cmake-generator-expressions.7.rst | 4 +- Help/manual/cmake-gui.1.rst | 4 +- Help/manual/cmake-language.7.rst | 2 +- Help/manual/cmake-variables.7.rst | 2 +- Help/manual/cmake.1.rst | 6 +- Help/manual/cpack.1.rst | 4 +- Help/manual/ctest.1.rst | 4 +- Help/manual/include/ID_RESERVE.rst | 7 + Help/manual/include/LINKS.rst | 17 ++ Help/manual/include/OPTIONS_BUILD.rst | 196 +++++++++++++++ Help/manual/include/OPTIONS_HELP.rst | 169 +++++++++++++ Help/module/CMAKE_REQUIRED_DEFINITIONS.txt | 4 - Help/module/CMAKE_REQUIRED_FLAGS.txt | 6 - Help/module/CMAKE_REQUIRED_INCLUDES.txt | 4 - Help/module/CMAKE_REQUIRED_LIBRARIES.txt | 5 - Help/module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt | 5 - Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt | 5 - Help/module/CMAKE_REQUIRED_QUIET.txt | 5 - Help/module/include/CMAKE_REQUIRED_DEFINITIONS.rst | 4 + Help/module/include/CMAKE_REQUIRED_FLAGS.rst | 6 + Help/module/include/CMAKE_REQUIRED_INCLUDES.rst | 4 + Help/module/include/CMAKE_REQUIRED_LIBRARIES.rst | 5 + .../include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst | 5 + .../module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst | 5 + Help/module/include/CMAKE_REQUIRED_QUIET.rst | 5 + Help/policy/CMP0000.rst | 4 +- Help/policy/CMP0001.rst | 4 +- Help/policy/CMP0002.rst | 4 +- Help/policy/CMP0003.rst | 4 +- Help/policy/CMP0004.rst | 4 +- Help/policy/CMP0005.rst | 4 +- Help/policy/CMP0006.rst | 4 +- Help/policy/CMP0007.rst | 4 +- Help/policy/CMP0008.rst | 4 +- Help/policy/CMP0009.rst | 4 +- Help/policy/CMP0010.rst | 4 +- Help/policy/CMP0011.rst | 4 +- Help/policy/CMP0012.rst | 4 +- Help/policy/CMP0013.rst | 4 +- Help/policy/CMP0014.rst | 4 +- Help/policy/CMP0015.rst | 4 +- Help/policy/CMP0016.rst | 4 +- Help/policy/CMP0017.rst | 4 +- Help/policy/CMP0018.rst | 4 +- Help/policy/CMP0019.rst | 4 +- Help/policy/CMP0020.rst | 4 +- Help/policy/CMP0021.rst | 4 +- Help/policy/CMP0022.rst | 4 +- Help/policy/CMP0023.rst | 4 +- Help/policy/CMP0024.rst | 4 +- Help/policy/CMP0025.rst | 4 +- Help/policy/CMP0026.rst | 4 +- Help/policy/CMP0027.rst | 4 +- Help/policy/CMP0028.rst | 4 +- Help/policy/CMP0029.rst | 4 +- Help/policy/CMP0030.rst | 4 +- Help/policy/CMP0031.rst | 4 +- Help/policy/CMP0032.rst | 4 +- Help/policy/CMP0033.rst | 4 +- Help/policy/CMP0034.rst | 4 +- Help/policy/CMP0035.rst | 4 +- Help/policy/CMP0036.rst | 4 +- Help/policy/CMP0037.rst | 4 +- Help/policy/CMP0038.rst | 4 +- Help/policy/CMP0039.rst | 4 +- Help/policy/CMP0040.rst | 4 +- Help/policy/CMP0041.rst | 4 +- Help/policy/CMP0042.rst | 4 +- Help/policy/CMP0043.rst | 4 +- Help/policy/CMP0044.rst | 4 +- Help/policy/CMP0045.rst | 4 +- Help/policy/CMP0046.rst | 4 +- Help/policy/CMP0047.rst | 4 +- Help/policy/CMP0048.rst | 4 +- Help/policy/CMP0049.rst | 4 +- Help/policy/CMP0050.rst | 4 +- Help/policy/CMP0051.rst | 4 +- Help/policy/CMP0052.rst | 4 +- Help/policy/CMP0053.rst | 4 +- Help/policy/CMP0054.rst | 4 +- Help/policy/CMP0055.rst | 4 +- Help/policy/CMP0056.rst | 4 +- Help/policy/CMP0057.rst | 4 +- Help/policy/CMP0058.rst | 4 +- Help/policy/CMP0059.rst | 4 +- Help/policy/CMP0060.rst | 4 +- Help/policy/CMP0061.rst | 4 +- Help/policy/CMP0062.rst | 4 +- Help/policy/CMP0063.rst | 4 +- Help/policy/CMP0064.rst | 4 +- Help/policy/CMP0065.rst | 4 +- Help/policy/CMP0066.rst | 4 +- Help/policy/CMP0067.rst | 4 +- Help/policy/CMP0068.rst | 4 +- Help/policy/CMP0069.rst | 4 +- Help/policy/CMP0070.rst | 4 +- Help/policy/CMP0071.rst | 4 +- Help/policy/CMP0072.rst | 4 +- Help/policy/CMP0073.rst | 4 +- Help/policy/CMP0074.rst | 4 +- Help/policy/CMP0075.rst | 4 +- Help/policy/CMP0076.rst | 4 +- Help/policy/CMP0077.rst | 4 +- Help/policy/CMP0078.rst | 4 +- Help/policy/CMP0079.rst | 4 +- Help/policy/CMP0080.rst | 4 +- Help/policy/CMP0081.rst | 4 +- Help/policy/CMP0082.rst | 4 +- Help/policy/CMP0083.rst | 4 +- Help/policy/CMP0084.rst | 4 +- Help/policy/CMP0085.rst | 4 +- Help/policy/CMP0086.rst | 4 +- Help/policy/CMP0087.rst | 4 +- Help/policy/CMP0088.rst | 4 +- Help/policy/CMP0089.rst | 4 +- Help/policy/CMP0090.rst | 4 +- Help/policy/CMP0091.rst | 4 +- Help/policy/CMP0092.rst | 4 +- Help/policy/CMP0093.rst | 4 +- Help/policy/CMP0094.rst | 4 +- Help/policy/CMP0095.rst | 4 +- Help/policy/CMP0096.rst | 4 +- Help/policy/CMP0097.rst | 4 +- Help/policy/CMP0098.rst | 4 +- Help/policy/CMP0099.rst | 4 +- Help/policy/CMP0100.rst | 4 +- Help/policy/CMP0101.rst | 4 +- Help/policy/CMP0102.rst | 4 +- Help/policy/CMP0103.rst | 4 +- Help/policy/CMP0104.rst | 4 +- Help/policy/CMP0105.rst | 4 +- Help/policy/CMP0106.rst | 4 +- Help/policy/CMP0107.rst | 4 +- Help/policy/CMP0108.rst | 4 +- Help/policy/CMP0109.rst | 4 +- Help/policy/CMP0110.rst | 4 +- Help/policy/CMP0111.rst | 4 +- Help/policy/CMP0112.rst | 4 +- Help/policy/CMP0113.rst | 4 +- Help/policy/CMP0114.rst | 4 +- Help/policy/CMP0115.rst | 4 +- Help/policy/CMP0116.rst | 4 +- Help/policy/CMP0117.rst | 4 +- Help/policy/CMP0118.rst | 4 +- Help/policy/CMP0119.rst | 4 +- Help/policy/CMP0120.rst | 4 +- Help/policy/CMP0121.rst | 4 +- Help/policy/CMP0122.rst | 4 +- Help/policy/CMP0123.rst | 4 +- Help/policy/CMP0124.rst | 4 +- Help/policy/CMP0125.rst | 4 +- Help/policy/CMP0126.rst | 4 +- Help/policy/CMP0127.rst | 4 +- Help/policy/CMP0128.rst | 4 +- Help/policy/CMP0129.rst | 4 +- Help/policy/CMP0130.rst | 4 +- Help/policy/CMP0131.rst | 4 +- Help/policy/CMP0132.rst | 4 +- Help/policy/CMP0133.rst | 4 +- Help/policy/CMP0134.rst | 4 +- Help/policy/CMP0135.rst | 4 +- Help/policy/CMP0136.rst | 4 +- Help/policy/CMP0137.rst | 4 +- Help/policy/CMP0138.rst | 4 +- Help/policy/CMP0139.rst | 4 +- Help/policy/CMP0140.rst | 4 +- Help/policy/CMP0141.rst | 4 +- Help/policy/CMP0142.rst | 4 +- Help/policy/CMP0143.rst | 4 +- Help/policy/CMP0144.rst | 4 +- Help/policy/CMP0145.rst | 4 +- Help/policy/CMP0146.rst | 4 +- Help/policy/CMP0147.rst | 4 +- Help/policy/CMP0148.rst | 4 +- Help/policy/CMP0149.rst | 4 +- Help/policy/CMP0150.rst | 4 +- Help/policy/CMP0151.rst | 4 +- Help/policy/CMP0152.rst | 4 +- Help/policy/CMP0153.rst | 4 +- Help/policy/CMP0154.rst | 4 +- Help/policy/CMP0155.rst | 4 +- Help/policy/CMP0156.rst | 4 +- Help/policy/CMP0157.rst | 4 +- Help/policy/CMP0158.rst | 4 +- Help/policy/CMP0159.rst | 4 +- Help/policy/CMP0160.rst | 4 +- Help/policy/CMP0161.rst | 4 +- Help/policy/CMP0162.rst | 4 +- Help/policy/CMP0163.rst | 4 +- Help/policy/CMP0164.rst | 4 +- Help/policy/CMP0165.rst | 4 +- Help/policy/CMP0166.rst | 4 +- Help/policy/CMP0167.rst | 4 +- Help/policy/CMP0168.rst | 4 +- Help/policy/CMP0169.rst | 4 +- Help/policy/CMP0170.rst | 4 +- Help/policy/CMP0171.rst | 4 +- Help/policy/CMP0172.rst | 4 +- Help/policy/CMP0173.rst | 4 +- Help/policy/CMP0174.rst | 4 +- Help/policy/CMP0175.rst | 4 +- Help/policy/CMP0176.rst | 4 +- Help/policy/CMP0177.rst | 2 +- Help/policy/CMP0178.rst | 4 +- Help/policy/CMP0179.rst | 4 +- Help/policy/CMP0180.rst | 4 +- Help/policy/CMP0181.rst | 4 +- Help/policy/CMP0182.rst | 4 +- Help/policy/CMP0183.rst | 4 +- Help/policy/CMP0184.rst | 4 +- Help/policy/CMP0185.rst | 4 +- Help/policy/CMP0186.rst | 4 +- Help/policy/CMP0187.rst | 4 +- Help/policy/CMP0188.rst | 4 +- Help/policy/CMP0189.rst | 4 +- Help/policy/CMP0190.rst | 4 +- Help/policy/CMP0191.rst | 4 +- Help/policy/CMP0192.rst | 4 +- Help/policy/DEPRECATED.txt | 4 - Help/policy/DISALLOWED_COMMAND.txt | 8 - Help/policy/REMOVED_COMMAND.txt | 8 - Help/policy/REMOVED_EPILOGUE.txt | 4 - Help/policy/REMOVED_PROLOGUE.txt | 5 - Help/policy/STANDARD_ADVICE.txt | 3 - Help/policy/include/DEPRECATED.rst | 4 + Help/policy/include/DISALLOWED_COMMAND.rst | 8 + Help/policy/include/REMOVED_COMMAND.rst | 8 + Help/policy/include/REMOVED_EPILOGUE.rst | 4 + Help/policy/include/REMOVED_PROLOGUE.rst | 5 + Help/policy/include/STANDARD_ADVICE.rst | 3 + Help/prop_dir/COMPILE_DEFINITIONS.rst | 2 +- Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst | 2 +- Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst | 2 +- Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst | 2 +- Help/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst | 2 +- Help/prop_gbl/CMAKE_LANG_STD_FLAGS.txt | 7 - Help/prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst | 7 + Help/prop_sf/COMPILE_DEFINITIONS.rst | 2 +- Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst | 4 +- Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst | 4 +- Help/prop_tgt/COMPILE_DEFINITIONS.rst | 2 +- Help/prop_tgt/COMPILE_OPTIONS.rst | 2 +- Help/prop_tgt/COMPILE_PDB_NAME.rst | 2 +- Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst | 2 +- Help/prop_tgt/COMPILE_PDB_NOTE.txt | 5 - Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst | 2 +- .../COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst | 2 +- Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt | 9 - Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst | 2 +- .../IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst | 2 +- Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt | 16 -- Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst | 2 +- Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst | 2 +- Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst | 2 +- Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst | 4 +- Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst | 2 +- Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst | 6 +- Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst | 2 +- Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt | 9 - .../INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst | 2 +- Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst | 8 +- Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst | 2 +- Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst | 2 +- Help/prop_tgt/LINKER_TYPE.rst | 2 +- Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst | 2 +- Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst | 2 +- Help/prop_tgt/LINK_LIBRARIES.rst | 4 +- Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt | 10 - Help/prop_tgt/LINK_OPTIONS.rst | 6 +- Help/prop_tgt/MACOS_IMPORT_FILES.txt | 12 - .../MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt | 16 -- Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst | 2 +- Help/prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt | 16 -- Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst | 2 +- Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt | 21 -- Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst | 2 +- Help/prop_tgt/PDB_NAME.rst | 2 +- Help/prop_tgt/PDB_NAME_CONFIG.rst | 2 +- Help/prop_tgt/PDB_NOTE.txt | 9 - Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst | 2 +- Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst | 2 +- Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst | 2 +- Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst | 2 +- Help/prop_tgt/SOVERSION.rst | 2 +- Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst | 4 +- Help/prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt | 23 -- Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt | 19 -- Help/prop_tgt/Swift_COMPILATION_MODE.rst | 2 +- Help/prop_tgt/VERSION.rst | 2 +- Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt | 9 - Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt | 18 -- Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst | 2 +- Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt | 20 -- Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst | 2 +- Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt | 12 - Help/prop_tgt/XXX_OUTPUT_NAME.txt | 5 - Help/prop_tgt/include/COMPILE_PDB_NOTE.rst | 5 + .../include/CUDA_RUNTIME_LIBRARY-VALUES.rst | 9 + Help/prop_tgt/include/INTERFACE_BUILD_PROPERTY.rst | 16 ++ .../include/INTERFACE_LINK_LIBRARIES_DIRECT.rst | 9 + .../include/LINK_LIBRARIES_INDIRECTION.rst | 10 + Help/prop_tgt/include/MACOS_IMPORT_FILES.rst | 12 + .../MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst | 16 ++ .../include/MSVC_RUNTIME_CHECKS-VALUES.rst | 16 ++ .../include/MSVC_RUNTIME_LIBRARY-VALUES.rst | 21 ++ Help/prop_tgt/include/PDB_NOTE.rst | 9 + .../include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst | 23 ++ .../include/Swift_COMPILATION_MODE-VALUES.rst | 19 ++ .../prop_tgt/include/VERSION_SOVERSION_EXAMPLE.rst | 9 + .../include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst | 18 ++ .../include/WATCOM_RUNTIME_LIBRARY-VALUES.rst | 20 ++ Help/prop_tgt/include/XXX_OUTPUT_DIRECTORY.rst | 12 + Help/prop_tgt/include/XXX_OUTPUT_NAME.rst | 5 + Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst | 2 +- Help/variable/CMAKE_EXE_LINKER_FLAGS.rst | 2 +- Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst | 2 +- .../variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE.rst | 2 +- .../variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY.rst | 2 +- .../variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.rst | 2 +- .../variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM.rst | 2 +- Help/variable/CMAKE_FIND_ROOT_PATH_MODE_XXX.txt | 8 - Help/variable/CMAKE_GENERATOR_INSTANCE.rst | 2 +- Help/variable/CMAKE_IGNORE_PATH.rst | 6 +- Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst | 6 +- .../CMAKE_LANG_LINK_GROUP_USING_FEATURE.rst | 2 +- .../CMAKE_LANG_LINK_LIBRARY_USING_FEATURE.rst | 2 +- Help/variable/CMAKE_LINKER_TYPE.rst | 2 +- Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst | 2 +- Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.txt | 78 ------ Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.rst | 2 +- Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.txt | 153 ------------ Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst | 2 +- Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst | 2 +- .../CMAKE_MSVC_DEBUG_INFORMATION_FORMAT.rst | 2 +- Help/variable/CMAKE_MSVC_RUNTIME_CHECKS.rst | 2 +- Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst | 2 +- Help/variable/CMAKE_OSX_ARCHITECTURES.rst | 2 +- Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst | 2 +- Help/variable/CMAKE_OSX_SYSROOT.rst | 2 +- Help/variable/CMAKE_OSX_VARIABLE.txt | 12 - Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst | 2 +- Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst | 2 +- Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst | 6 +- Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst | 6 +- Help/variable/CMAKE_Swift_COMPILATION_MODE.rst | 2 +- Help/variable/CMAKE_TLS_VERSION-VALUES.txt | 7 - Help/variable/CMAKE_TLS_VERSION.rst | 2 +- Help/variable/CMAKE_VS_USE_DEBUG_LIBRARIES.rst | 2 +- Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER.rst | 2 +- .../CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt | 18 -- Help/variable/CMAKE_WATCOM_RUNTIME_LIBRARY.rst | 2 +- Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst | 2 +- Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst | 2 +- Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst | 2 +- Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst | 2 +- Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst | 2 +- ...TEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst | 2 +- .../CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst | 2 +- .../CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst | 2 +- ...TEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst | 2 +- Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst | 2 +- Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst | 2 +- Help/variable/CTEST_CUSTOM_POST_TEST.rst | 2 +- Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst | 2 +- Help/variable/CTEST_CUSTOM_PRE_TEST.rst | 2 +- Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst | 2 +- .../CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.rst | 2 +- Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst | 2 +- Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst | 2 +- Help/variable/CTEST_CUSTOM_XXX.txt | 2 - Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst | 2 +- Help/variable/CTEST_TLS_VERSION.rst | 2 +- Help/variable/IGNORE_SEARCH_LOCATIONS.txt | 4 - Help/variable/IGNORE_SEARCH_NONSYSTEM.txt | 2 - Help/variable/IGNORE_SEARCH_PATH.txt | 19 -- Help/variable/IGNORE_SEARCH_PREFIX.txt | 6 - Help/variable/IGNORE_SEARCH_SYSTEM.txt | 5 - Help/variable/LINKER_FLAGS.txt | 5 - Help/variable/LINKER_PREDEFINED_TYPES.txt | 69 ------ Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt | 22 -- Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt | 111 --------- .../include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst | 8 + .../include/CMAKE_LINK_GROUP_USING_FEATURE.rst | 78 ++++++ .../include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst | 153 ++++++++++++ Help/variable/include/CMAKE_OSX_VARIABLE.rst | 12 + Help/variable/include/CMAKE_TLS_VERSION-VALUES.rst | 7 + .../CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst | 18 ++ Help/variable/include/CTEST_CUSTOM_XXX.rst | 2 + Help/variable/include/IGNORE_SEARCH_LOCATIONS.rst | 4 + Help/variable/include/IGNORE_SEARCH_NONSYSTEM.rst | 2 + Help/variable/include/IGNORE_SEARCH_PATH.rst | 19 ++ Help/variable/include/IGNORE_SEARCH_PREFIX.rst | 6 + Help/variable/include/IGNORE_SEARCH_SYSTEM.rst | 5 + Help/variable/include/LINKER_FLAGS.rst | 5 + Help/variable/include/LINKER_PREDEFINED_TYPES.rst | 69 ++++++ .../include/LINK_GROUP_PREDEFINED_FEATURES.rst | 22 ++ .../include/LINK_LIBRARY_PREDEFINED_FEATURES.rst | 111 +++++++++ Modules/CheckCCompilerFlag.cmake | 14 +- Modules/CheckCSourceCompiles.cmake | 14 +- Modules/CheckCSourceRuns.cmake | 14 +- Modules/CheckCXXCompilerFlag.cmake | 14 +- Modules/CheckCXXSourceCompiles.cmake | 14 +- Modules/CheckCXXSourceRuns.cmake | 14 +- Modules/CheckCXXSymbolExists.cmake | 14 +- Modules/CheckCompilerFlag.cmake | 14 +- Modules/CheckFortranCompilerFlag.cmake | 14 +- Modules/CheckFortranFunctionExists.cmake | 6 +- Modules/CheckFortranSourceCompiles.cmake | 14 +- Modules/CheckFortranSourceRuns.cmake | 14 +- Modules/CheckFunctionExists.cmake | 14 +- Modules/CheckIncludeFile.cmake | 14 +- Modules/CheckIncludeFileCXX.cmake | 14 +- Modules/CheckIncludeFiles.cmake | 14 +- Modules/CheckLibraryExists.cmake | 12 +- Modules/CheckOBJCCompilerFlag.cmake | 14 +- Modules/CheckOBJCSourceCompiles.cmake | 14 +- Modules/CheckOBJCSourceRuns.cmake | 14 +- Modules/CheckOBJCXXCompilerFlag.cmake | 14 +- Modules/CheckOBJCXXSourceCompiles.cmake | 14 +- Modules/CheckOBJCXXSourceRuns.cmake | 14 +- Modules/CheckPrototypeDefinition.cmake | 14 +- Modules/CheckSourceCompiles.cmake | 14 +- Modules/CheckSourceRuns.cmake | 14 +- Modules/CheckStructHasMember.cmake | 14 +- Modules/CheckSymbolExists.cmake | 14 +- Modules/CheckTypeSize.cmake | 14 +- Modules/CheckVariableExists.cmake | 10 +- Utilities/Sphinx/conf.py.in | 6 +- 580 files changed, 2658 insertions(+), 2658 deletions(-) delete mode 100644 Help/command/DEPRECATED_POLICY_VERSIONS.txt delete mode 100644 Help/command/DEVICE_LINK_OPTIONS.txt delete mode 100644 Help/command/FIND_XXX.txt delete mode 100644 Help/command/FIND_XXX_ORDER.txt delete mode 100644 Help/command/FIND_XXX_REGISTRY_VIEW.txt delete mode 100644 Help/command/FIND_XXX_ROOT.txt delete mode 100644 Help/command/GENEX_NOTE.txt delete mode 100644 Help/command/LINK_LIBRARIES_LINKER.txt delete mode 100644 Help/command/LINK_OPTIONS_LINKER.txt delete mode 100644 Help/command/OPTIONS_SHELL.txt delete mode 100644 Help/command/POLICY_VERSION.txt delete mode 100644 Help/command/SUPPORTED_LANGUAGES.txt delete mode 100644 Help/command/UNSET_NOTE.txt create mode 100644 Help/command/include/DEPRECATED_POLICY_VERSIONS.rst create mode 100644 Help/command/include/DEVICE_LINK_OPTIONS.rst create mode 100644 Help/command/include/FIND_XXX.rst create mode 100644 Help/command/include/FIND_XXX_ORDER.rst create mode 100644 Help/command/include/FIND_XXX_REGISTRY_VIEW.rst create mode 100644 Help/command/include/FIND_XXX_ROOT.rst create mode 100644 Help/command/include/GENEX_NOTE.rst create mode 100644 Help/command/include/LINK_LIBRARIES_LINKER.rst create mode 100644 Help/command/include/LINK_OPTIONS_LINKER.rst create mode 100644 Help/command/include/OPTIONS_SHELL.rst create mode 100644 Help/command/include/POLICY_VERSION.rst create mode 100644 Help/command/include/SUPPORTED_LANGUAGES.rst create mode 100644 Help/command/include/UNSET_NOTE.rst delete mode 100644 Help/envvar/ENV_VAR.txt delete mode 100644 Help/envvar/LANG_FLAGS.txt create mode 100644 Help/envvar/include/ENV_VAR.rst create mode 100644 Help/envvar/include/LANG_FLAGS.rst delete mode 100644 Help/generator/VS_TOOLSET_HOST_ARCH.txt delete mode 100644 Help/generator/VS_TOOLSET_HOST_ARCH_LEGACY.txt create mode 100644 Help/generator/include/VS_TOOLSET_HOST_ARCH.rst create mode 100644 Help/generator/include/VS_TOOLSET_HOST_ARCH_LEGACY.rst delete mode 100644 Help/guide/tutorial/source.txt create mode 100644 Help/include/COMPILE_DEFINITIONS_DISCLAIMER.rst delete mode 100644 Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt create mode 100644 Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst delete mode 100644 Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt create mode 100644 Help/include/INTERFACE_LINK_LIBRARIES_WARNING.rst delete mode 100644 Help/include/INTERFACE_LINK_LIBRARIES_WARNING.txt delete mode 100644 Help/manual/ID_RESERVE.txt delete mode 100644 Help/manual/LINKS.txt delete mode 100644 Help/manual/OPTIONS_BUILD.txt delete mode 100644 Help/manual/OPTIONS_HELP.txt create mode 100644 Help/manual/include/ID_RESERVE.rst create mode 100644 Help/manual/include/LINKS.rst create mode 100644 Help/manual/include/OPTIONS_BUILD.rst create mode 100644 Help/manual/include/OPTIONS_HELP.rst delete mode 100644 Help/module/CMAKE_REQUIRED_DEFINITIONS.txt delete mode 100644 Help/module/CMAKE_REQUIRED_FLAGS.txt delete mode 100644 Help/module/CMAKE_REQUIRED_INCLUDES.txt delete mode 100644 Help/module/CMAKE_REQUIRED_LIBRARIES.txt delete mode 100644 Help/module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt delete mode 100644 Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt delete mode 100644 Help/module/CMAKE_REQUIRED_QUIET.txt create mode 100644 Help/module/include/CMAKE_REQUIRED_DEFINITIONS.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_FLAGS.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_INCLUDES.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_LIBRARIES.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst create mode 100644 Help/module/include/CMAKE_REQUIRED_QUIET.rst delete mode 100644 Help/policy/DEPRECATED.txt delete mode 100644 Help/policy/DISALLOWED_COMMAND.txt delete mode 100644 Help/policy/REMOVED_COMMAND.txt delete mode 100644 Help/policy/REMOVED_EPILOGUE.txt delete mode 100644 Help/policy/REMOVED_PROLOGUE.txt delete mode 100644 Help/policy/STANDARD_ADVICE.txt create mode 100644 Help/policy/include/DEPRECATED.rst create mode 100644 Help/policy/include/DISALLOWED_COMMAND.rst create mode 100644 Help/policy/include/REMOVED_COMMAND.rst create mode 100644 Help/policy/include/REMOVED_EPILOGUE.rst create mode 100644 Help/policy/include/REMOVED_PROLOGUE.rst create mode 100644 Help/policy/include/STANDARD_ADVICE.rst delete mode 100644 Help/prop_gbl/CMAKE_LANG_STD_FLAGS.txt create mode 100644 Help/prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst delete mode 100644 Help/prop_tgt/COMPILE_PDB_NOTE.txt delete mode 100644 Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt delete mode 100644 Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt delete mode 100644 Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt delete mode 100644 Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt delete mode 100644 Help/prop_tgt/MACOS_IMPORT_FILES.txt delete mode 100644 Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt delete mode 100644 Help/prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt delete mode 100644 Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt delete mode 100644 Help/prop_tgt/PDB_NOTE.txt delete mode 100644 Help/prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt delete mode 100644 Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt delete mode 100644 Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt delete mode 100644 Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt delete mode 100644 Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt delete mode 100644 Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt delete mode 100644 Help/prop_tgt/XXX_OUTPUT_NAME.txt create mode 100644 Help/prop_tgt/include/COMPILE_PDB_NOTE.rst create mode 100644 Help/prop_tgt/include/CUDA_RUNTIME_LIBRARY-VALUES.rst create mode 100644 Help/prop_tgt/include/INTERFACE_BUILD_PROPERTY.rst create mode 100644 Help/prop_tgt/include/INTERFACE_LINK_LIBRARIES_DIRECT.rst create mode 100644 Help/prop_tgt/include/LINK_LIBRARIES_INDIRECTION.rst create mode 100644 Help/prop_tgt/include/MACOS_IMPORT_FILES.rst create mode 100644 Help/prop_tgt/include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst create mode 100644 Help/prop_tgt/include/MSVC_RUNTIME_CHECKS-VALUES.rst create mode 100644 Help/prop_tgt/include/MSVC_RUNTIME_LIBRARY-VALUES.rst create mode 100644 Help/prop_tgt/include/PDB_NOTE.rst create mode 100644 Help/prop_tgt/include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst create mode 100644 Help/prop_tgt/include/Swift_COMPILATION_MODE-VALUES.rst create mode 100644 Help/prop_tgt/include/VERSION_SOVERSION_EXAMPLE.rst create mode 100644 Help/prop_tgt/include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst create mode 100644 Help/prop_tgt/include/WATCOM_RUNTIME_LIBRARY-VALUES.rst create mode 100644 Help/prop_tgt/include/XXX_OUTPUT_DIRECTORY.rst create mode 100644 Help/prop_tgt/include/XXX_OUTPUT_NAME.rst delete mode 100644 Help/variable/CMAKE_FIND_ROOT_PATH_MODE_XXX.txt delete mode 100644 Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.txt delete mode 100644 Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.txt delete mode 100644 Help/variable/CMAKE_OSX_VARIABLE.txt delete mode 100644 Help/variable/CMAKE_TLS_VERSION-VALUES.txt delete mode 100644 Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt delete mode 100644 Help/variable/CTEST_CUSTOM_XXX.txt delete mode 100644 Help/variable/IGNORE_SEARCH_LOCATIONS.txt delete mode 100644 Help/variable/IGNORE_SEARCH_NONSYSTEM.txt delete mode 100644 Help/variable/IGNORE_SEARCH_PATH.txt delete mode 100644 Help/variable/IGNORE_SEARCH_PREFIX.txt delete mode 100644 Help/variable/IGNORE_SEARCH_SYSTEM.txt delete mode 100644 Help/variable/LINKER_FLAGS.txt delete mode 100644 Help/variable/LINKER_PREDEFINED_TYPES.txt delete mode 100644 Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt delete mode 100644 Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt create mode 100644 Help/variable/include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst create mode 100644 Help/variable/include/CMAKE_LINK_GROUP_USING_FEATURE.rst create mode 100644 Help/variable/include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst create mode 100644 Help/variable/include/CMAKE_OSX_VARIABLE.rst create mode 100644 Help/variable/include/CMAKE_TLS_VERSION-VALUES.rst create mode 100644 Help/variable/include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst create mode 100644 Help/variable/include/CTEST_CUSTOM_XXX.rst create mode 100644 Help/variable/include/IGNORE_SEARCH_LOCATIONS.rst create mode 100644 Help/variable/include/IGNORE_SEARCH_NONSYSTEM.rst create mode 100644 Help/variable/include/IGNORE_SEARCH_PATH.rst create mode 100644 Help/variable/include/IGNORE_SEARCH_PREFIX.rst create mode 100644 Help/variable/include/IGNORE_SEARCH_SYSTEM.rst create mode 100644 Help/variable/include/LINKER_FLAGS.rst create mode 100644 Help/variable/include/LINKER_PREDEFINED_TYPES.rst create mode 100644 Help/variable/include/LINK_GROUP_PREDEFINED_FEATURES.rst create mode 100644 Help/variable/include/LINK_LIBRARY_PREDEFINED_FEATURES.rst diff --git a/Help/command/DEPRECATED_POLICY_VERSIONS.txt b/Help/command/DEPRECATED_POLICY_VERSIONS.txt deleted file mode 100644 index 1b9f0d4..0000000 --- a/Help/command/DEPRECATED_POLICY_VERSIONS.txt +++ /dev/null @@ -1,31 +0,0 @@ -.. versionchanged:: 4.0 - - Compatibility with versions of CMake older than 3.5 is removed. - Calls to :command:`cmake_minimum_required(VERSION)` or - :command:`cmake_policy(VERSION)` that do not specify at least - 3.5 as their policy version (optionally via ``...``) - will produce an error in CMake 4.0 and above. - -.. versionchanged:: 3.31 - - Compatibility with versions of CMake older than 3.10 is deprecated. - Calls to :command:`cmake_minimum_required(VERSION)` or - :command:`cmake_policy(VERSION)` that do not specify at least - 3.10 as their policy version (optionally via ``...``) - will produce a deprecation warning in CMake 3.31 and above. - -.. versionchanged:: 3.27 - - Compatibility with versions of CMake older than 3.5 is deprecated. - Calls to :command:`cmake_minimum_required(VERSION)` or - :command:`cmake_policy(VERSION)` that do not specify at least - 3.5 as their policy version (optionally via ``...``) - will produce a deprecation warning in CMake 3.27 and above. - -.. versionchanged:: 3.19 - - Compatibility with versions of CMake older than 2.8.12 is deprecated. - Calls to :command:`cmake_minimum_required(VERSION)` or - :command:`cmake_policy(VERSION)` that do not specify at least - 2.8.12 as their policy version (optionally via ``...``) - will produce a deprecation warning in CMake 3.19 and above. diff --git a/Help/command/DEVICE_LINK_OPTIONS.txt b/Help/command/DEVICE_LINK_OPTIONS.txt deleted file mode 100644 index 878754d..0000000 --- a/Help/command/DEVICE_LINK_OPTIONS.txt +++ /dev/null @@ -1,12 +0,0 @@ -Host And Device Specific Link Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. versionadded:: 3.18 - When a device link step is involved, which is controlled by - :prop_tgt:`CUDA_SEPARABLE_COMPILATION` and - :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` properties and policy :policy:`CMP0105`, - the raw options will be delivered to the host and device link steps (wrapped in - ``-Xcompiler`` or equivalent for device link). Options wrapped with - :genex:`$` generator expression will be used - only for the device link step. Options wrapped with :genex:`$` - generator expression will be used only for the host link step. diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt deleted file mode 100644 index 299c761..0000000 --- a/Help/command/FIND_XXX.txt +++ /dev/null @@ -1,265 +0,0 @@ -A short-hand signature is: - -.. parsed-literal:: - - |FIND_XXX| ( name1 [path1 path2 ...]) - -The general signature is: - -.. parsed-literal:: - - |FIND_XXX| ( - - name | |NAMES| - [HINTS [path | ENV var]...] - [PATHS [path | ENV var]...] - [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] - [PATH_SUFFIXES suffix1 [suffix2 ...]] - [VALIDATOR function] - [DOC "cache documentation string"] - [NO_CACHE] - [REQUIRED|OPTIONAL] - [NO_DEFAULT_PATH] - [NO_PACKAGE_ROOT_PATH] - [NO_CMAKE_PATH] - [NO_CMAKE_ENVIRONMENT_PATH] - [NO_SYSTEM_ENVIRONMENT_PATH] - [NO_CMAKE_SYSTEM_PATH] - [NO_CMAKE_INSTALL_PREFIX] - [CMAKE_FIND_ROOT_PATH_BOTH | - ONLY_CMAKE_FIND_ROOT_PATH | - NO_CMAKE_FIND_ROOT_PATH] - ) - -This command is used to find a |SEARCH_XXX_DESC|. -A cache entry, or a normal variable if ``NO_CACHE`` is specified, -named by ```` is created to store the result of this command. -If the |SEARCH_XXX| is found the result is stored in the variable -and the search will not be repeated unless the variable is cleared. -If nothing is found, the result will be ``-NOTFOUND``. - -Options include: - -``NAMES`` - Specify one or more possible names for the |SEARCH_XXX|. - - When using this to specify names with and without a version - suffix, we recommend specifying the unversioned name first - so that locally-built packages can be found before those - provided by distributions. - -``HINTS``, ``PATHS`` - Specify directories to search in addition to the default locations. - The ``ENV var`` sub-option reads paths from a system environment - variable. - - .. versionchanged:: 3.24 - On ``Windows`` platform, it is possible to include registry queries as part - of the directories, using a :ref:`dedicated syntax `. - Such specifications will be ignored on all other platforms. - -``REGISTRY_VIEW`` - .. versionadded:: 3.24 - - .. include:: FIND_XXX_REGISTRY_VIEW.txt - -``PATH_SUFFIXES`` - Specify additional subdirectories to check below each directory - location otherwise considered. - -``VALIDATOR`` - .. versionadded:: 3.25 - - Specify a :command:`function` to be called for each candidate item found - (a :command:`macro` cannot be provided, that will result in an error). - Two arguments will be passed to the validator function: the name of a - result variable, and the absolute path to the candidate item. The item - will be accepted and the search will end unless the function sets the - value in the result variable to false in the calling scope. The result - variable will hold a true value when the validator function is entered. - - .. parsed-literal:: - - function(my_check validator_result_var item) - if(NOT item MATCHES ...) - set(${validator_result_var} FALSE PARENT_SCOPE) - endif() - endfunction() - - |FIND_XXX| (result NAMES ... VALIDATOR my_check) - - Note that if a cached result is used, the search is skipped and any - ``VALIDATOR`` is ignored. The cached result is not required to pass the - validation function. - -``DOC`` - Specify the documentation string for the ```` cache entry. - -``NO_CACHE`` - .. versionadded:: 3.21 - - The result of the search will be stored in a normal variable rather than - a cache entry. - - .. note:: - - If the variable is already set before the call (as a normal or cache - variable) then the search will not occur. - - .. warning:: - - This option should be used with caution because it can greatly increase - the cost of repeated configure steps. - -``REQUIRED`` - .. versionadded:: 3.18 - - Stop processing with an error message if nothing is found, otherwise - the search will be attempted again the next time |FIND_XXX| is invoked - with the same variable. - - .. versionadded:: 4.1 - - Every |FIND_XXX| command will be treated as ``REQUIRED`` when the - :variable:`CMAKE_FIND_REQUIRED` variable is enabled. - -``OPTIONAL`` - .. versionadded:: 4.1 - - Ignore the value of :variable:`CMAKE_FIND_REQUIRED` and - continue without an error message if nothing is found. - Incompatible with ``REQUIRED``. - -If ``NO_DEFAULT_PATH`` is specified, then no additional paths are -added to the search. -If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: - -.. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR| replace:: - |prefix_XXX_SUBDIR| for each ```` in the - :variable:`_ROOT` CMake variable and the - :envvar:`_ROOT` environment variable if - called from within a find module loaded by - :command:`find_package()` - -.. |CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: - |prefix_XXX_SUBDIR| for each ```` in :variable:`CMAKE_PREFIX_PATH` - -.. |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: - |prefix_XXX_SUBDIR| for each ```` in :envvar:`CMAKE_PREFIX_PATH` - -.. |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR| replace:: - |prefix_XXX_SUBDIR| for each ``/[s]bin`` in ``PATH``, and - |entry_XXX_SUBDIR| for other entries in ``PATH`` - -.. |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| replace:: - |prefix_XXX_SUBDIR| for each ```` in - :variable:`CMAKE_SYSTEM_PREFIX_PATH` - -1. If called from within a find module or any other script loaded by a call to - :command:`find_package()`, search prefixes unique to the - current package being found. See policy :policy:`CMP0074`. - - .. versionadded:: 3.12 - - Specifically, search paths specified by the following variables, in order: - - a. :variable:`_ROOT` CMake variable, - where ```` is the case-preserved package name. - - b. :variable:`_ROOT` CMake variable, - where ```` is the upper-cased package name. - See policy :policy:`CMP0144`. - - .. versionadded:: 3.27 - - c. :envvar:`_ROOT` environment variable, - where ```` is the case-preserved package name. - - d. :envvar:`_ROOT` environment variable, - where ```` is the upper-cased package name. - See policy :policy:`CMP0144`. - - .. versionadded:: 3.27 - - The package root variables are maintained as a stack, so if called from - nested find modules or config packages, root paths from the parent's find - module or config package will be searched after paths from the current - module or package. In other words, the search order would be - ``_ROOT``, ``ENV{_ROOT}``, - ``_ROOT``, ``ENV{_ROOT}``, etc. - This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting - the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. - - * |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| - -2. Search paths specified in cmake-specific cache variables. - These are intended to be used on the command line with a ``-DVAR=value``. - The values are interpreted as :ref:`semicolon-separated lists `. - This can be skipped if ``NO_CMAKE_PATH`` is passed or by setting the - :variable:`CMAKE_FIND_USE_CMAKE_PATH` to ``FALSE``. - - * |CMAKE_PREFIX_PATH_XXX| - * |CMAKE_XXX_PATH| - * |CMAKE_XXX_MAC_PATH| - -3. Search paths specified in cmake-specific environment variables. - These are intended to be set in the user's shell configuration, - and therefore use the host's native path separator - (``;`` on Windows and ``:`` on UNIX). - This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed or - by setting the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` to ``FALSE``. - - * |ENV_CMAKE_PREFIX_PATH_XXX| - * |ENV_CMAKE_XXX_PATH| - * |ENV_CMAKE_XXX_MAC_PATH| - -4. Search the paths specified by the ``HINTS`` option. - These should be paths computed by system introspection, such as a - hint provided by the location of another item already found. - Hard-coded guesses should be specified with the ``PATHS`` option. - -5. Search the standard system environment variables. - This can be skipped if ``NO_SYSTEM_ENVIRONMENT_PATH`` is passed or by - setting the :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` to ``FALSE``. - - * |SYSTEM_ENVIRONMENT_PATH_XXX| - - |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| - -6. Search cmake variables defined in the Platform files - for the current system. The searching of ``CMAKE_INSTALL_PREFIX`` and - ``CMAKE_STAGING_PREFIX`` can be - skipped if ``NO_CMAKE_INSTALL_PREFIX`` is passed or by setting the - :variable:`CMAKE_FIND_USE_INSTALL_PREFIX` to ``FALSE``. All these locations - can be skipped if ``NO_CMAKE_SYSTEM_PATH`` is passed or by setting the - :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` to ``FALSE``. - - * |CMAKE_SYSTEM_PREFIX_PATH_XXX| - * |CMAKE_SYSTEM_XXX_PATH| - * |CMAKE_SYSTEM_XXX_MAC_PATH| - - The platform paths that these variables contain are locations that - typically include installed software. An example being ``/usr/local`` for - UNIX based platforms. - -7. Search the paths specified by the PATHS option - or in the short-hand version of the command. - These are typically hard-coded guesses. - -The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`, -:variable:`CMAKE_SYSTEM_IGNORE_PATH` and -:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some -of the above locations to be ignored. - -.. versionadded:: 3.16 - Added ``CMAKE_FIND_USE__PATH`` variables to globally disable - various search locations. - -.. |FIND_ARGS_XXX| replace:: NAMES name - -On macOS the :variable:`CMAKE_FIND_FRAMEWORK` and -:variable:`CMAKE_FIND_APPBUNDLE` variables determine the order of -preference between Apple-style and unix-style package components. - -.. include:: FIND_XXX_ROOT.txt -.. include:: FIND_XXX_ORDER.txt diff --git a/Help/command/FIND_XXX_ORDER.txt b/Help/command/FIND_XXX_ORDER.txt deleted file mode 100644 index bac2419..0000000 --- a/Help/command/FIND_XXX_ORDER.txt +++ /dev/null @@ -1,12 +0,0 @@ -The default search order is designed to be most-specific to -least-specific for common use cases. -Projects may override the order by simply calling the command -multiple times and using the ``NO_*`` options: - -.. parsed-literal:: - - |FIND_XXX| (|FIND_ARGS_XXX| PATHS paths... NO_DEFAULT_PATH) - |FIND_XXX| (|FIND_ARGS_XXX|) - -Once one of the calls succeeds the result variable will be set -and stored in the cache so that no call will search again. diff --git a/Help/command/FIND_XXX_REGISTRY_VIEW.txt b/Help/command/FIND_XXX_REGISTRY_VIEW.txt deleted file mode 100644 index 6cab1d1..0000000 --- a/Help/command/FIND_XXX_REGISTRY_VIEW.txt +++ /dev/null @@ -1,41 +0,0 @@ -Specify which registry views must be queried. This option is only meaningful -on ``Windows`` platforms and will be ignored on other ones. When not -specified, the |FIND_XXX_REGISTRY_VIEW_DEFAULT| view is used when the -:policy:`CMP0134` policy is ``NEW``. Refer to :policy:`CMP0134` for the -default view when the policy is ``OLD``. - -``64`` - Query the 64-bit registry. On 32-bit Windows, it always returns the string - ``/REGISTRY-NOTFOUND``. - -``32`` - Query the 32-bit registry. - -``64_32`` - Query both views (``64`` and ``32``) and generate a path for each. - -``32_64`` - Query both views (``32`` and ``64``) and generate a path for each. - -``HOST`` - Query the registry matching the architecture of the host: ``64`` on 64-bit - Windows and ``32`` on 32-bit Windows. - -``TARGET`` - Query the registry matching the architecture specified by the - :variable:`CMAKE_SIZEOF_VOID_P` variable. If not defined, fall back to - ``HOST`` view. - -``BOTH`` - Query both views (``32`` and ``64``). The order depends on the following - rules: If the :variable:`CMAKE_SIZEOF_VOID_P` variable is defined, use the - following view depending on the content of this variable: - - * ``8``: ``64_32`` - * ``4``: ``32_64`` - - If the :variable:`CMAKE_SIZEOF_VOID_P` variable is not defined, rely on the - architecture of the host: - - * 64-bit: ``64_32`` - * 32-bit: ``32`` diff --git a/Help/command/FIND_XXX_ROOT.txt b/Help/command/FIND_XXX_ROOT.txt deleted file mode 100644 index fab2303..0000000 --- a/Help/command/FIND_XXX_ROOT.txt +++ /dev/null @@ -1,29 +0,0 @@ -The CMake variable :variable:`CMAKE_FIND_ROOT_PATH` specifies one or more -directories to be prepended to all other search directories. This -effectively "re-roots" the entire search under given locations. -Paths which are descendants of the :variable:`CMAKE_STAGING_PREFIX` are excluded -from this re-rooting, because that variable is always a path on the host system. -By default the :variable:`CMAKE_FIND_ROOT_PATH` is empty. - -The :variable:`CMAKE_SYSROOT` variable can also be used to specify exactly one -directory to use as a prefix. Setting :variable:`CMAKE_SYSROOT` also has other -effects. See the documentation for that variable for more. - -These variables are especially useful when cross-compiling to -point to the root directory of the target environment and CMake will -search there too. By default at first the directories listed in -:variable:`CMAKE_FIND_ROOT_PATH` are searched, then the :variable:`CMAKE_SYSROOT` -directory is searched, and then the non-rooted directories will be -searched. The default behavior can be adjusted by setting -|CMAKE_FIND_ROOT_PATH_MODE_XXX|. This behavior can be manually -overridden on a per-call basis using options: - -``CMAKE_FIND_ROOT_PATH_BOTH`` - Search in the order described above. - -``NO_CMAKE_FIND_ROOT_PATH`` - Do not use the :variable:`CMAKE_FIND_ROOT_PATH` variable. - -``ONLY_CMAKE_FIND_ROOT_PATH`` - Search only the re-rooted directories and directories below - :variable:`CMAKE_STAGING_PREFIX`. diff --git a/Help/command/GENEX_NOTE.txt b/Help/command/GENEX_NOTE.txt deleted file mode 100644 index 4a7906c..0000000 --- a/Help/command/GENEX_NOTE.txt +++ /dev/null @@ -1,6 +0,0 @@ -.. |more_see_also| replace:: See the :manual:`cmake-buildsystem(7)` manual - for more on defining buildsystem properties. - -Arguments to |command_name| may use generator expressions -with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. |more_see_also| diff --git a/Help/command/LINK_LIBRARIES_LINKER.txt b/Help/command/LINK_LIBRARIES_LINKER.txt deleted file mode 100644 index 45669f2..0000000 --- a/Help/command/LINK_LIBRARIES_LINKER.txt +++ /dev/null @@ -1,24 +0,0 @@ -Handling Compiler Driver Differences -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. versionadded:: 4.0 - -To pass options to the linker tool, each compiler driver has its own syntax. -The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable -way, options to pass to the linker tool. ``LINKER:`` is replaced by the -appropriate driver option and ``,`` by the appropriate driver separator. -The driver prefix and driver separator are given by the values of the -:variable:`CMAKE__LINKER_WRAPPER_FLAG` and -:variable:`CMAKE__LINKER_WRAPPER_FLAG_SEP` variables. - -For example, ``"LINKER:-z,defs"`` becomes ``-Xlinker -z -Xlinker defs`` for -``Clang`` and ``-Wl,-z,defs`` for ``GNU GCC``. - -The ``LINKER:`` prefix supports, as an alternative syntax, specification of -arguments using the ``SHELL:`` prefix and space as separator. The previous -example then becomes ``"LINKER:SHELL:-z defs"``. - -.. note:: - - Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the - ``LINKER:`` prefix is not supported. diff --git a/Help/command/LINK_OPTIONS_LINKER.txt b/Help/command/LINK_OPTIONS_LINKER.txt deleted file mode 100644 index e71e5ea..0000000 --- a/Help/command/LINK_OPTIONS_LINKER.txt +++ /dev/null @@ -1,25 +0,0 @@ -Handling Compiler Driver Differences -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To pass options to the linker tool, each compiler driver has its own syntax. -The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable -way, options to pass to the linker tool. ``LINKER:`` is replaced by the -appropriate driver option and ``,`` by the appropriate driver separator. -The driver prefix and driver separator are given by the values of the -:variable:`CMAKE__LINKER_WRAPPER_FLAG` and -:variable:`CMAKE__LINKER_WRAPPER_FLAG_SEP` variables. - -For example, ``"LINKER:-z,defs"`` becomes ``-Xlinker -z -Xlinker defs`` for -``Clang`` and ``-Wl,-z,defs`` for ``GNU GCC``. - -The ``LINKER:`` prefix can be specified as part of a ``SHELL:`` prefix -expression. - -The ``LINKER:`` prefix supports, as an alternative syntax, specification of -arguments using the ``SHELL:`` prefix and space as separator. The previous -example then becomes ``"LINKER:SHELL:-z defs"``. - -.. note:: - - Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the - ``LINKER:`` prefix is not supported. diff --git a/Help/command/OPTIONS_SHELL.txt b/Help/command/OPTIONS_SHELL.txt deleted file mode 100644 index 4171f01..0000000 --- a/Help/command/OPTIONS_SHELL.txt +++ /dev/null @@ -1,15 +0,0 @@ -Option De-duplication -^^^^^^^^^^^^^^^^^^^^^ - -The final set of options used for a target is constructed by -accumulating options from the current target and the usage requirements of -its dependencies. The set of options is de-duplicated to avoid repetition. - -.. versionadded:: 3.12 - While beneficial for individual options, the de-duplication step can break - up option groups. For example, ``-option A -option B`` becomes - ``-option A B``. One may specify a group of options using shell-like - quoting along with a ``SHELL:`` prefix. The ``SHELL:`` prefix is dropped, - and the rest of the option string is parsed using the - :command:`separate_arguments` ``UNIX_COMMAND`` mode. For example, - ``"SHELL:-option A" "SHELL:-option B"`` becomes ``-option A -option B``. diff --git a/Help/command/POLICY_VERSION.txt b/Help/command/POLICY_VERSION.txt deleted file mode 100644 index 424849d..0000000 --- a/Help/command/POLICY_VERSION.txt +++ /dev/null @@ -1,16 +0,0 @@ -This specifies that the current CMake code is written for the given range of -CMake versions, ``[...]``. It sets the "policy version" to: - -* the range's ```` version, if specified, or to -* the ```` version, or to -* the value of the :variable:`CMAKE_POLICY_VERSION_MINIMUM` variable - if it is higher than the other two versions. - -The policy version effectively requests behavior preferred as of a given CMake -version and tells newer CMake versions to warn about their new policies. -All policies known to the running version of CMake and introduced -in that version or earlier will be set to use ``NEW`` behavior. -All policies introduced in later versions will be unset (unless the -:variable:`CMAKE_POLICY_DEFAULT_CMP` variable sets a default). -This effectively requests behavior preferred as of a given CMake -version and tells newer CMake versions to warn about their new policies. diff --git a/Help/command/SUPPORTED_LANGUAGES.txt b/Help/command/SUPPORTED_LANGUAGES.txt deleted file mode 100644 index a98c07a..0000000 --- a/Help/command/SUPPORTED_LANGUAGES.txt +++ /dev/null @@ -1,25 +0,0 @@ - -Supported languages are ``C``, ``CXX`` (i.e. C++), ``CSharp`` (i.e. C#), ``CUDA``, -``OBJC`` (i.e. Objective-C), ``OBJCXX`` (i.e. Objective-C++), ``Fortran``, ``HIP``, -``ISPC``, ``Swift``, ``ASM``, ``ASM_NASM``, ``ASM_MARMASM``, ``ASM_MASM``, and ``ASM-ATT``. - - .. versionadded:: 3.8 - Added ``CSharp`` and ``CUDA`` support. - - .. versionadded:: 3.15 - Added ``Swift`` support. - - .. versionadded:: 3.16 - Added ``OBJC`` and ``OBJCXX`` support. - - .. versionadded:: 3.18 - Added ``ISPC`` support. - - .. versionadded:: 3.21 - Added ``HIP`` support. - - .. versionadded:: 3.26 - Added ``ASM_MARMASM`` support. - -If enabling ``ASM``, list it last so that CMake can check whether -compilers for other languages like ``C`` work for assembly too. diff --git a/Help/command/UNSET_NOTE.txt b/Help/command/UNSET_NOTE.txt deleted file mode 100644 index 8dc9125..0000000 --- a/Help/command/UNSET_NOTE.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. note:: - - When evaluating :ref:`Variable References` of the form ``${VAR}``, CMake - first searches for a normal variable with that name. If no such normal - variable exists, CMake will then search for a cache entry with that name. - Because of this, **unsetting a normal variable can expose a cache variable - that was previously hidden**. To force a variable reference of the form - ``${VAR}`` to return an empty string, use ``set( "")``, which - clears the normal variable but leaves it defined. diff --git a/Help/command/add_compile_definitions.rst b/Help/command/add_compile_definitions.rst index b2eb2af..04cb4c2 100644 --- a/Help/command/add_compile_definitions.rst +++ b/Help/command/add_compile_definitions.rst @@ -25,7 +25,7 @@ language syntax may require escapes to specify some values). Any leading ``-D`` on an item will be removed. .. |command_name| replace:: ``add_compile_definitions`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst See Also ^^^^^^^^ diff --git a/Help/command/add_compile_options.rst b/Help/command/add_compile_options.rst index 869d0c2..cd537b6 100644 --- a/Help/command/add_compile_options.rst +++ b/Help/command/add_compile_options.rst @@ -20,9 +20,9 @@ Arguments ^^^^^^^^^ .. |command_name| replace:: ``add_compile_options`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst -.. include:: OPTIONS_SHELL.txt +.. include:: include/OPTIONS_SHELL.rst Example ^^^^^^^ diff --git a/Help/command/add_link_options.rst b/Help/command/add_link_options.rst index df72715..419ee56 100644 --- a/Help/command/add_link_options.rst +++ b/Help/command/add_link_options.rst @@ -24,13 +24,13 @@ exist to add libraries (:command:`target_link_libraries` or see the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property. .. |command_name| replace:: ``add_link_options`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst -.. include:: DEVICE_LINK_OPTIONS.txt +.. include:: include/DEVICE_LINK_OPTIONS.rst -.. include:: OPTIONS_SHELL.txt +.. include:: include/OPTIONS_SHELL.rst -.. include:: LINK_OPTIONS_LINKER.txt +.. include:: include/LINK_OPTIONS_LINKER.rst See Also ^^^^^^^^ diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst index 333e514..98861f9 100644 --- a/Help/command/cmake_minimum_required.rst +++ b/Help/command/cmake_minimum_required.rst @@ -59,9 +59,9 @@ Policy Version cmake_policy(VERSION [...]) -.. include:: POLICY_VERSION.txt +.. include:: include/POLICY_VERSION.rst -.. include:: DEPRECATED_POLICY_VERSIONS.txt +.. include:: include/DEPRECATED_POLICY_VERSIONS.rst See Also ^^^^^^^^ diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst index 276e160..bbec8e6 100644 --- a/Help/command/cmake_policy.rst +++ b/Help/command/cmake_policy.rst @@ -39,12 +39,12 @@ CMake is older than 3.12, the extra ``...`` dots will be seen as version component separators, resulting in the ``...`` part being ignored and preserving the pre-3.12 behavior of basing policies on ````. -.. include:: POLICY_VERSION.txt +.. include:: include/POLICY_VERSION.rst Note that the :command:`cmake_minimum_required(VERSION)` command implicitly calls ``cmake_policy(VERSION)`` too. -.. include:: DEPRECATED_POLICY_VERSIONS.txt +.. include:: include/DEPRECATED_POLICY_VERSIONS.rst Setting Policies Explicitly ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -58,7 +58,7 @@ policy warning by setting the policy state to ``OLD``. Alternatively one may fix the project to work with the new behavior and set the policy state to ``NEW``. -.. include:: ../policy/DEPRECATED.txt +.. include:: ../policy/include/DEPRECATED.rst Checking Policy Settings ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/command/enable_language.rst b/Help/command/enable_language.rst index d587310..1bffef6 100644 --- a/Help/command/enable_language.rst +++ b/Help/command/enable_language.rst @@ -11,7 +11,7 @@ Enables support for the named languages in CMake. This is the same as the :command:`project` command but does not create any of the extra variables that are created by the :command:`project` command. -.. include:: SUPPORTED_LANGUAGES.txt +.. include:: include/SUPPORTED_LANGUAGES.rst The following restrictions apply to where ``enable_language()`` may be called: diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst index 9ef8a6d..9695ddf 100644 --- a/Help/command/find_file.rst +++ b/Help/command/find_file.rst @@ -45,4 +45,4 @@ find_file .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: :variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE` -.. include:: FIND_XXX.txt +.. include:: include/FIND_XXX.rst diff --git a/Help/command/find_library.rst b/Help/command/find_library.rst index fea5e74..b150818 100644 --- a/Help/command/find_library.rst +++ b/Help/command/find_library.rst @@ -44,7 +44,7 @@ find_library .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: :variable:`CMAKE_FIND_ROOT_PATH_MODE_LIBRARY` -.. include:: FIND_XXX.txt +.. include:: include/FIND_XXX.rst When more than one value is given to the ``NAMES`` option this command by default will consider one name at a time and search every directory diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 089a3d6..5d2e326 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -436,7 +436,7 @@ target architecture, in the following order: ``REGISTRY_VIEW`` can be specified to manage ``Windows`` registry queries specified as part of ``PATHS`` and ``HINTS``. - .. include:: FIND_XXX_REGISTRY_VIEW.txt + .. include:: include/FIND_XXX_REGISTRY_VIEW.rst If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each (``W``) or (``U``) directory entry one-by-one. @@ -620,8 +620,8 @@ before calling ``find_package``. and ``/.framework/Versions/*/Resources/CMake``. In previous versions of CMake, this order was unspecified. -.. include:: FIND_XXX_ROOT.txt -.. include:: FIND_XXX_ORDER.txt +.. include:: include/FIND_XXX_ROOT.rst +.. include:: include/FIND_XXX_ORDER.rst By default the value stored in the result variable will be the path at which the file is found. The :variable:`CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS` diff --git a/Help/command/find_path.rst b/Help/command/find_path.rst index 080c231..ab44e32 100644 --- a/Help/command/find_path.rst +++ b/Help/command/find_path.rst @@ -44,7 +44,7 @@ find_path .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: :variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE` -.. include:: FIND_XXX.txt +.. include:: include/FIND_XXX.rst When searching for frameworks, if the file is specified as ``A/b.h``, then the framework search will look for ``A.framework/Headers/b.h``. If that diff --git a/Help/command/find_program.rst b/Help/command/find_program.rst index d20ca93..bde5289 100644 --- a/Help/command/find_program.rst +++ b/Help/command/find_program.rst @@ -35,7 +35,7 @@ find_program .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: :variable:`CMAKE_FIND_ROOT_PATH_MODE_PROGRAM` -.. include:: FIND_XXX.txt +.. include:: include/FIND_XXX.rst When more than one value is given to the ``NAMES`` option this command by default will consider one name at a time and search every directory diff --git a/Help/command/include/DEPRECATED_POLICY_VERSIONS.rst b/Help/command/include/DEPRECATED_POLICY_VERSIONS.rst new file mode 100644 index 0000000..1b9f0d4 --- /dev/null +++ b/Help/command/include/DEPRECATED_POLICY_VERSIONS.rst @@ -0,0 +1,31 @@ +.. versionchanged:: 4.0 + + Compatibility with versions of CMake older than 3.5 is removed. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 3.5 as their policy version (optionally via ``...``) + will produce an error in CMake 4.0 and above. + +.. versionchanged:: 3.31 + + Compatibility with versions of CMake older than 3.10 is deprecated. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 3.10 as their policy version (optionally via ``...``) + will produce a deprecation warning in CMake 3.31 and above. + +.. versionchanged:: 3.27 + + Compatibility with versions of CMake older than 3.5 is deprecated. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 3.5 as their policy version (optionally via ``...``) + will produce a deprecation warning in CMake 3.27 and above. + +.. versionchanged:: 3.19 + + Compatibility with versions of CMake older than 2.8.12 is deprecated. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 2.8.12 as their policy version (optionally via ``...``) + will produce a deprecation warning in CMake 3.19 and above. diff --git a/Help/command/include/DEVICE_LINK_OPTIONS.rst b/Help/command/include/DEVICE_LINK_OPTIONS.rst new file mode 100644 index 0000000..878754d --- /dev/null +++ b/Help/command/include/DEVICE_LINK_OPTIONS.rst @@ -0,0 +1,12 @@ +Host And Device Specific Link Options +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 3.18 + When a device link step is involved, which is controlled by + :prop_tgt:`CUDA_SEPARABLE_COMPILATION` and + :prop_tgt:`CUDA_RESOLVE_DEVICE_SYMBOLS` properties and policy :policy:`CMP0105`, + the raw options will be delivered to the host and device link steps (wrapped in + ``-Xcompiler`` or equivalent for device link). Options wrapped with + :genex:`$` generator expression will be used + only for the device link step. Options wrapped with :genex:`$` + generator expression will be used only for the host link step. diff --git a/Help/command/include/FIND_XXX.rst b/Help/command/include/FIND_XXX.rst new file mode 100644 index 0000000..9d063ad --- /dev/null +++ b/Help/command/include/FIND_XXX.rst @@ -0,0 +1,265 @@ +A short-hand signature is: + +.. parsed-literal:: + + |FIND_XXX| ( name1 [path1 path2 ...]) + +The general signature is: + +.. parsed-literal:: + + |FIND_XXX| ( + + name | |NAMES| + [HINTS [path | ENV var]...] + [PATHS [path | ENV var]...] + [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [VALIDATOR function] + [DOC "cache documentation string"] + [NO_CACHE] + [REQUIRED|OPTIONAL] + [NO_DEFAULT_PATH] + [NO_PACKAGE_ROOT_PATH] + [NO_CMAKE_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [NO_CMAKE_INSTALL_PREFIX] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a |SEARCH_XXX_DESC|. +A cache entry, or a normal variable if ``NO_CACHE`` is specified, +named by ```` is created to store the result of this command. +If the |SEARCH_XXX| is found the result is stored in the variable +and the search will not be repeated unless the variable is cleared. +If nothing is found, the result will be ``-NOTFOUND``. + +Options include: + +``NAMES`` + Specify one or more possible names for the |SEARCH_XXX|. + + When using this to specify names with and without a version + suffix, we recommend specifying the unversioned name first + so that locally-built packages can be found before those + provided by distributions. + +``HINTS``, ``PATHS`` + Specify directories to search in addition to the default locations. + The ``ENV var`` sub-option reads paths from a system environment + variable. + + .. versionchanged:: 3.24 + On ``Windows`` platform, it is possible to include registry queries as part + of the directories, using a :ref:`dedicated syntax `. + Such specifications will be ignored on all other platforms. + +``REGISTRY_VIEW`` + .. versionadded:: 3.24 + + .. include:: include/FIND_XXX_REGISTRY_VIEW.rst + +``PATH_SUFFIXES`` + Specify additional subdirectories to check below each directory + location otherwise considered. + +``VALIDATOR`` + .. versionadded:: 3.25 + + Specify a :command:`function` to be called for each candidate item found + (a :command:`macro` cannot be provided, that will result in an error). + Two arguments will be passed to the validator function: the name of a + result variable, and the absolute path to the candidate item. The item + will be accepted and the search will end unless the function sets the + value in the result variable to false in the calling scope. The result + variable will hold a true value when the validator function is entered. + + .. parsed-literal:: + + function(my_check validator_result_var item) + if(NOT item MATCHES ...) + set(${validator_result_var} FALSE PARENT_SCOPE) + endif() + endfunction() + + |FIND_XXX| (result NAMES ... VALIDATOR my_check) + + Note that if a cached result is used, the search is skipped and any + ``VALIDATOR`` is ignored. The cached result is not required to pass the + validation function. + +``DOC`` + Specify the documentation string for the ```` cache entry. + +``NO_CACHE`` + .. versionadded:: 3.21 + + The result of the search will be stored in a normal variable rather than + a cache entry. + + .. note:: + + If the variable is already set before the call (as a normal or cache + variable) then the search will not occur. + + .. warning:: + + This option should be used with caution because it can greatly increase + the cost of repeated configure steps. + +``REQUIRED`` + .. versionadded:: 3.18 + + Stop processing with an error message if nothing is found, otherwise + the search will be attempted again the next time |FIND_XXX| is invoked + with the same variable. + + .. versionadded:: 4.1 + + Every |FIND_XXX| command will be treated as ``REQUIRED`` when the + :variable:`CMAKE_FIND_REQUIRED` variable is enabled. + +``OPTIONAL`` + .. versionadded:: 4.1 + + Ignore the value of :variable:`CMAKE_FIND_REQUIRED` and + continue without an error message if nothing is found. + Incompatible with ``REQUIRED``. + +If ``NO_DEFAULT_PATH`` is specified, then no additional paths are +added to the search. +If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: + +.. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ```` in the + :variable:`_ROOT` CMake variable and the + :envvar:`_ROOT` environment variable if + called from within a find module loaded by + :command:`find_package()` + +.. |CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ```` in :variable:`CMAKE_PREFIX_PATH` + +.. |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ```` in :envvar:`CMAKE_PREFIX_PATH` + +.. |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ``/[s]bin`` in ``PATH``, and + |entry_XXX_SUBDIR| for other entries in ``PATH`` + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ```` in + :variable:`CMAKE_SYSTEM_PREFIX_PATH` + +1. If called from within a find module or any other script loaded by a call to + :command:`find_package()`, search prefixes unique to the + current package being found. See policy :policy:`CMP0074`. + + .. versionadded:: 3.12 + + Specifically, search paths specified by the following variables, in order: + + a. :variable:`_ROOT` CMake variable, + where ```` is the case-preserved package name. + + b. :variable:`_ROOT` CMake variable, + where ```` is the upper-cased package name. + See policy :policy:`CMP0144`. + + .. versionadded:: 3.27 + + c. :envvar:`_ROOT` environment variable, + where ```` is the case-preserved package name. + + d. :envvar:`_ROOT` environment variable, + where ```` is the upper-cased package name. + See policy :policy:`CMP0144`. + + .. versionadded:: 3.27 + + The package root variables are maintained as a stack, so if called from + nested find modules or config packages, root paths from the parent's find + module or config package will be searched after paths from the current + module or package. In other words, the search order would be + ``_ROOT``, ``ENV{_ROOT}``, + ``_ROOT``, ``ENV{_ROOT}``, etc. + This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting + the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``. + + * |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| + +2. Search paths specified in cmake-specific cache variables. + These are intended to be used on the command line with a ``-DVAR=value``. + The values are interpreted as :ref:`semicolon-separated lists `. + This can be skipped if ``NO_CMAKE_PATH`` is passed or by setting the + :variable:`CMAKE_FIND_USE_CMAKE_PATH` to ``FALSE``. + + * |CMAKE_PREFIX_PATH_XXX| + * |CMAKE_XXX_PATH| + * |CMAKE_XXX_MAC_PATH| + +3. Search paths specified in cmake-specific environment variables. + These are intended to be set in the user's shell configuration, + and therefore use the host's native path separator + (``;`` on Windows and ``:`` on UNIX). + This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed or + by setting the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` to ``FALSE``. + + * |ENV_CMAKE_PREFIX_PATH_XXX| + * |ENV_CMAKE_XXX_PATH| + * |ENV_CMAKE_XXX_MAC_PATH| + +4. Search the paths specified by the ``HINTS`` option. + These should be paths computed by system introspection, such as a + hint provided by the location of another item already found. + Hard-coded guesses should be specified with the ``PATHS`` option. + +5. Search the standard system environment variables. + This can be skipped if ``NO_SYSTEM_ENVIRONMENT_PATH`` is passed or by + setting the :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` to ``FALSE``. + + * |SYSTEM_ENVIRONMENT_PATH_XXX| + + |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| + +6. Search cmake variables defined in the Platform files + for the current system. The searching of ``CMAKE_INSTALL_PREFIX`` and + ``CMAKE_STAGING_PREFIX`` can be + skipped if ``NO_CMAKE_INSTALL_PREFIX`` is passed or by setting the + :variable:`CMAKE_FIND_USE_INSTALL_PREFIX` to ``FALSE``. All these locations + can be skipped if ``NO_CMAKE_SYSTEM_PATH`` is passed or by setting the + :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` to ``FALSE``. + + * |CMAKE_SYSTEM_PREFIX_PATH_XXX| + * |CMAKE_SYSTEM_XXX_PATH| + * |CMAKE_SYSTEM_XXX_MAC_PATH| + + The platform paths that these variables contain are locations that + typically include installed software. An example being ``/usr/local`` for + UNIX based platforms. + +7. Search the paths specified by the PATHS option + or in the short-hand version of the command. + These are typically hard-coded guesses. + +The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`, +:variable:`CMAKE_SYSTEM_IGNORE_PATH` and +:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some +of the above locations to be ignored. + +.. versionadded:: 3.16 + Added ``CMAKE_FIND_USE__PATH`` variables to globally disable + various search locations. + +.. |FIND_ARGS_XXX| replace:: NAMES name + +On macOS the :variable:`CMAKE_FIND_FRAMEWORK` and +:variable:`CMAKE_FIND_APPBUNDLE` variables determine the order of +preference between Apple-style and unix-style package components. + +.. include:: include/FIND_XXX_ROOT.rst +.. include:: include/FIND_XXX_ORDER.rst diff --git a/Help/command/include/FIND_XXX_ORDER.rst b/Help/command/include/FIND_XXX_ORDER.rst new file mode 100644 index 0000000..bac2419 --- /dev/null +++ b/Help/command/include/FIND_XXX_ORDER.rst @@ -0,0 +1,12 @@ +The default search order is designed to be most-specific to +least-specific for common use cases. +Projects may override the order by simply calling the command +multiple times and using the ``NO_*`` options: + +.. parsed-literal:: + + |FIND_XXX| (|FIND_ARGS_XXX| PATHS paths... NO_DEFAULT_PATH) + |FIND_XXX| (|FIND_ARGS_XXX|) + +Once one of the calls succeeds the result variable will be set +and stored in the cache so that no call will search again. diff --git a/Help/command/include/FIND_XXX_REGISTRY_VIEW.rst b/Help/command/include/FIND_XXX_REGISTRY_VIEW.rst new file mode 100644 index 0000000..6cab1d1 --- /dev/null +++ b/Help/command/include/FIND_XXX_REGISTRY_VIEW.rst @@ -0,0 +1,41 @@ +Specify which registry views must be queried. This option is only meaningful +on ``Windows`` platforms and will be ignored on other ones. When not +specified, the |FIND_XXX_REGISTRY_VIEW_DEFAULT| view is used when the +:policy:`CMP0134` policy is ``NEW``. Refer to :policy:`CMP0134` for the +default view when the policy is ``OLD``. + +``64`` + Query the 64-bit registry. On 32-bit Windows, it always returns the string + ``/REGISTRY-NOTFOUND``. + +``32`` + Query the 32-bit registry. + +``64_32`` + Query both views (``64`` and ``32``) and generate a path for each. + +``32_64`` + Query both views (``32`` and ``64``) and generate a path for each. + +``HOST`` + Query the registry matching the architecture of the host: ``64`` on 64-bit + Windows and ``32`` on 32-bit Windows. + +``TARGET`` + Query the registry matching the architecture specified by the + :variable:`CMAKE_SIZEOF_VOID_P` variable. If not defined, fall back to + ``HOST`` view. + +``BOTH`` + Query both views (``32`` and ``64``). The order depends on the following + rules: If the :variable:`CMAKE_SIZEOF_VOID_P` variable is defined, use the + following view depending on the content of this variable: + + * ``8``: ``64_32`` + * ``4``: ``32_64`` + + If the :variable:`CMAKE_SIZEOF_VOID_P` variable is not defined, rely on the + architecture of the host: + + * 64-bit: ``64_32`` + * 32-bit: ``32`` diff --git a/Help/command/include/FIND_XXX_ROOT.rst b/Help/command/include/FIND_XXX_ROOT.rst new file mode 100644 index 0000000..fab2303 --- /dev/null +++ b/Help/command/include/FIND_XXX_ROOT.rst @@ -0,0 +1,29 @@ +The CMake variable :variable:`CMAKE_FIND_ROOT_PATH` specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. +Paths which are descendants of the :variable:`CMAKE_STAGING_PREFIX` are excluded +from this re-rooting, because that variable is always a path on the host system. +By default the :variable:`CMAKE_FIND_ROOT_PATH` is empty. + +The :variable:`CMAKE_SYSROOT` variable can also be used to specify exactly one +directory to use as a prefix. Setting :variable:`CMAKE_SYSROOT` also has other +effects. See the documentation for that variable for more. + +These variables are especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +:variable:`CMAKE_FIND_ROOT_PATH` are searched, then the :variable:`CMAKE_SYSROOT` +directory is searched, and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +|CMAKE_FIND_ROOT_PATH_MODE_XXX|. This behavior can be manually +overridden on a per-call basis using options: + +``CMAKE_FIND_ROOT_PATH_BOTH`` + Search in the order described above. + +``NO_CMAKE_FIND_ROOT_PATH`` + Do not use the :variable:`CMAKE_FIND_ROOT_PATH` variable. + +``ONLY_CMAKE_FIND_ROOT_PATH`` + Search only the re-rooted directories and directories below + :variable:`CMAKE_STAGING_PREFIX`. diff --git a/Help/command/include/GENEX_NOTE.rst b/Help/command/include/GENEX_NOTE.rst new file mode 100644 index 0000000..4a7906c --- /dev/null +++ b/Help/command/include/GENEX_NOTE.rst @@ -0,0 +1,6 @@ +.. |more_see_also| replace:: See the :manual:`cmake-buildsystem(7)` manual + for more on defining buildsystem properties. + +Arguments to |command_name| may use generator expressions +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. |more_see_also| diff --git a/Help/command/include/LINK_LIBRARIES_LINKER.rst b/Help/command/include/LINK_LIBRARIES_LINKER.rst new file mode 100644 index 0000000..45669f2 --- /dev/null +++ b/Help/command/include/LINK_LIBRARIES_LINKER.rst @@ -0,0 +1,24 @@ +Handling Compiler Driver Differences +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 4.0 + +To pass options to the linker tool, each compiler driver has its own syntax. +The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable +way, options to pass to the linker tool. ``LINKER:`` is replaced by the +appropriate driver option and ``,`` by the appropriate driver separator. +The driver prefix and driver separator are given by the values of the +:variable:`CMAKE__LINKER_WRAPPER_FLAG` and +:variable:`CMAKE__LINKER_WRAPPER_FLAG_SEP` variables. + +For example, ``"LINKER:-z,defs"`` becomes ``-Xlinker -z -Xlinker defs`` for +``Clang`` and ``-Wl,-z,defs`` for ``GNU GCC``. + +The ``LINKER:`` prefix supports, as an alternative syntax, specification of +arguments using the ``SHELL:`` prefix and space as separator. The previous +example then becomes ``"LINKER:SHELL:-z defs"``. + +.. note:: + + Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the + ``LINKER:`` prefix is not supported. diff --git a/Help/command/include/LINK_OPTIONS_LINKER.rst b/Help/command/include/LINK_OPTIONS_LINKER.rst new file mode 100644 index 0000000..e71e5ea --- /dev/null +++ b/Help/command/include/LINK_OPTIONS_LINKER.rst @@ -0,0 +1,25 @@ +Handling Compiler Driver Differences +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To pass options to the linker tool, each compiler driver has its own syntax. +The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable +way, options to pass to the linker tool. ``LINKER:`` is replaced by the +appropriate driver option and ``,`` by the appropriate driver separator. +The driver prefix and driver separator are given by the values of the +:variable:`CMAKE__LINKER_WRAPPER_FLAG` and +:variable:`CMAKE__LINKER_WRAPPER_FLAG_SEP` variables. + +For example, ``"LINKER:-z,defs"`` becomes ``-Xlinker -z -Xlinker defs`` for +``Clang`` and ``-Wl,-z,defs`` for ``GNU GCC``. + +The ``LINKER:`` prefix can be specified as part of a ``SHELL:`` prefix +expression. + +The ``LINKER:`` prefix supports, as an alternative syntax, specification of +arguments using the ``SHELL:`` prefix and space as separator. The previous +example then becomes ``"LINKER:SHELL:-z defs"``. + +.. note:: + + Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the + ``LINKER:`` prefix is not supported. diff --git a/Help/command/include/OPTIONS_SHELL.rst b/Help/command/include/OPTIONS_SHELL.rst new file mode 100644 index 0000000..4171f01 --- /dev/null +++ b/Help/command/include/OPTIONS_SHELL.rst @@ -0,0 +1,15 @@ +Option De-duplication +^^^^^^^^^^^^^^^^^^^^^ + +The final set of options used for a target is constructed by +accumulating options from the current target and the usage requirements of +its dependencies. The set of options is de-duplicated to avoid repetition. + +.. versionadded:: 3.12 + While beneficial for individual options, the de-duplication step can break + up option groups. For example, ``-option A -option B`` becomes + ``-option A B``. One may specify a group of options using shell-like + quoting along with a ``SHELL:`` prefix. The ``SHELL:`` prefix is dropped, + and the rest of the option string is parsed using the + :command:`separate_arguments` ``UNIX_COMMAND`` mode. For example, + ``"SHELL:-option A" "SHELL:-option B"`` becomes ``-option A -option B``. diff --git a/Help/command/include/POLICY_VERSION.rst b/Help/command/include/POLICY_VERSION.rst new file mode 100644 index 0000000..424849d --- /dev/null +++ b/Help/command/include/POLICY_VERSION.rst @@ -0,0 +1,16 @@ +This specifies that the current CMake code is written for the given range of +CMake versions, ``[...]``. It sets the "policy version" to: + +* the range's ```` version, if specified, or to +* the ```` version, or to +* the value of the :variable:`CMAKE_POLICY_VERSION_MINIMUM` variable + if it is higher than the other two versions. + +The policy version effectively requests behavior preferred as of a given CMake +version and tells newer CMake versions to warn about their new policies. +All policies known to the running version of CMake and introduced +in that version or earlier will be set to use ``NEW`` behavior. +All policies introduced in later versions will be unset (unless the +:variable:`CMAKE_POLICY_DEFAULT_CMP` variable sets a default). +This effectively requests behavior preferred as of a given CMake +version and tells newer CMake versions to warn about their new policies. diff --git a/Help/command/include/SUPPORTED_LANGUAGES.rst b/Help/command/include/SUPPORTED_LANGUAGES.rst new file mode 100644 index 0000000..a98c07a --- /dev/null +++ b/Help/command/include/SUPPORTED_LANGUAGES.rst @@ -0,0 +1,25 @@ + +Supported languages are ``C``, ``CXX`` (i.e. C++), ``CSharp`` (i.e. C#), ``CUDA``, +``OBJC`` (i.e. Objective-C), ``OBJCXX`` (i.e. Objective-C++), ``Fortran``, ``HIP``, +``ISPC``, ``Swift``, ``ASM``, ``ASM_NASM``, ``ASM_MARMASM``, ``ASM_MASM``, and ``ASM-ATT``. + + .. versionadded:: 3.8 + Added ``CSharp`` and ``CUDA`` support. + + .. versionadded:: 3.15 + Added ``Swift`` support. + + .. versionadded:: 3.16 + Added ``OBJC`` and ``OBJCXX`` support. + + .. versionadded:: 3.18 + Added ``ISPC`` support. + + .. versionadded:: 3.21 + Added ``HIP`` support. + + .. versionadded:: 3.26 + Added ``ASM_MARMASM`` support. + +If enabling ``ASM``, list it last so that CMake can check whether +compilers for other languages like ``C`` work for assembly too. diff --git a/Help/command/include/UNSET_NOTE.rst b/Help/command/include/UNSET_NOTE.rst new file mode 100644 index 0000000..8dc9125 --- /dev/null +++ b/Help/command/include/UNSET_NOTE.rst @@ -0,0 +1,9 @@ +.. note:: + + When evaluating :ref:`Variable References` of the form ``${VAR}``, CMake + first searches for a normal variable with that name. If no such normal + variable exists, CMake will then search for a cache entry with that name. + Because of this, **unsetting a normal variable can expose a cache variable + that was previously hidden**. To force a variable reference of the form + ``${VAR}`` to return an empty string, use ``set( "")``, which + clears the normal variable but leaves it defined. diff --git a/Help/command/include_directories.rst b/Help/command/include_directories.rst index e68bb81..dcb5620 100644 --- a/Help/command/include_directories.rst +++ b/Help/command/include_directories.rst @@ -30,7 +30,7 @@ skipping warnings, or these fixed-install system files not being considered in dependency calculations - see compiler docs. .. |command_name| replace:: ``include_directories`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst .. note:: diff --git a/Help/command/project.rst b/Help/command/project.rst index b42a034..0b274e2 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -123,7 +123,7 @@ The options are: Selects which programming languages are needed to build the project. -.. include:: SUPPORTED_LANGUAGES.txt +.. include:: include/SUPPORTED_LANGUAGES.rst By default ``C`` and ``CXX`` are enabled if no language options are given. Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages, diff --git a/Help/command/set.rst b/Help/command/set.rst index fa635c6..6c1af47 100644 --- a/Help/command/set.rst +++ b/Help/command/set.rst @@ -38,7 +38,7 @@ Set Normal Variable can be used as an alternate method to the :command:`set(PARENT_SCOPE)` and :command:`unset(PARENT_SCOPE)` commands to update the parent scope. -.. include:: UNSET_NOTE.txt +.. include:: include/UNSET_NOTE.rst Set Cache Entry ^^^^^^^^^^^^^^^ diff --git a/Help/command/target_compile_definitions.rst b/Help/command/target_compile_definitions.rst index 5796b00..61cfb19 100644 --- a/Help/command/target_compile_definitions.rst +++ b/Help/command/target_compile_definitions.rst @@ -26,7 +26,7 @@ same ```` append items in the order called. Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets `. .. |command_name| replace:: ``target_compile_definitions`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst Any leading ``-D`` on an item will be removed. Empty items are ignored. For example, the following are all equivalent: diff --git a/Help/command/target_compile_features.rst b/Help/command/target_compile_features.rst index 531af81..1b40948 100644 --- a/Help/command/target_compile_features.rst +++ b/Help/command/target_compile_features.rst @@ -33,7 +33,7 @@ The named ```` must have been created by a command such as .. |command_name| replace:: ``target_compile_features`` .. |more_see_also| replace:: See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst :start-line: 1 See Also diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst index 64f45aa..c734c1a 100644 --- a/Help/command/target_compile_options.rst +++ b/Help/command/target_compile_options.rst @@ -39,9 +39,9 @@ The following arguments specify compile options. Repeated calls for the same Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets `. .. |command_name| replace:: ``target_compile_options`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst -.. include:: OPTIONS_SHELL.txt +.. include:: include/OPTIONS_SHELL.rst See Also ^^^^^^^^ diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst index bb5f9c3..38bf581 100644 --- a/Help/command/target_include_directories.rst +++ b/Help/command/target_include_directories.rst @@ -41,7 +41,7 @@ If ``SYSTEM`` is used together with ``PUBLIC`` or ``INTERFACE``, the populated with the specified directories. .. |command_name| replace:: ``target_include_directories`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst Specified include directories may be absolute paths or relative paths. A relative path will be interpreted as relative to the current source @@ -71,7 +71,7 @@ Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES` -.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt +.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst See Also ^^^^^^^^ diff --git a/Help/command/target_link_directories.rst b/Help/command/target_link_directories.rst index 67d3352..2226e4c 100644 --- a/Help/command/target_link_directories.rst +++ b/Help/command/target_link_directories.rst @@ -35,7 +35,7 @@ If ``BEFORE`` is specified, the content will be prepended to the relevant property instead of being appended. .. |command_name| replace:: ``target_link_directories`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst .. note:: diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst index 4a1140b..a8ba92c 100644 --- a/Help/command/target_link_libraries.rst +++ b/Help/command/target_link_libraries.rst @@ -150,7 +150,7 @@ command lines. See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. -.. include:: ../command/LINK_LIBRARIES_LINKER.txt +.. include:: ../command/include/LINK_LIBRARIES_LINKER.rst Libraries for a Target and/or its Dependents ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -416,7 +416,7 @@ Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: :prop_tgt:`INTERFACE_LINK_LIBRARIES` -.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.rst See Also ^^^^^^^^ diff --git a/Help/command/target_link_options.rst b/Help/command/target_link_options.rst index 7561c99..07ef7e9 100644 --- a/Help/command/target_link_options.rst +++ b/Help/command/target_link_options.rst @@ -43,13 +43,13 @@ The following arguments specify link options. Repeated calls for the same :ref:`IMPORTED targets ` only support ``INTERFACE`` items. .. |command_name| replace:: ``target_link_options`` -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst -.. include:: DEVICE_LINK_OPTIONS.txt +.. include:: include/DEVICE_LINK_OPTIONS.rst -.. include:: OPTIONS_SHELL.txt +.. include:: include/OPTIONS_SHELL.rst -.. include:: LINK_OPTIONS_LINKER.txt +.. include:: include/LINK_OPTIONS_LINKER.rst See Also ^^^^^^^^ diff --git a/Help/command/target_precompile_headers.rst b/Help/command/target_precompile_headers.rst index 61ea0aa..61bd973 100644 --- a/Help/command/target_precompile_headers.rst +++ b/Help/command/target_precompile_headers.rst @@ -78,7 +78,7 @@ included by absolute path. For example: brackets must be specified by absolute path. Also, when specifying angle brackets inside a generator expression, be sure to encode the closing ``>`` as :genex:`$`. For example: -.. include:: GENEX_NOTE.txt +.. include:: include/GENEX_NOTE.rst :start-line: 1 .. code-block:: cmake diff --git a/Help/command/unset.rst b/Help/command/unset.rst index 522be89..f78d01f 100644 --- a/Help/command/unset.rst +++ b/Help/command/unset.rst @@ -18,7 +18,7 @@ If ``PARENT_SCOPE`` is present then the variable is removed from the scope above the current scope. See the same option in the :command:`set` command for further details. -.. include:: UNSET_NOTE.txt +.. include:: include/UNSET_NOTE.rst Unset Environment Variable ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/envvar/ADSP_ROOT.rst b/Help/envvar/ADSP_ROOT.rst index ee2328b..f624ac4 100644 --- a/Help/envvar/ADSP_ROOT.rst +++ b/Help/envvar/ADSP_ROOT.rst @@ -3,7 +3,7 @@ ADSP_ROOT .. versionadded:: 3.24 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``ADSP_ROOT`` environment variable specifies a default value for the :variable:`CMAKE_ADSP_ROOT` variable when there is no explicit diff --git a/Help/envvar/ASM_DIALECT.rst b/Help/envvar/ASM_DIALECT.rst index 11dbe5a..4c271fd 100644 --- a/Help/envvar/ASM_DIALECT.rst +++ b/Help/envvar/ASM_DIALECT.rst @@ -1,7 +1,7 @@ ASM ------------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling a specific dialect of assembly language files. ``ASM`` can be one of: diff --git a/Help/envvar/ASM_DIALECTFLAGS.rst b/Help/envvar/ASM_DIALECTFLAGS.rst index f13efbb..e2b48a1 100644 --- a/Help/envvar/ASM_DIALECTFLAGS.rst +++ b/Help/envvar/ASM_DIALECTFLAGS.rst @@ -1,7 +1,7 @@ ASMFLAGS ----------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling a specific dialect of an assembly language. ``ASMFLAGS`` can be one of: @@ -14,6 +14,6 @@ of an assembly language. ``ASMFLAGS`` can be one of: .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_ASM_FLAGS _FLAGS>` .. |LANG| replace:: ``ASM`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_ASM_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/CC.rst b/Help/envvar/CC.rst index 1bb8d51..31867e4 100644 --- a/Help/envvar/CC.rst +++ b/Help/envvar/CC.rst @@ -1,7 +1,7 @@ CC -- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``C`` language files. Will only be used by CMake on the first configuration to determine ``C`` compiler, after which the diff --git a/Help/envvar/CFLAGS.rst b/Help/envvar/CFLAGS.rst index a6b2452..987ff3b 100644 --- a/Help/envvar/CFLAGS.rst +++ b/Help/envvar/CFLAGS.rst @@ -1,12 +1,12 @@ CFLAGS ------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``C`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_C_FLAGS _FLAGS>` .. |LANG| replace:: ``C`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_C_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/CLICOLOR.rst b/Help/envvar/CLICOLOR.rst index 404e79e..b899ded 100644 --- a/Help/envvar/CLICOLOR.rst +++ b/Help/envvar/CLICOLOR.rst @@ -3,7 +3,7 @@ CLICOLOR .. versionadded:: 3.21 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Set to ``0`` to tell command-line tools not to print color messages even if connected to a terminal. diff --git a/Help/envvar/CLICOLOR_FORCE.rst b/Help/envvar/CLICOLOR_FORCE.rst index 639ed85..60a54fb 100644 --- a/Help/envvar/CLICOLOR_FORCE.rst +++ b/Help/envvar/CLICOLOR_FORCE.rst @@ -3,7 +3,7 @@ CLICOLOR_FORCE .. versionadded:: 3.5 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Set to a non-empty value, other than ``0``, to tell command-line tools to print color messages even if not connected to a terminal. diff --git a/Help/envvar/CMAKE_APPBUNDLE_PATH.rst b/Help/envvar/CMAKE_APPBUNDLE_PATH.rst index d80e08d..7b5f761 100644 --- a/Help/envvar/CMAKE_APPBUNDLE_PATH.rst +++ b/Help/envvar/CMAKE_APPBUNDLE_PATH.rst @@ -1,7 +1,7 @@ CMAKE_APPBUNDLE_PATH -------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_APPBUNDLE_PATH`` environment variable may be set to a list of directories to be searched for macOS application bundles diff --git a/Help/envvar/CMAKE_APPLE_SILICON_PROCESSOR.rst b/Help/envvar/CMAKE_APPLE_SILICON_PROCESSOR.rst index adecb72..31558ea 100644 --- a/Help/envvar/CMAKE_APPLE_SILICON_PROCESSOR.rst +++ b/Help/envvar/CMAKE_APPLE_SILICON_PROCESSOR.rst @@ -3,7 +3,7 @@ CMAKE_APPLE_SILICON_PROCESSOR .. versionadded:: 3.19.2 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst On Apple Silicon hosts running macOS, set this environment variable to tell CMake what architecture to use for :variable:`CMAKE_HOST_SYSTEM_PROCESSOR`. diff --git a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst index a50797c..0030469 100644 --- a/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst +++ b/Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst @@ -3,7 +3,7 @@ CMAKE_BUILD_PARALLEL_LEVEL .. versionadded:: 3.12 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specifies the maximum number of concurrent processes to use when building using the ``cmake --build`` command line diff --git a/Help/envvar/CMAKE_BUILD_TYPE.rst b/Help/envvar/CMAKE_BUILD_TYPE.rst index f798aff..b2627f7 100644 --- a/Help/envvar/CMAKE_BUILD_TYPE.rst +++ b/Help/envvar/CMAKE_BUILD_TYPE.rst @@ -3,7 +3,7 @@ CMAKE_BUILD_TYPE .. versionadded:: 3.22 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_BUILD_TYPE`` environment variable specifies a default value for the :variable:`CMAKE_BUILD_TYPE` variable when there is no explicit diff --git a/Help/envvar/CMAKE_COLOR_DIAGNOSTICS.rst b/Help/envvar/CMAKE_COLOR_DIAGNOSTICS.rst index d3d0aa9..2f34e00 100644 --- a/Help/envvar/CMAKE_COLOR_DIAGNOSTICS.rst +++ b/Help/envvar/CMAKE_COLOR_DIAGNOSTICS.rst @@ -3,7 +3,7 @@ CMAKE_COLOR_DIAGNOSTICS .. versionadded:: 3.24 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specifies a default value for the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable when there is no explicit value given on the first run. diff --git a/Help/envvar/CMAKE_CONFIGURATION_TYPES.rst b/Help/envvar/CMAKE_CONFIGURATION_TYPES.rst index 833aa4a..39d98c4 100644 --- a/Help/envvar/CMAKE_CONFIGURATION_TYPES.rst +++ b/Help/envvar/CMAKE_CONFIGURATION_TYPES.rst @@ -3,7 +3,7 @@ CMAKE_CONFIGURATION_TYPES .. versionadded:: 3.22 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_CONFIGURATION_TYPES`` environment variable specifies a default value for the :variable:`CMAKE_CONFIGURATION_TYPES` variable diff --git a/Help/envvar/CMAKE_CONFIG_DIR.rst b/Help/envvar/CMAKE_CONFIG_DIR.rst index 1b5f14f..8f93a56 100644 --- a/Help/envvar/CMAKE_CONFIG_DIR.rst +++ b/Help/envvar/CMAKE_CONFIG_DIR.rst @@ -3,7 +3,7 @@ CMAKE_CONFIG_DIR .. versionadded:: 3.31 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify a CMake user-wide configuration directory for :manual:`cmake-file-api(7)` queries. diff --git a/Help/envvar/CMAKE_CONFIG_TYPE.rst b/Help/envvar/CMAKE_CONFIG_TYPE.rst index 168593d..d1d2301 100644 --- a/Help/envvar/CMAKE_CONFIG_TYPE.rst +++ b/Help/envvar/CMAKE_CONFIG_TYPE.rst @@ -1,7 +1,7 @@ CMAKE_CONFIG_TYPE ----------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default build configuration for :ref:`Build Tool Mode` and ``ctest`` build handler when there is no explicit configuration given. diff --git a/Help/envvar/CMAKE_CROSSCOMPILING_EMULATOR.rst b/Help/envvar/CMAKE_CROSSCOMPILING_EMULATOR.rst index 3e397d8..40d6c84 100644 --- a/Help/envvar/CMAKE_CROSSCOMPILING_EMULATOR.rst +++ b/Help/envvar/CMAKE_CROSSCOMPILING_EMULATOR.rst @@ -3,7 +3,7 @@ CMAKE_CROSSCOMPILING_EMULATOR .. versionadded:: 3.28 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default value for :variable:`CMAKE_CROSSCOMPILING_EMULATOR` when there is no explicit configuration given on the first run while creating a new diff --git a/Help/envvar/CMAKE_EXPORT_BUILD_DATABASE.rst b/Help/envvar/CMAKE_EXPORT_BUILD_DATABASE.rst index a9d868a..368617d 100644 --- a/Help/envvar/CMAKE_EXPORT_BUILD_DATABASE.rst +++ b/Help/envvar/CMAKE_EXPORT_BUILD_DATABASE.rst @@ -3,7 +3,7 @@ CMAKE_EXPORT_BUILD_DATABASE .. versionadded:: 3.31 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default value for :variable:`CMAKE_EXPORT_BUILD_DATABASE` when there is no explicit configuration given on the first run while creating a new build tree. diff --git a/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst index 9e678be..50800aa 100644 --- a/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst +++ b/Help/envvar/CMAKE_EXPORT_COMPILE_COMMANDS.rst @@ -3,7 +3,7 @@ CMAKE_EXPORT_COMPILE_COMMANDS .. versionadded:: 3.17 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default value for :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` when there is no explicit configuration given on the first run while creating a new diff --git a/Help/envvar/CMAKE_FRAMEWORK_PATH.rst b/Help/envvar/CMAKE_FRAMEWORK_PATH.rst index f543132..e8a360d 100644 --- a/Help/envvar/CMAKE_FRAMEWORK_PATH.rst +++ b/Help/envvar/CMAKE_FRAMEWORK_PATH.rst @@ -1,7 +1,7 @@ CMAKE_FRAMEWORK_PATH -------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_FRAMEWORK_PATH`` environment variable may be set to a list of directories to be searched for macOS frameworks by the :command:`find_library`, diff --git a/Help/envvar/CMAKE_GENERATOR.rst b/Help/envvar/CMAKE_GENERATOR.rst index 596e8f3..284b15c 100644 --- a/Help/envvar/CMAKE_GENERATOR.rst +++ b/Help/envvar/CMAKE_GENERATOR.rst @@ -3,7 +3,7 @@ CMAKE_GENERATOR .. versionadded:: 3.15 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specifies the CMake default generator to use when no generator is supplied with :option:`-G `. If the provided value doesn't name a generator diff --git a/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst index 8ca7d80..a3efbbd 100644 --- a/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst +++ b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst @@ -3,7 +3,7 @@ CMAKE_GENERATOR_INSTANCE .. versionadded:: 3.15 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Default value for :variable:`CMAKE_GENERATOR_INSTANCE` if no Cache entry is present. This value is only applied if :envvar:`CMAKE_GENERATOR` is set. diff --git a/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst index e657904..0c0d9aa 100644 --- a/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst +++ b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst @@ -3,7 +3,7 @@ CMAKE_GENERATOR_PLATFORM .. versionadded:: 3.15 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry is present and no value is specified by :option:`cmake -A` option. diff --git a/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst index 03208e7..f90b62d 100644 --- a/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst +++ b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst @@ -3,7 +3,7 @@ CMAKE_GENERATOR_TOOLSET .. versionadded:: 3.15 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry is present and no value is specified by :option:`cmake -T` option. diff --git a/Help/envvar/CMAKE_INCLUDE_PATH.rst b/Help/envvar/CMAKE_INCLUDE_PATH.rst index a42460d..d4093dc 100644 --- a/Help/envvar/CMAKE_INCLUDE_PATH.rst +++ b/Help/envvar/CMAKE_INCLUDE_PATH.rst @@ -1,7 +1,7 @@ CMAKE_INCLUDE_PATH ------------------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_INCLUDE_PATH`` environment variable may be set to a list of directories to be searched by the :command:`find_file` and :command:`find_path` commands. diff --git a/Help/envvar/CMAKE_INSTALL_MODE.rst b/Help/envvar/CMAKE_INSTALL_MODE.rst index 4549ea1..eab90a1 100644 --- a/Help/envvar/CMAKE_INSTALL_MODE.rst +++ b/Help/envvar/CMAKE_INSTALL_MODE.rst @@ -3,7 +3,7 @@ CMAKE_INSTALL_MODE .. versionadded:: 3.22 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_INSTALL_MODE`` environment variable allows users to operate CMake in an alternate mode of :command:`file(INSTALL)` and :command:`install()`. diff --git a/Help/envvar/CMAKE_INSTALL_PARALLEL_LEVEL.rst b/Help/envvar/CMAKE_INSTALL_PARALLEL_LEVEL.rst index 84b5930..6af6732 100644 --- a/Help/envvar/CMAKE_INSTALL_PARALLEL_LEVEL.rst +++ b/Help/envvar/CMAKE_INSTALL_PARALLEL_LEVEL.rst @@ -3,7 +3,7 @@ CMAKE_INSTALL_PARALLEL_LEVEL .. versionadded:: 3.31 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specifies the default maximum number of concurrent processes to use when installing using ``cmake --install``. diff --git a/Help/envvar/CMAKE_INSTALL_PREFIX.rst b/Help/envvar/CMAKE_INSTALL_PREFIX.rst index 5c3e055..a80b537 100644 --- a/Help/envvar/CMAKE_INSTALL_PREFIX.rst +++ b/Help/envvar/CMAKE_INSTALL_PREFIX.rst @@ -3,7 +3,7 @@ CMAKE_INSTALL_PREFIX .. versionadded:: 3.29 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_INSTALL_PREFIX`` environment variable specifies a custom default value for the :variable:`CMAKE_INSTALL_PREFIX` variable in place of the diff --git a/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst b/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst index c384fa1..d70bed0 100644 --- a/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst +++ b/Help/envvar/CMAKE_LANG_COMPILER_LAUNCHER.rst @@ -3,7 +3,7 @@ CMAKE__COMPILER_LAUNCHER .. versionadded:: 3.17 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Default compiler launcher to use for the specified language. Will only be used by CMake to initialize the variable on the first configuration. Afterwards, it diff --git a/Help/envvar/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE.rst b/Help/envvar/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE.rst index 36c79fa..d21c6a8 100644 --- a/Help/envvar/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE.rst +++ b/Help/envvar/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE.rst @@ -3,7 +3,7 @@ CMAKE__IMPLICIT_LINK_DIRECTORIES_EXCLUDE .. versionadded:: 3.27 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst A :ref:`semicolon-separated list ` of directories to exclude from the :variable:`CMAKE__IMPLICIT_LINK_DIRECTORIES` diff --git a/Help/envvar/CMAKE_LANG_LINKER_LAUNCHER.rst b/Help/envvar/CMAKE_LANG_LINKER_LAUNCHER.rst index 6251d9c..206caec 100644 --- a/Help/envvar/CMAKE_LANG_LINKER_LAUNCHER.rst +++ b/Help/envvar/CMAKE_LANG_LINKER_LAUNCHER.rst @@ -3,7 +3,7 @@ CMAKE__LINKER_LAUNCHER .. versionadded:: 3.21 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Default launcher to use when linking a target of the specified language. Will only be used by CMake to initialize the variable on the first configuration. diff --git a/Help/envvar/CMAKE_LIBRARY_PATH.rst b/Help/envvar/CMAKE_LIBRARY_PATH.rst index a51100d..0b5a997 100644 --- a/Help/envvar/CMAKE_LIBRARY_PATH.rst +++ b/Help/envvar/CMAKE_LIBRARY_PATH.rst @@ -1,7 +1,7 @@ CMAKE_LIBRARY_PATH ------------------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_LIBRARY_PATH`` environment variable may be set to a list of directories to be searched by the :command:`find_library` command. diff --git a/Help/envvar/CMAKE_MAXIMUM_RECURSION_DEPTH.rst b/Help/envvar/CMAKE_MAXIMUM_RECURSION_DEPTH.rst index 2d65b60..4a6cced 100644 --- a/Help/envvar/CMAKE_MAXIMUM_RECURSION_DEPTH.rst +++ b/Help/envvar/CMAKE_MAXIMUM_RECURSION_DEPTH.rst @@ -3,7 +3,7 @@ CMAKE_MAXIMUM_RECURSION_DEPTH .. versionadded:: 3.27 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Maximum recursion depth for CMake scripts. This environment variable is used if the :variable:`CMAKE_MAXIMUM_RECURSION_DEPTH` variable is not set. diff --git a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst index bb04b30..3efb05f 100644 --- a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst +++ b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst @@ -1,7 +1,7 @@ CMAKE_MSVCIDE_RUN_PATH ---------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Extra PATH locations for custom commands when using :ref:`Visual Studio Generators`. diff --git a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst index ef7d547..141e594 100644 --- a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst +++ b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst @@ -1,7 +1,7 @@ CMAKE_OSX_ARCHITECTURES ----------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Target specific architectures for macOS. diff --git a/Help/envvar/CMAKE_POLICY_VERSION_MINIMUM.rst b/Help/envvar/CMAKE_POLICY_VERSION_MINIMUM.rst index 0521f5c..dd881a6 100644 --- a/Help/envvar/CMAKE_POLICY_VERSION_MINIMUM.rst +++ b/Help/envvar/CMAKE_POLICY_VERSION_MINIMUM.rst @@ -3,7 +3,7 @@ CMAKE_POLICY_VERSION_MINIMUM .. versionadded:: 4.0 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default value for :variable:`CMAKE_POLICY_VERSION_MINIMUM` when there is no explicit configuration given on the first run while creating a new diff --git a/Help/envvar/CMAKE_PREFIX_PATH.rst b/Help/envvar/CMAKE_PREFIX_PATH.rst index 276fdd6..f096cca 100644 --- a/Help/envvar/CMAKE_PREFIX_PATH.rst +++ b/Help/envvar/CMAKE_PREFIX_PATH.rst @@ -1,7 +1,7 @@ CMAKE_PREFIX_PATH ----------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of directories specifying installation *prefixes* to be searched by the diff --git a/Help/envvar/CMAKE_PROGRAM_PATH.rst b/Help/envvar/CMAKE_PROGRAM_PATH.rst index bfc7a30..6d86548 100644 --- a/Help/envvar/CMAKE_PROGRAM_PATH.rst +++ b/Help/envvar/CMAKE_PROGRAM_PATH.rst @@ -1,7 +1,7 @@ CMAKE_PROGRAM_PATH ------------------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_PROGRAM_PATH`` environment variable may be set to a list of directories to be searched by the :command:`find_program` command. diff --git a/Help/envvar/CMAKE_TEST_LAUNCHER.rst b/Help/envvar/CMAKE_TEST_LAUNCHER.rst index d620ce5..40a93e2 100644 --- a/Help/envvar/CMAKE_TEST_LAUNCHER.rst +++ b/Help/envvar/CMAKE_TEST_LAUNCHER.rst @@ -3,7 +3,7 @@ CMAKE_TEST_LAUNCHER .. versionadded:: 3.29 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The default value for the :variable:`CMAKE_TEST_LAUNCHER` variable when there is no explicit configuration given on the first run while creating a new diff --git a/Help/envvar/CMAKE_TLS_VERIFY.rst b/Help/envvar/CMAKE_TLS_VERIFY.rst index 9571cb8..84471a4 100644 --- a/Help/envvar/CMAKE_TLS_VERIFY.rst +++ b/Help/envvar/CMAKE_TLS_VERIFY.rst @@ -3,7 +3,7 @@ CMAKE_TLS_VERIFY .. versionadded:: 3.30 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify the default value for the :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands' ``TLS_VERIFY`` option. diff --git a/Help/envvar/CMAKE_TLS_VERSION.rst b/Help/envvar/CMAKE_TLS_VERSION.rst index c411861..a9589f3 100644 --- a/Help/envvar/CMAKE_TLS_VERSION.rst +++ b/Help/envvar/CMAKE_TLS_VERSION.rst @@ -3,7 +3,7 @@ CMAKE_TLS_VERSION .. versionadded:: 3.30 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify the default value for the :command:`file(DOWNLOAD)` and :command:`file(UPLOAD)` commands' ``TLS_VERSION`` option. diff --git a/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst b/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst index 7ea9cea..1b1c57c 100644 --- a/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst +++ b/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst @@ -3,7 +3,7 @@ CMAKE_TOOLCHAIN_FILE .. versionadded:: 3.21 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst The ``CMAKE_TOOLCHAIN_FILE`` environment variable specifies a default value for the :variable:`CMAKE_TOOLCHAIN_FILE` variable when there is no explicit diff --git a/Help/envvar/CSFLAGS.rst b/Help/envvar/CSFLAGS.rst index 6e909fe..1a7c4c9 100644 --- a/Help/envvar/CSFLAGS.rst +++ b/Help/envvar/CSFLAGS.rst @@ -3,12 +3,12 @@ CSFLAGS .. versionadded:: 3.9.2 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``CSharp`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CSharp_FLAGS _FLAGS>` .. |LANG| replace:: ``CSharp`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_CSharp_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst index e1991b2..6d893f9 100644 --- a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst +++ b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst @@ -1,7 +1,7 @@ CTEST_INTERACTIVE_DEBUG_MODE ---------------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Environment variable that will exist and be set to ``1`` when a test executed by :manual:`ctest(1)` is run in interactive mode. diff --git a/Help/envvar/CTEST_NO_TESTS_ACTION.rst b/Help/envvar/CTEST_NO_TESTS_ACTION.rst index 2bc86dc..c5f74a7 100644 --- a/Help/envvar/CTEST_NO_TESTS_ACTION.rst +++ b/Help/envvar/CTEST_NO_TESTS_ACTION.rst @@ -3,7 +3,7 @@ CTEST_NO_TESTS_ACTION .. versionadded:: 3.26 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Environment variable that controls how :manual:`ctest ` handles cases when there are no tests to run. Possible values are: ``error``, diff --git a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst index d8b4262..7ec642c 100644 --- a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst +++ b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst @@ -1,7 +1,7 @@ CTEST_OUTPUT_ON_FAILURE ----------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Boolean environment variable that controls if the output should be logged for failed tests. Set the value to ``1``, ``True``, or ``ON`` to enable output on failure. diff --git a/Help/envvar/CTEST_PARALLEL_LEVEL.rst b/Help/envvar/CTEST_PARALLEL_LEVEL.rst index 0ef01d5..798c79b 100644 --- a/Help/envvar/CTEST_PARALLEL_LEVEL.rst +++ b/Help/envvar/CTEST_PARALLEL_LEVEL.rst @@ -1,7 +1,7 @@ CTEST_PARALLEL_LEVEL -------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify the number of tests for CTest to run in parallel. For example, if ``CTEST_PARALLEL_LEVEL`` is set to 8, CTest will run diff --git a/Help/envvar/CTEST_PROGRESS_OUTPUT.rst b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst index 348acc6..2e87acb 100644 --- a/Help/envvar/CTEST_PROGRESS_OUTPUT.rst +++ b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst @@ -3,7 +3,7 @@ CTEST_PROGRESS_OUTPUT .. versionadded:: 3.13 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Boolean environment variable that affects how :manual:`ctest ` command output reports overall progress. When set to ``1``, ``TRUE``, ``ON`` or anything diff --git a/Help/envvar/CTEST_USE_INSTRUMENTATION.rst b/Help/envvar/CTEST_USE_INSTRUMENTATION.rst index c6c7f70..6e33845 100644 --- a/Help/envvar/CTEST_USE_INSTRUMENTATION.rst +++ b/Help/envvar/CTEST_USE_INSTRUMENTATION.rst @@ -3,7 +3,7 @@ CTEST_USE_INSTRUMENTATION .. versionadded:: 4.0 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst .. note:: diff --git a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst index 79dbb79..c58128e 100644 --- a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst +++ b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst @@ -1,6 +1,6 @@ CTEST_USE_LAUNCHERS_DEFAULT --------------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined. diff --git a/Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst b/Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst index d7f7477..95053e4 100644 --- a/Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst +++ b/Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst @@ -3,7 +3,7 @@ CTEST_USE_VERBOSE_INSTRUMENTATION .. versionadded:: 4.0 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst .. note:: diff --git a/Help/envvar/CUDAARCHS.rst b/Help/envvar/CUDAARCHS.rst index e9e6a42..e68d19f 100644 --- a/Help/envvar/CUDAARCHS.rst +++ b/Help/envvar/CUDAARCHS.rst @@ -3,7 +3,7 @@ CUDAARCHS .. versionadded:: 3.20 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Value used to initialize :variable:`CMAKE_CUDA_ARCHITECTURES` on the first configuration. Subsequent runs will use the value stored in the cache. diff --git a/Help/envvar/CUDACXX.rst b/Help/envvar/CUDACXX.rst index 1722128..08c1414 100644 --- a/Help/envvar/CUDACXX.rst +++ b/Help/envvar/CUDACXX.rst @@ -3,7 +3,7 @@ CUDACXX .. versionadded:: 3.8 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``CUDA`` language files. Will only be used by CMake on the first configuration to determine ``CUDA`` compiler, after which the diff --git a/Help/envvar/CUDAFLAGS.rst b/Help/envvar/CUDAFLAGS.rst index 46a91df..66b84f3 100644 --- a/Help/envvar/CUDAFLAGS.rst +++ b/Help/envvar/CUDAFLAGS.rst @@ -3,12 +3,12 @@ CUDAFLAGS .. versionadded:: 3.8 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``CUDA`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CUDA_FLAGS _FLAGS>` .. |LANG| replace:: ``CUDA`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_CUDA_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/CUDAHOSTCXX.rst b/Help/envvar/CUDAHOSTCXX.rst index 4e78afa..1836301 100644 --- a/Help/envvar/CUDAHOSTCXX.rst +++ b/Help/envvar/CUDAHOSTCXX.rst @@ -3,7 +3,7 @@ CUDAHOSTCXX .. versionadded:: 3.8 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling host code when compiling ``CUDA`` language files. Will only be used by CMake on the first configuration to diff --git a/Help/envvar/CXX.rst b/Help/envvar/CXX.rst index 61ba5b8..5b7b4ab 100644 --- a/Help/envvar/CXX.rst +++ b/Help/envvar/CXX.rst @@ -1,7 +1,7 @@ CXX --- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``CXX`` language files. Will only be used by CMake on the first configuration to determine ``CXX`` compiler, after which the diff --git a/Help/envvar/CXXFLAGS.rst b/Help/envvar/CXXFLAGS.rst index f67431f..25b2613 100644 --- a/Help/envvar/CXXFLAGS.rst +++ b/Help/envvar/CXXFLAGS.rst @@ -1,12 +1,12 @@ CXXFLAGS -------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``CXX`` (C++) files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_CXX_FLAGS _FLAGS>` .. |LANG| replace:: ``CXX`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_CXX_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst index 6a52d64..e25a31d 100644 --- a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst +++ b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst @@ -1,7 +1,7 @@ DASHBOARD_TEST_FROM_CTEST ------------------------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Environment variable that will exist when a test executed by :manual:`ctest(1)` is run in non-interactive mode. The value will be equal to diff --git a/Help/envvar/DESTDIR.rst b/Help/envvar/DESTDIR.rst index dec8430..dd18535 100644 --- a/Help/envvar/DESTDIR.rst +++ b/Help/envvar/DESTDIR.rst @@ -1,7 +1,7 @@ DESTDIR ------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the whole installation. ``DESTDIR`` means DESTination DIRectory. It is diff --git a/Help/envvar/ENV_VAR.txt b/Help/envvar/ENV_VAR.txt deleted file mode 100644 index e1e70cd..0000000 --- a/Help/envvar/ENV_VAR.txt +++ /dev/null @@ -1,3 +0,0 @@ -This is a CMake :ref:`Environment Variable `. Its initial value is taken from -the calling process environment. diff --git a/Help/envvar/FC.rst b/Help/envvar/FC.rst index 70e1475..17c7fee 100644 --- a/Help/envvar/FC.rst +++ b/Help/envvar/FC.rst @@ -1,7 +1,7 @@ FC -- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``Fortran`` language files. Will only be used by CMake on the first configuration to determine ``Fortran`` compiler, after diff --git a/Help/envvar/FFLAGS.rst b/Help/envvar/FFLAGS.rst index 23bc8d2..8b452e1 100644 --- a/Help/envvar/FFLAGS.rst +++ b/Help/envvar/FFLAGS.rst @@ -1,12 +1,12 @@ FFLAGS ------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``Fortran`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_Fortran_FLAGS _FLAGS>` .. |LANG| replace:: ``Fortran`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_Fortran_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/HIPCXX.rst b/Help/envvar/HIPCXX.rst index 23329e9..ebffb56 100644 --- a/Help/envvar/HIPCXX.rst +++ b/Help/envvar/HIPCXX.rst @@ -3,7 +3,7 @@ HIPCXX .. versionadded:: 3.21 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``HIP`` language files. Will only be used by CMake on the first configuration to determine ``HIP`` compiler, after which the diff --git a/Help/envvar/HIPFLAGS.rst b/Help/envvar/HIPFLAGS.rst index 31e2390..866c87e 100644 --- a/Help/envvar/HIPFLAGS.rst +++ b/Help/envvar/HIPFLAGS.rst @@ -3,12 +3,12 @@ HIPFLAGS .. versionadded:: 3.21 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``HIP`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_HIP_FLAGS _FLAGS>` .. |LANG| replace:: ``HIP`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_HIP_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/HIPHOSTCXX.rst b/Help/envvar/HIPHOSTCXX.rst index 871fbfb..b12def6 100644 --- a/Help/envvar/HIPHOSTCXX.rst +++ b/Help/envvar/HIPHOSTCXX.rst @@ -3,7 +3,7 @@ HIPHOSTCXX .. versionadded:: 3.28 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling host code when compiling ``HIP`` language files with the NVIDIA CUDA Compiler. Will only be used by CMake diff --git a/Help/envvar/ISPC.rst b/Help/envvar/ISPC.rst index bcd6260..4a9d700 100644 --- a/Help/envvar/ISPC.rst +++ b/Help/envvar/ISPC.rst @@ -3,7 +3,7 @@ ISPC .. versionadded:: 3.19 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``ISPC`` language files. Will only be used by CMake on the first configuration to determine ``ISPC`` compiler, after which the diff --git a/Help/envvar/ISPCFLAGS.rst b/Help/envvar/ISPCFLAGS.rst index b7a2bd5..4a45d7c 100644 --- a/Help/envvar/ISPCFLAGS.rst +++ b/Help/envvar/ISPCFLAGS.rst @@ -3,12 +3,12 @@ ISPCFLAGS .. versionadded:: 3.19 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``ISPC`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_ISPC_FLAGS _FLAGS>` .. |LANG| replace:: ``ISPC`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_ISPC_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/LANG_FLAGS.txt b/Help/envvar/LANG_FLAGS.txt deleted file mode 100644 index d01a56d..0000000 --- a/Help/envvar/LANG_FLAGS.txt +++ /dev/null @@ -1,6 +0,0 @@ -CMake uses this environment variable value, in combination with its own -builtin default flags for the toolchain, to initialize and store the -|CMAKE_LANG_FLAGS| cache entry. -This occurs the first time a build tree is configured for language |LANG|. -For any configuration run (including the first), the environment variable -will be ignored if the |CMAKE_LANG_FLAGS| variable is already defined. diff --git a/Help/envvar/LDFLAGS.rst b/Help/envvar/LDFLAGS.rst index 816d6ef..03a70f5 100644 --- a/Help/envvar/LDFLAGS.rst +++ b/Help/envvar/LDFLAGS.rst @@ -1,7 +1,7 @@ LDFLAGS ------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Will only be used by CMake on the first configuration to determine the default linker flags, after which the value for ``LDFLAGS`` is stored in the cache diff --git a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst index 662bd03..53c6950 100644 --- a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst +++ b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst @@ -1,7 +1,7 @@ MACOSX_DEPLOYMENT_TARGET ------------------------ -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify the minimum version of macOS on which the target binaries are to be deployed. diff --git a/Help/envvar/OBJC.rst b/Help/envvar/OBJC.rst index 2d95806..6317bdb 100644 --- a/Help/envvar/OBJC.rst +++ b/Help/envvar/OBJC.rst @@ -3,7 +3,7 @@ OBJC .. versionadded:: 3.16.7 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``OBJC`` language files. Will only be used by CMake on the first configuration to determine ``OBJC`` compiler, after diff --git a/Help/envvar/OBJCFLAGS.rst b/Help/envvar/OBJCFLAGS.rst index 2f30807..5d40b02 100644 --- a/Help/envvar/OBJCFLAGS.rst +++ b/Help/envvar/OBJCFLAGS.rst @@ -3,12 +3,12 @@ OBJCFLAGS .. versionadded:: 3.16 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``Objective C`` files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_OBJC_FLAGS _FLAGS>` .. |LANG| replace:: ``OBJC`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_OBJC_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/OBJCXX.rst b/Help/envvar/OBJCXX.rst index 71286d9..1e04e3b 100644 --- a/Help/envvar/OBJCXX.rst +++ b/Help/envvar/OBJCXX.rst @@ -3,7 +3,7 @@ OBJCXX .. versionadded:: 3.16.7 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``OBJCXX`` language files. Will only be used by CMake on the first configuration to determine ``OBJCXX`` compiler, after diff --git a/Help/envvar/OBJCXXFLAGS.rst b/Help/envvar/OBJCXXFLAGS.rst index 089222a..38c751d 100644 --- a/Help/envvar/OBJCXXFLAGS.rst +++ b/Help/envvar/OBJCXXFLAGS.rst @@ -3,12 +3,12 @@ OBJCXXFLAGS .. versionadded:: 3.16 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``Objective C++`` (.mm) files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_OBJCXX_FLAGS _FLAGS>` .. |LANG| replace:: ``OBJCXX`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_OBJCXX_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/PackageName_ROOT.rst b/Help/envvar/PackageName_ROOT.rst index 6e9c744..f622916 100644 --- a/Help/envvar/PackageName_ROOT.rst +++ b/Help/envvar/PackageName_ROOT.rst @@ -3,7 +3,7 @@ .. versionadded:: 3.12 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Calls to :command:`find_package()` will search in prefixes specified by the ``_ROOT`` environment variable, where diff --git a/Help/envvar/RC.rst b/Help/envvar/RC.rst index 8a9324d..5d5c4aa 100644 --- a/Help/envvar/RC.rst +++ b/Help/envvar/RC.rst @@ -1,7 +1,7 @@ RC -- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``resource`` files. Will only be used by CMake on the first configuration to determine ``resource`` compiler, after which the diff --git a/Help/envvar/RCFLAGS.rst b/Help/envvar/RCFLAGS.rst index 7df83a7..dd6d623 100644 --- a/Help/envvar/RCFLAGS.rst +++ b/Help/envvar/RCFLAGS.rst @@ -1,12 +1,12 @@ RCFLAGS ------- -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Add default compilation flags to be used when compiling ``RC`` (resource) files. .. |CMAKE_LANG_FLAGS| replace:: :variable:`CMAKE_RC_FLAGS _FLAGS>` .. |LANG| replace:: ``RC`` -.. include:: LANG_FLAGS.txt +.. include:: include/LANG_FLAGS.rst See also :variable:`CMAKE_RC_FLAGS_INIT _FLAGS_INIT>`. diff --git a/Help/envvar/SSL_CERT_DIR.rst b/Help/envvar/SSL_CERT_DIR.rst index 1e678e4..93b4087 100644 --- a/Help/envvar/SSL_CERT_DIR.rst +++ b/Help/envvar/SSL_CERT_DIR.rst @@ -3,7 +3,7 @@ SSL_CERT_DIR .. versionadded:: 3.25 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify default directory containing CA certificates. It overrides the default CA directory used. diff --git a/Help/envvar/SSL_CERT_FILE.rst b/Help/envvar/SSL_CERT_FILE.rst index 23216c0..5fabc4f 100644 --- a/Help/envvar/SSL_CERT_FILE.rst +++ b/Help/envvar/SSL_CERT_FILE.rst @@ -3,7 +3,7 @@ SSL_CERT_FILE .. versionadded:: 3.25 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Specify the file name containing CA certificates. It overrides the default, os-specific CA file used. diff --git a/Help/envvar/SWIFTC.rst b/Help/envvar/SWIFTC.rst index 896e156..4d237a3 100644 --- a/Help/envvar/SWIFTC.rst +++ b/Help/envvar/SWIFTC.rst @@ -3,7 +3,7 @@ SWIFTC .. versionadded:: 3.15 -.. include:: ENV_VAR.txt +.. include:: include/ENV_VAR.rst Preferred executable for compiling ``Swift`` language files. Will only be used by CMake on the first configuration to determine ``Swift`` compiler, after which the diff --git a/Help/envvar/include/ENV_VAR.rst b/Help/envvar/include/ENV_VAR.rst new file mode 100644 index 0000000..e1e70cd --- /dev/null +++ b/Help/envvar/include/ENV_VAR.rst @@ -0,0 +1,3 @@ +This is a CMake :ref:`Environment Variable `. Its initial value is taken from +the calling process environment. diff --git a/Help/envvar/include/LANG_FLAGS.rst b/Help/envvar/include/LANG_FLAGS.rst new file mode 100644 index 0000000..d01a56d --- /dev/null +++ b/Help/envvar/include/LANG_FLAGS.rst @@ -0,0 +1,6 @@ +CMake uses this environment variable value, in combination with its own +builtin default flags for the toolchain, to initialize and store the +|CMAKE_LANG_FLAGS| cache entry. +This occurs the first time a build tree is configured for language |LANG|. +For any configuration run (including the first), the environment variable +will be ignored if the |CMAKE_LANG_FLAGS| variable is already defined. diff --git a/Help/generator/VS_TOOLSET_HOST_ARCH.txt b/Help/generator/VS_TOOLSET_HOST_ARCH.txt deleted file mode 100644 index 0293631..0000000 --- a/Help/generator/VS_TOOLSET_HOST_ARCH.txt +++ /dev/null @@ -1,7 +0,0 @@ -For each toolset that comes with this version of Visual Studio, there are -variants that are themselves compiled for 32-bit (``x86``) and -64-bit (``x64``) hosts (independent of the architecture they target). -|VS_TOOLSET_HOST_ARCH_DEFAULT| -One may explicitly request use of either the 32-bit or 64-bit host tools -by adding either ``host=x86`` or ``host=x64`` to the toolset specification. -See the :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. diff --git a/Help/generator/VS_TOOLSET_HOST_ARCH_LEGACY.txt b/Help/generator/VS_TOOLSET_HOST_ARCH_LEGACY.txt deleted file mode 100644 index 069638b..0000000 --- a/Help/generator/VS_TOOLSET_HOST_ARCH_LEGACY.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. versionadded:: 3.8 - For each toolset that comes with this version of Visual Studio, there are - variants that are themselves compiled for 32-bit (``x86``) and - 64-bit (``x64``) hosts (independent of the architecture they target). - |VS_TOOLSET_HOST_ARCH_DEFAULT| - One may explicitly request use of either the 32-bit or 64-bit host tools - by adding either ``host=x86`` or ``host=x64`` to the toolset specification. - See the :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. - -.. versionadded:: 3.14 - Added support for ``host=x86`` option. diff --git a/Help/generator/Visual Studio 14 2015.rst b/Help/generator/Visual Studio 14 2015.rst index 6629b68..a491193 100644 --- a/Help/generator/Visual Studio 14 2015.rst +++ b/Help/generator/Visual Studio 14 2015.rst @@ -48,7 +48,7 @@ via the :option:`cmake -T` option, to specify another toolset. .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: By default this generator uses the 32-bit variant even on a 64-bit host. -.. include:: VS_TOOLSET_HOST_ARCH_LEGACY.txt +.. include:: include/VS_TOOLSET_HOST_ARCH_LEGACY.rst .. _`Windows 10 SDK Maximum Version for VS 2015`: diff --git a/Help/generator/Visual Studio 15 2017.rst b/Help/generator/Visual Studio 15 2017.rst index 3f29072..709b61f 100644 --- a/Help/generator/Visual Studio 15 2017.rst +++ b/Help/generator/Visual Studio 15 2017.rst @@ -57,4 +57,4 @@ via the :option:`cmake -T` option, to specify another toolset. .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: By default this generator uses the 32-bit variant even on a 64-bit host. -.. include:: VS_TOOLSET_HOST_ARCH_LEGACY.txt +.. include:: include/VS_TOOLSET_HOST_ARCH_LEGACY.rst diff --git a/Help/generator/Visual Studio 16 2019.rst b/Help/generator/Visual Studio 16 2019.rst index 2918a6e..4435487 100644 --- a/Help/generator/Visual Studio 16 2019.rst +++ b/Help/generator/Visual Studio 16 2019.rst @@ -44,4 +44,4 @@ via the :option:`cmake -T` option, to specify another toolset. By default this generator uses the 64-bit variant on x64 hosts and the 32-bit variant otherwise. -.. include:: VS_TOOLSET_HOST_ARCH.txt +.. include:: include/VS_TOOLSET_HOST_ARCH.rst diff --git a/Help/generator/Visual Studio 17 2022.rst b/Help/generator/Visual Studio 17 2022.rst index ab101ac..7157dcf 100644 --- a/Help/generator/Visual Studio 17 2022.rst +++ b/Help/generator/Visual Studio 17 2022.rst @@ -44,4 +44,4 @@ via the :option:`cmake -T` option, to specify another toolset. By default this generator uses the 64-bit variant on x64 hosts and the 32-bit variant otherwise. -.. include:: VS_TOOLSET_HOST_ARCH.txt +.. include:: include/VS_TOOLSET_HOST_ARCH.rst diff --git a/Help/generator/include/VS_TOOLSET_HOST_ARCH.rst b/Help/generator/include/VS_TOOLSET_HOST_ARCH.rst new file mode 100644 index 0000000..0293631 --- /dev/null +++ b/Help/generator/include/VS_TOOLSET_HOST_ARCH.rst @@ -0,0 +1,7 @@ +For each toolset that comes with this version of Visual Studio, there are +variants that are themselves compiled for 32-bit (``x86``) and +64-bit (``x64``) hosts (independent of the architecture they target). +|VS_TOOLSET_HOST_ARCH_DEFAULT| +One may explicitly request use of either the 32-bit or 64-bit host tools +by adding either ``host=x86`` or ``host=x64`` to the toolset specification. +See the :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. diff --git a/Help/generator/include/VS_TOOLSET_HOST_ARCH_LEGACY.rst b/Help/generator/include/VS_TOOLSET_HOST_ARCH_LEGACY.rst new file mode 100644 index 0000000..069638b --- /dev/null +++ b/Help/generator/include/VS_TOOLSET_HOST_ARCH_LEGACY.rst @@ -0,0 +1,11 @@ +.. versionadded:: 3.8 + For each toolset that comes with this version of Visual Studio, there are + variants that are themselves compiled for 32-bit (``x86``) and + 64-bit (``x64``) hosts (independent of the architecture they target). + |VS_TOOLSET_HOST_ARCH_DEFAULT| + One may explicitly request use of either the 32-bit or 64-bit host tools + by adding either ``host=x86`` or ``host=x64`` to the toolset specification. + See the :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. + +.. versionadded:: 3.14 + Added support for ``host=x86`` option. diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst index 1ab0009..adedbcd 100644 --- a/Help/guide/tutorial/index.rst +++ b/Help/guide/tutorial/index.rst @@ -11,9 +11,8 @@ work together in an example project can be very helpful. Steps ===== -.. include:: source.txt - -|tutorial_source| +The tutorial documentation and source code examples can be found in +the ``Help/guide/tutorial`` directory of the CMake source code tree. Each step has its own subdirectory containing code that may be used as a starting point. The tutorial examples are progressive so that each step provides the complete solution for the previous step. diff --git a/Help/guide/tutorial/source.txt b/Help/guide/tutorial/source.txt deleted file mode 100644 index bb45e86..0000000 --- a/Help/guide/tutorial/source.txt +++ /dev/null @@ -1,3 +0,0 @@ -.. |tutorial_source| replace:: - The tutorial documentation and source code examples can be found in - the ``Help/guide/tutorial`` directory of the CMake source code tree. diff --git a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.rst b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.rst new file mode 100644 index 0000000..f0ebc8d --- /dev/null +++ b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.rst @@ -0,0 +1,20 @@ +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include: + + ============= ======================== + ``#`` Broken almost everywhere. + ``;`` Broken in VS IDE 7.0 and Borland Makefiles. + ``,`` Broken in VS IDE. + ``%`` Broken in some cases in NMake. + ``& |`` Broken in some cases on MinGW. + ``^ < > \ "`` Broken in most Make tools on Windows. + ============= ======================== + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt deleted file mode 100644 index f0ebc8d..0000000 --- a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt +++ /dev/null @@ -1,20 +0,0 @@ -Disclaimer: Most native build tools have poor support for escaping -certain values. CMake has work-arounds for many cases but some values -may just not be possible to pass correctly. If a value does not seem -to be escaped correctly, do not attempt to work-around the problem by -adding escape sequences to the value. Your work-around may break in a -future version of CMake that has improved escape support. Instead -consider defining the macro in a (configured) header file. Then -report the limitation. Known limitations include: - - ============= ======================== - ``#`` Broken almost everywhere. - ``;`` Broken in VS IDE 7.0 and Borland Makefiles. - ``,`` Broken in VS IDE. - ``%`` Broken in some cases in NMake. - ``& |`` Broken in some cases on MinGW. - ``^ < > \ "`` Broken in most Make tools on Windows. - ============= ======================== - -CMake does not reject these values outright because they do work in -some cases. Use with caution. diff --git a/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst b/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst new file mode 100644 index 0000000..73e1907 --- /dev/null +++ b/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst @@ -0,0 +1,18 @@ + +Note that it is not advisable to populate the :genex:`INSTALL_INTERFACE` of +the |INTERFACE_PROPERTY_LINK| of a target with absolute paths to the include +directories of dependencies. That would hard-code into installed packages +the include directory paths for dependencies +**as found on the machine the package was made on**. + +The :genex:`INSTALL_INTERFACE` of the |INTERFACE_PROPERTY_LINK| is only +suitable for specifying the required include directories for headers +provided with the target itself, not those provided by the transitive +dependencies listed in its :prop_tgt:`INTERFACE_LINK_LIBRARIES` target +property. Those dependencies should themselves be targets that specify +their own header locations in |INTERFACE_PROPERTY_LINK|. + +See the :ref:`Creating Relocatable Packages` section of the +:manual:`cmake-packages(7)` manual for discussion of additional care +that must be taken when specifying usage requirements while creating +packages for redistribution. diff --git a/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt b/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt deleted file mode 100644 index 73e1907..0000000 --- a/Help/include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt +++ /dev/null @@ -1,18 +0,0 @@ - -Note that it is not advisable to populate the :genex:`INSTALL_INTERFACE` of -the |INTERFACE_PROPERTY_LINK| of a target with absolute paths to the include -directories of dependencies. That would hard-code into installed packages -the include directory paths for dependencies -**as found on the machine the package was made on**. - -The :genex:`INSTALL_INTERFACE` of the |INTERFACE_PROPERTY_LINK| is only -suitable for specifying the required include directories for headers -provided with the target itself, not those provided by the transitive -dependencies listed in its :prop_tgt:`INTERFACE_LINK_LIBRARIES` target -property. Those dependencies should themselves be targets that specify -their own header locations in |INTERFACE_PROPERTY_LINK|. - -See the :ref:`Creating Relocatable Packages` section of the -:manual:`cmake-packages(7)` manual for discussion of additional care -that must be taken when specifying usage requirements while creating -packages for redistribution. diff --git a/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.rst b/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.rst new file mode 100644 index 0000000..46e84ac --- /dev/null +++ b/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.rst @@ -0,0 +1,10 @@ + +Note that it is not advisable to populate the +|INTERFACE_PROPERTY_LINK| of a target with absolute paths to dependencies. +That would hard-code into installed packages the library file paths +for dependencies **as found on the machine the package was made on**. + +See the :ref:`Creating Relocatable Packages` section of the +:manual:`cmake-packages(7)` manual for discussion of additional care +that must be taken when specifying usage requirements while creating +packages for redistribution. diff --git a/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.txt b/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.txt deleted file mode 100644 index 46e84ac..0000000 --- a/Help/include/INTERFACE_LINK_LIBRARIES_WARNING.txt +++ /dev/null @@ -1,10 +0,0 @@ - -Note that it is not advisable to populate the -|INTERFACE_PROPERTY_LINK| of a target with absolute paths to dependencies. -That would hard-code into installed packages the library file paths -for dependencies **as found on the machine the package was made on**. - -See the :ref:`Creating Relocatable Packages` section of the -:manual:`cmake-packages(7)` manual for discussion of additional care -that must be taken when specifying usage requirements while creating -packages for redistribution. diff --git a/Help/manual/ID_RESERVE.txt b/Help/manual/ID_RESERVE.txt deleted file mode 100644 index be2b163..0000000 --- a/Help/manual/ID_RESERVE.txt +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - CMake reserves identifiers that: - - * begin with ``CMAKE_`` (upper-, lower-, or mixed-case), or - * begin with ``_CMAKE_`` (upper-, lower-, or mixed-case), or - * begin with ``_`` followed by the name of any :manual:`CMake Command `. diff --git a/Help/manual/LINKS.txt b/Help/manual/LINKS.txt deleted file mode 100644 index 810fa0b..0000000 --- a/Help/manual/LINKS.txt +++ /dev/null @@ -1,17 +0,0 @@ -The following resources are available to get help using CMake: - -Home Page - https://cmake.org - - The primary starting point for learning about CMake. - -Online Documentation and Community Resources - https://cmake.org/documentation - - Links to available documentation and community resources may be - found on this web page. - -Discourse Forum - https://discourse.cmake.org - - The Discourse Forum hosts discussion and questions about CMake. diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt deleted file mode 100644 index 4d8f88e..0000000 --- a/Help/manual/OPTIONS_BUILD.txt +++ /dev/null @@ -1,196 +0,0 @@ -.. option:: -S - - Path to root directory of the CMake project to build. - -.. option:: -B - - Path to directory which CMake will use as the root of build directory. - - If the directory doesn't already exist CMake will make it. - -.. option:: -C - - Pre-load a script to populate the cache. - - When CMake is first run in an empty build tree, it creates a - ``CMakeCache.txt`` file and populates it with customizable settings for - the project. This option may be used to specify a file from which - to load cache entries before the first pass through the project's - CMake listfiles. The loaded entries take priority over the - project's default values. The given file should be a CMake script - containing :command:`set` commands that use the ``CACHE`` option, not a - cache-format file. - - References to :variable:`CMAKE_SOURCE_DIR` and :variable:`CMAKE_BINARY_DIR` - within the script evaluate to the top-level source and build tree. - -.. option:: -D :=, -D = - - Create or update a CMake ``CACHE`` entry. - - When CMake is first run in an empty build tree, it creates a - ``CMakeCache.txt`` file and populates it with customizable settings for - the project. This option may be used to specify a setting that - takes priority over the project's default value. The option may be - repeated for as many ``CACHE`` entries as desired. - - If the ``:`` portion is given it must be one of the types - specified by the :command:`set` command documentation for its - ``CACHE`` signature. - If the ``:`` portion is omitted the entry will be created - with no type if it does not exist with a type already. If a - command in the project sets the type to ``PATH`` or ``FILEPATH`` - then the ```` will be converted to an absolute path. - - This option may also be given as a single argument: - ``-D:=`` or ``-D=``. - - It's important to note that the order of ``-C`` and ``-D`` arguments is - significant. They will be carried out in the order they are listed, with the - last argument taking precedence over the previous ones. For example, if you - specify ``-DCMAKE_BUILD_TYPE=Debug``, followed by a ``-C`` argument with a - file that calls: - - .. code-block:: cmake - - set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE) - - then the ``-C`` argument will take precedence, and ``CMAKE_BUILD_TYPE`` will - be set to ``Release``. However, if the ``-D`` argument comes after the ``-C`` - argument, it will be set to ``Debug``. - - If a ``set(... CACHE ...)`` call in the ``-C`` file does not use ``FORCE``, - and a ``-D`` argument sets the same variable, the ``-D`` argument will take - precedence regardless of order because of the nature of non-``FORCE`` - ``set(... CACHE ...)`` calls. - -.. option:: -U - - Remove matching entries from CMake ``CACHE``. - - This option may be used to remove one or more variables from the - ``CMakeCache.txt`` file, globbing expressions using ``*`` and ``?`` are - supported. The option may be repeated for as many ``CACHE`` entries as - desired. - - Use with care, you can make your ``CMakeCache.txt`` non-working. - -.. option:: -G - - Specify a build system generator. - - CMake may support multiple native build systems on certain - platforms. A generator is responsible for generating a particular - build system. Possible generator names are specified in the - :manual:`cmake-generators(7)` manual. - - If not specified, CMake checks the :envvar:`CMAKE_GENERATOR` environment - variable and otherwise falls back to a builtin default selection. - -.. option:: -T - - Toolset specification for the generator, if supported. - - Some CMake generators support a toolset specification to tell - the native build system how to choose a compiler. See the - :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. - -.. option:: -A - - Specify platform name if supported by generator. - - Some CMake generators support a platform name to be given to the - native build system to choose a compiler or SDK. See the - :variable:`CMAKE_GENERATOR_PLATFORM` variable for details. - -.. option:: --toolchain - - .. versionadded:: 3.21 - - Specify the cross compiling toolchain file, equivalent to setting - :variable:`CMAKE_TOOLCHAIN_FILE` variable. Relative paths are interpreted as - relative to the build directory, and if not found, relative to the source - directory. - -.. option:: --install-prefix - - .. versionadded:: 3.21 - - Specify the installation directory, used by the - :variable:`CMAKE_INSTALL_PREFIX` variable. Must be an absolute path. - -.. option:: --project-file - - .. versionadded:: 4.0 - - Specify an alternate project file name. - - This determines the top-level file processed by CMake when configuring a - project, and the file processed by :command:`add_subdirectory`. - - By default, this is ``CMakeLists.txt``. If set to anything else, - ``CMakeLists.txt`` will be used as a fallback whenever the specified file - cannot be found within a project subdirectory. - - .. note:: - - This feature is intended for temporary use by developers during an incremental - transition and not for publication of a final product. CMake will always emit - a warning when the project file is anything other than ``CMakeLists.txt``. - -.. option:: -Wno-dev - - Suppress developer warnings. - - Suppress warnings that are meant for the author of the - ``CMakeLists.txt`` files. By default this will also turn off - deprecation warnings. - -.. option:: -Wdev - - Enable developer warnings. - - Enable warnings that are meant for the author of the ``CMakeLists.txt`` - files. By default this will also turn on deprecation warnings. - -.. option:: -Wdeprecated - - Enable deprecated functionality warnings. - - Enable warnings for usage of deprecated functionality, that are meant - for the author of the ``CMakeLists.txt`` files. - -.. option:: -Wno-deprecated - - Suppress deprecated functionality warnings. - - Suppress warnings for usage of deprecated functionality, that are meant - for the author of the ``CMakeLists.txt`` files. - -.. option:: -Werror= - - Treat CMake warnings as errors. ```` must be one of the following: - - ``dev`` - Make developer warnings errors. - - Make warnings that are meant for the author of the ``CMakeLists.txt`` files - errors. By default this will also turn on deprecated warnings as errors. - - ``deprecated`` - Make deprecated macro and function warnings errors. - - Make warnings for usage of deprecated macros and functions, that are meant - for the author of the ``CMakeLists.txt`` files, errors. - -.. option:: -Wno-error= - - Do not treat CMake warnings as errors. ```` must be one of the following: - - ``dev`` - Make warnings that are meant for the author of the ``CMakeLists.txt`` files not - errors. By default this will also turn off deprecated warnings as errors. - - ``deprecated`` - Make warnings for usage of deprecated macros and functions, that are meant - for the author of the ``CMakeLists.txt`` files, not errors. diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt deleted file mode 100644 index f4f2dbe..0000000 --- a/Help/manual/OPTIONS_HELP.txt +++ /dev/null @@ -1,169 +0,0 @@ -.. |file| replace:: The output is printed to a named ```` if given. - -.. option:: -version [], --version [], /V [] - - Show program name/version banner and exit. - |file| - -.. option:: -h, -H, --help, -help, -usage, /? - - Print usage information and exit. - - Usage describes the basic command line interface and its options. - -.. option:: --help [] - - Print help for one CMake keyword. - - ```` can be a property, variable, command, policy, generator - or module. - - The relevant manual entry for ```` is - printed in a human-readable text format. - |file| - - .. versionchanged:: 3.28 - - Prior to CMake 3.28, this option supported command names only. - -.. option:: --help-full [] - - Print all help manuals and exit. - - All manuals are printed in a human-readable text format. - |file| - -.. option:: --help-manual [] - - Print one help manual and exit. - - The specified manual is printed in a human-readable text format. - |file| - -.. option:: --help-manual-list [] - - List help manuals available and exit. - - The list contains all manuals for which help may be obtained by - using the ``--help-manual`` option followed by a manual name. - |file| - -.. option:: --help-command [] - - Print help for one command and exit. - - The :manual:`cmake-commands(7)` manual entry for ```` is - printed in a human-readable text format. - |file| - -.. option:: --help-command-list [] - - List commands with help available and exit. - - The list contains all commands for which help may be obtained by - using the ``--help-command`` option followed by a command name. - |file| - -.. option:: --help-commands [] - - Print cmake-commands manual and exit. - - The :manual:`cmake-commands(7)` manual is printed in a - human-readable text format. - |file| - -.. option:: --help-module [] - - Print help for one module and exit. - - The :manual:`cmake-modules(7)` manual entry for ```` is printed - in a human-readable text format. - |file| - -.. option:: --help-module-list [] - - List modules with help available and exit. - - The list contains all modules for which help may be obtained by - using the ``--help-module`` option followed by a module name. - |file| - -.. option:: --help-modules [] - - Print cmake-modules manual and exit. - - The :manual:`cmake-modules(7)` manual is printed in a human-readable - text format. - |file| - -.. option:: --help-policy [] - - Print help for one policy and exit. - - The :manual:`cmake-policies(7)` manual entry for ```` is - printed in a human-readable text format. - |file| - -.. option:: --help-policy-list [] - - List policies with help available and exit. - - The list contains all policies for which help may be obtained by - using the ``--help-policy`` option followed by a policy name. - |file| - -.. option:: --help-policies [] - - Print cmake-policies manual and exit. - - The :manual:`cmake-policies(7)` manual is printed in a - human-readable text format. - |file| - -.. option:: --help-property [] - - Print help for one property and exit. - - The :manual:`cmake-properties(7)` manual entries for ```` are - printed in a human-readable text format. - |file| - -.. option:: --help-property-list [] - - List properties with help available and exit. - - The list contains all properties for which help may be obtained by - using the ``--help-property`` option followed by a property name. - |file| - -.. option:: --help-properties [] - - Print cmake-properties manual and exit. - - The :manual:`cmake-properties(7)` manual is printed in a - human-readable text format. - |file| - -.. option:: --help-variable [] - - Print help for one variable and exit. - - The :manual:`cmake-variables(7)` manual entry for ```` is - printed in a human-readable text format. - |file| - -.. option:: --help-variable-list [] - - List variables with help available and exit. - - The list contains all variables for which help may be obtained by - using the ``--help-variable`` option followed by a variable name. - |file| - -.. option:: --help-variables [] - - Print cmake-variables manual and exit. - - The :manual:`cmake-variables(7)` manual is printed in a - human-readable text format. - |file| diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index 5b118d1..b5192cf 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -30,11 +30,11 @@ Options .. program:: ccmake -.. include:: OPTIONS_BUILD.txt +.. include:: include/OPTIONS_BUILD.rst -.. include:: OPTIONS_HELP.txt +.. include:: include/OPTIONS_HELP.rst See Also ======== -.. include:: LINKS.txt +.. include:: include/LINKS.rst diff --git a/Help/manual/cmake-compile-features.7.rst b/Help/manual/cmake-compile-features.7.rst index fb93222..141f714 100644 --- a/Help/manual/cmake-compile-features.7.rst +++ b/Help/manual/cmake-compile-features.7.rst @@ -115,7 +115,7 @@ of at-least C++ 11 (or C++ 14, C++ 17, ...), adding flags such as ``-std=gnu++11`` if necessary. This applies to sources within ``mylib`` as well as any dependents (that may include headers from ``mylib``). -.. include:: ../prop_gbl/CMAKE_LANG_STD_FLAGS.txt +.. include:: ../prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst Availability of Compiler Extensions ----------------------------------- diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst index 2e622ff..68f0a8f 100644 --- a/Help/manual/cmake-generator-expressions.7.rst +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -1573,7 +1573,7 @@ Link Features underscores. Feature names defined in all uppercase are reserved for CMake's own built-in features. The pre-defined built-in library features are: - .. include:: ../variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt + .. include:: ../variable/include/LINK_LIBRARY_PREDEFINED_FEATURES.rst Built-in and custom library features are defined in terms of the following variables: @@ -1665,7 +1665,7 @@ Link Features own built-in features. Currently, there is only one pre-defined built-in group feature: - .. include:: ../variable/LINK_GROUP_PREDEFINED_FEATURES.txt + .. include:: ../variable/include/LINK_GROUP_PREDEFINED_FEATURES.rst Built-in and custom group features are defined in terms of the following variables: diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 26083ca..c270ab9 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -52,9 +52,9 @@ Options ```` is specified, open that file within the reference manual instead of ``index.html``. -.. include:: OPTIONS_HELP.txt +.. include:: include/OPTIONS_HELP.rst See Also ======== -.. include:: LINKS.txt +.. include:: include/LINKS.rst diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst index dba953d..d590b5a 100644 --- a/Help/manual/cmake-language.7.rst +++ b/Help/manual/cmake-language.7.rst @@ -572,7 +572,7 @@ The :manual:`cmake-variables(7)` manual documents the many variables that are provided by CMake or have meaning to CMake when set by project code. -.. include:: ID_RESERVE.txt +.. include:: include/ID_RESERVE.rst .. _`CMake Language Environment Variables`: diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 5db2d3a..7817b5d 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -14,7 +14,7 @@ For general information on variables, see the :ref:`Variables ` section in the cmake-language manual. -.. include:: ID_RESERVE.txt +.. include:: include/ID_RESERVE.rst Variables that Provide Information ================================== diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 313f060..4004e91 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -203,7 +203,7 @@ Options .. program:: cmake -.. include:: OPTIONS_BUILD.txt +.. include:: include/OPTIONS_BUILD.rst .. option:: --fresh @@ -1498,7 +1498,7 @@ To print selected pages from the CMake documentation, use with one of the following options: -.. include:: OPTIONS_HELP.txt +.. include:: include/OPTIONS_HELP.rst To view the presets available for a project, use @@ -1521,4 +1521,4 @@ or another error condition, then a non-zero exit code is returned. See Also ======== -.. include:: LINKS.txt +.. include:: include/LINKS.rst diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index 038cad2..167707a 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -127,9 +127,9 @@ Options List presets from :manual:`cmake-presets(7)`. -.. include:: OPTIONS_HELP.txt +.. include:: include/OPTIONS_HELP.rst See Also ======== -.. include:: LINKS.txt +.. include:: include/LINKS.rst diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 379e00d..035da3c 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -503,7 +503,7 @@ View Help To print version details or selected pages from the CMake documentation, use one of the following options: -.. include:: OPTIONS_HELP.txt +.. include:: include/OPTIONS_HELP.rst .. _`Label Matching`: @@ -1978,4 +1978,4 @@ On Windows systems, job server integration is not yet implemented. See Also ======== -.. include:: LINKS.txt +.. include:: include/LINKS.rst diff --git a/Help/manual/include/ID_RESERVE.rst b/Help/manual/include/ID_RESERVE.rst new file mode 100644 index 0000000..be2b163 --- /dev/null +++ b/Help/manual/include/ID_RESERVE.rst @@ -0,0 +1,7 @@ +.. note:: + + CMake reserves identifiers that: + + * begin with ``CMAKE_`` (upper-, lower-, or mixed-case), or + * begin with ``_CMAKE_`` (upper-, lower-, or mixed-case), or + * begin with ``_`` followed by the name of any :manual:`CMake Command `. diff --git a/Help/manual/include/LINKS.rst b/Help/manual/include/LINKS.rst new file mode 100644 index 0000000..810fa0b --- /dev/null +++ b/Help/manual/include/LINKS.rst @@ -0,0 +1,17 @@ +The following resources are available to get help using CMake: + +Home Page + https://cmake.org + + The primary starting point for learning about CMake. + +Online Documentation and Community Resources + https://cmake.org/documentation + + Links to available documentation and community resources may be + found on this web page. + +Discourse Forum + https://discourse.cmake.org + + The Discourse Forum hosts discussion and questions about CMake. diff --git a/Help/manual/include/OPTIONS_BUILD.rst b/Help/manual/include/OPTIONS_BUILD.rst new file mode 100644 index 0000000..4d8f88e --- /dev/null +++ b/Help/manual/include/OPTIONS_BUILD.rst @@ -0,0 +1,196 @@ +.. option:: -S + + Path to root directory of the CMake project to build. + +.. option:: -B + + Path to directory which CMake will use as the root of build directory. + + If the directory doesn't already exist CMake will make it. + +.. option:: -C + + Pre-load a script to populate the cache. + + When CMake is first run in an empty build tree, it creates a + ``CMakeCache.txt`` file and populates it with customizable settings for + the project. This option may be used to specify a file from which + to load cache entries before the first pass through the project's + CMake listfiles. The loaded entries take priority over the + project's default values. The given file should be a CMake script + containing :command:`set` commands that use the ``CACHE`` option, not a + cache-format file. + + References to :variable:`CMAKE_SOURCE_DIR` and :variable:`CMAKE_BINARY_DIR` + within the script evaluate to the top-level source and build tree. + +.. option:: -D :=, -D = + + Create or update a CMake ``CACHE`` entry. + + When CMake is first run in an empty build tree, it creates a + ``CMakeCache.txt`` file and populates it with customizable settings for + the project. This option may be used to specify a setting that + takes priority over the project's default value. The option may be + repeated for as many ``CACHE`` entries as desired. + + If the ``:`` portion is given it must be one of the types + specified by the :command:`set` command documentation for its + ``CACHE`` signature. + If the ``:`` portion is omitted the entry will be created + with no type if it does not exist with a type already. If a + command in the project sets the type to ``PATH`` or ``FILEPATH`` + then the ```` will be converted to an absolute path. + + This option may also be given as a single argument: + ``-D:=`` or ``-D=``. + + It's important to note that the order of ``-C`` and ``-D`` arguments is + significant. They will be carried out in the order they are listed, with the + last argument taking precedence over the previous ones. For example, if you + specify ``-DCMAKE_BUILD_TYPE=Debug``, followed by a ``-C`` argument with a + file that calls: + + .. code-block:: cmake + + set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE) + + then the ``-C`` argument will take precedence, and ``CMAKE_BUILD_TYPE`` will + be set to ``Release``. However, if the ``-D`` argument comes after the ``-C`` + argument, it will be set to ``Debug``. + + If a ``set(... CACHE ...)`` call in the ``-C`` file does not use ``FORCE``, + and a ``-D`` argument sets the same variable, the ``-D`` argument will take + precedence regardless of order because of the nature of non-``FORCE`` + ``set(... CACHE ...)`` calls. + +.. option:: -U + + Remove matching entries from CMake ``CACHE``. + + This option may be used to remove one or more variables from the + ``CMakeCache.txt`` file, globbing expressions using ``*`` and ``?`` are + supported. The option may be repeated for as many ``CACHE`` entries as + desired. + + Use with care, you can make your ``CMakeCache.txt`` non-working. + +.. option:: -G + + Specify a build system generator. + + CMake may support multiple native build systems on certain + platforms. A generator is responsible for generating a particular + build system. Possible generator names are specified in the + :manual:`cmake-generators(7)` manual. + + If not specified, CMake checks the :envvar:`CMAKE_GENERATOR` environment + variable and otherwise falls back to a builtin default selection. + +.. option:: -T + + Toolset specification for the generator, if supported. + + Some CMake generators support a toolset specification to tell + the native build system how to choose a compiler. See the + :variable:`CMAKE_GENERATOR_TOOLSET` variable for details. + +.. option:: -A + + Specify platform name if supported by generator. + + Some CMake generators support a platform name to be given to the + native build system to choose a compiler or SDK. See the + :variable:`CMAKE_GENERATOR_PLATFORM` variable for details. + +.. option:: --toolchain + + .. versionadded:: 3.21 + + Specify the cross compiling toolchain file, equivalent to setting + :variable:`CMAKE_TOOLCHAIN_FILE` variable. Relative paths are interpreted as + relative to the build directory, and if not found, relative to the source + directory. + +.. option:: --install-prefix + + .. versionadded:: 3.21 + + Specify the installation directory, used by the + :variable:`CMAKE_INSTALL_PREFIX` variable. Must be an absolute path. + +.. option:: --project-file + + .. versionadded:: 4.0 + + Specify an alternate project file name. + + This determines the top-level file processed by CMake when configuring a + project, and the file processed by :command:`add_subdirectory`. + + By default, this is ``CMakeLists.txt``. If set to anything else, + ``CMakeLists.txt`` will be used as a fallback whenever the specified file + cannot be found within a project subdirectory. + + .. note:: + + This feature is intended for temporary use by developers during an incremental + transition and not for publication of a final product. CMake will always emit + a warning when the project file is anything other than ``CMakeLists.txt``. + +.. option:: -Wno-dev + + Suppress developer warnings. + + Suppress warnings that are meant for the author of the + ``CMakeLists.txt`` files. By default this will also turn off + deprecation warnings. + +.. option:: -Wdev + + Enable developer warnings. + + Enable warnings that are meant for the author of the ``CMakeLists.txt`` + files. By default this will also turn on deprecation warnings. + +.. option:: -Wdeprecated + + Enable deprecated functionality warnings. + + Enable warnings for usage of deprecated functionality, that are meant + for the author of the ``CMakeLists.txt`` files. + +.. option:: -Wno-deprecated + + Suppress deprecated functionality warnings. + + Suppress warnings for usage of deprecated functionality, that are meant + for the author of the ``CMakeLists.txt`` files. + +.. option:: -Werror= + + Treat CMake warnings as errors. ```` must be one of the following: + + ``dev`` + Make developer warnings errors. + + Make warnings that are meant for the author of the ``CMakeLists.txt`` files + errors. By default this will also turn on deprecated warnings as errors. + + ``deprecated`` + Make deprecated macro and function warnings errors. + + Make warnings for usage of deprecated macros and functions, that are meant + for the author of the ``CMakeLists.txt`` files, errors. + +.. option:: -Wno-error= + + Do not treat CMake warnings as errors. ```` must be one of the following: + + ``dev`` + Make warnings that are meant for the author of the ``CMakeLists.txt`` files not + errors. By default this will also turn off deprecated warnings as errors. + + ``deprecated`` + Make warnings for usage of deprecated macros and functions, that are meant + for the author of the ``CMakeLists.txt`` files, not errors. diff --git a/Help/manual/include/OPTIONS_HELP.rst b/Help/manual/include/OPTIONS_HELP.rst new file mode 100644 index 0000000..f4f2dbe --- /dev/null +++ b/Help/manual/include/OPTIONS_HELP.rst @@ -0,0 +1,169 @@ +.. |file| replace:: The output is printed to a named ```` if given. + +.. option:: -version [], --version [], /V [] + + Show program name/version banner and exit. + |file| + +.. option:: -h, -H, --help, -help, -usage, /? + + Print usage information and exit. + + Usage describes the basic command line interface and its options. + +.. option:: --help [] + + Print help for one CMake keyword. + + ```` can be a property, variable, command, policy, generator + or module. + + The relevant manual entry for ```` is + printed in a human-readable text format. + |file| + + .. versionchanged:: 3.28 + + Prior to CMake 3.28, this option supported command names only. + +.. option:: --help-full [] + + Print all help manuals and exit. + + All manuals are printed in a human-readable text format. + |file| + +.. option:: --help-manual [] + + Print one help manual and exit. + + The specified manual is printed in a human-readable text format. + |file| + +.. option:: --help-manual-list [] + + List help manuals available and exit. + + The list contains all manuals for which help may be obtained by + using the ``--help-manual`` option followed by a manual name. + |file| + +.. option:: --help-command [] + + Print help for one command and exit. + + The :manual:`cmake-commands(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +.. option:: --help-command-list [] + + List commands with help available and exit. + + The list contains all commands for which help may be obtained by + using the ``--help-command`` option followed by a command name. + |file| + +.. option:: --help-commands [] + + Print cmake-commands manual and exit. + + The :manual:`cmake-commands(7)` manual is printed in a + human-readable text format. + |file| + +.. option:: --help-module [] + + Print help for one module and exit. + + The :manual:`cmake-modules(7)` manual entry for ```` is printed + in a human-readable text format. + |file| + +.. option:: --help-module-list [] + + List modules with help available and exit. + + The list contains all modules for which help may be obtained by + using the ``--help-module`` option followed by a module name. + |file| + +.. option:: --help-modules [] + + Print cmake-modules manual and exit. + + The :manual:`cmake-modules(7)` manual is printed in a human-readable + text format. + |file| + +.. option:: --help-policy [] + + Print help for one policy and exit. + + The :manual:`cmake-policies(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +.. option:: --help-policy-list [] + + List policies with help available and exit. + + The list contains all policies for which help may be obtained by + using the ``--help-policy`` option followed by a policy name. + |file| + +.. option:: --help-policies [] + + Print cmake-policies manual and exit. + + The :manual:`cmake-policies(7)` manual is printed in a + human-readable text format. + |file| + +.. option:: --help-property [] + + Print help for one property and exit. + + The :manual:`cmake-properties(7)` manual entries for ```` are + printed in a human-readable text format. + |file| + +.. option:: --help-property-list [] + + List properties with help available and exit. + + The list contains all properties for which help may be obtained by + using the ``--help-property`` option followed by a property name. + |file| + +.. option:: --help-properties [] + + Print cmake-properties manual and exit. + + The :manual:`cmake-properties(7)` manual is printed in a + human-readable text format. + |file| + +.. option:: --help-variable [] + + Print help for one variable and exit. + + The :manual:`cmake-variables(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +.. option:: --help-variable-list [] + + List variables with help available and exit. + + The list contains all variables for which help may be obtained by + using the ``--help-variable`` option followed by a variable name. + |file| + +.. option:: --help-variables [] + + Print cmake-variables manual and exit. + + The :manual:`cmake-variables(7)` manual is printed in a + human-readable text format. + |file| diff --git a/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt b/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt deleted file mode 100644 index 17289c3..0000000 --- a/Help/module/CMAKE_REQUIRED_DEFINITIONS.txt +++ /dev/null @@ -1,4 +0,0 @@ - ``CMAKE_REQUIRED_DEFINITIONS`` - A :ref:`;-list ` of compiler definitions of the form - ``-DFOO`` or ``-DFOO=bar``. A definition for the name specified by - ```` will also be added automatically. diff --git a/Help/module/CMAKE_REQUIRED_FLAGS.txt b/Help/module/CMAKE_REQUIRED_FLAGS.txt deleted file mode 100644 index 80ae239..0000000 --- a/Help/module/CMAKE_REQUIRED_FLAGS.txt +++ /dev/null @@ -1,6 +0,0 @@ - ``CMAKE_REQUIRED_FLAGS`` - String of additional flags to pass to the compiler. The string must be - space-delimited--a :ref:`;-list ` will not work. - The contents of :variable:`CMAKE__FLAGS _FLAGS>` and - its associated configuration-specific variable are automatically added - to the compiler command before the contents of ``CMAKE_REQUIRED_FLAGS``. diff --git a/Help/module/CMAKE_REQUIRED_INCLUDES.txt b/Help/module/CMAKE_REQUIRED_INCLUDES.txt deleted file mode 100644 index c8993bb..0000000 --- a/Help/module/CMAKE_REQUIRED_INCLUDES.txt +++ /dev/null @@ -1,4 +0,0 @@ - ``CMAKE_REQUIRED_INCLUDES`` - A :ref:`;-list ` of header search paths to pass to - the compiler. These will be the only header search paths used--the contents - of the :prop_dir:`INCLUDE_DIRECTORIES` directory property will be ignored. diff --git a/Help/module/CMAKE_REQUIRED_LIBRARIES.txt b/Help/module/CMAKE_REQUIRED_LIBRARIES.txt deleted file mode 100644 index 8611b9e..0000000 --- a/Help/module/CMAKE_REQUIRED_LIBRARIES.txt +++ /dev/null @@ -1,5 +0,0 @@ - ``CMAKE_REQUIRED_LIBRARIES`` - A :ref:`;-list ` of libraries to add to the link - command. These can be the name of system libraries or they can be - :ref:`Imported Targets ` (see :command:`try_compile` for - further details). diff --git a/Help/module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt b/Help/module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt deleted file mode 100644 index 35f433b..0000000 --- a/Help/module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +++ /dev/null @@ -1,5 +0,0 @@ - ``CMAKE_REQUIRED_LINK_DIRECTORIES`` - .. versionadded:: 3.31 - - A :ref:`;-list ` of libraries search paths to pass to - the linker (see :command:`try_compile` for further details). diff --git a/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt b/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt deleted file mode 100644 index f2a2474..0000000 --- a/Help/module/CMAKE_REQUIRED_LINK_OPTIONS.txt +++ /dev/null @@ -1,5 +0,0 @@ - ``CMAKE_REQUIRED_LINK_OPTIONS`` - .. versionadded:: 3.14 - - A :ref:`;-list ` of options to add to the link - command (see :command:`try_compile` for further details). diff --git a/Help/module/CMAKE_REQUIRED_QUIET.txt b/Help/module/CMAKE_REQUIRED_QUIET.txt deleted file mode 100644 index aae8059..0000000 --- a/Help/module/CMAKE_REQUIRED_QUIET.txt +++ /dev/null @@ -1,5 +0,0 @@ - ``CMAKE_REQUIRED_QUIET`` - .. versionadded:: 3.1 - - If this variable evaluates to a boolean true value, all status messages - associated with the check will be suppressed. diff --git a/Help/module/include/CMAKE_REQUIRED_DEFINITIONS.rst b/Help/module/include/CMAKE_REQUIRED_DEFINITIONS.rst new file mode 100644 index 0000000..17289c3 --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_DEFINITIONS.rst @@ -0,0 +1,4 @@ + ``CMAKE_REQUIRED_DEFINITIONS`` + A :ref:`;-list ` of compiler definitions of the form + ``-DFOO`` or ``-DFOO=bar``. A definition for the name specified by + ```` will also be added automatically. diff --git a/Help/module/include/CMAKE_REQUIRED_FLAGS.rst b/Help/module/include/CMAKE_REQUIRED_FLAGS.rst new file mode 100644 index 0000000..80ae239 --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_FLAGS.rst @@ -0,0 +1,6 @@ + ``CMAKE_REQUIRED_FLAGS`` + String of additional flags to pass to the compiler. The string must be + space-delimited--a :ref:`;-list ` will not work. + The contents of :variable:`CMAKE__FLAGS _FLAGS>` and + its associated configuration-specific variable are automatically added + to the compiler command before the contents of ``CMAKE_REQUIRED_FLAGS``. diff --git a/Help/module/include/CMAKE_REQUIRED_INCLUDES.rst b/Help/module/include/CMAKE_REQUIRED_INCLUDES.rst new file mode 100644 index 0000000..c8993bb --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_INCLUDES.rst @@ -0,0 +1,4 @@ + ``CMAKE_REQUIRED_INCLUDES`` + A :ref:`;-list ` of header search paths to pass to + the compiler. These will be the only header search paths used--the contents + of the :prop_dir:`INCLUDE_DIRECTORIES` directory property will be ignored. diff --git a/Help/module/include/CMAKE_REQUIRED_LIBRARIES.rst b/Help/module/include/CMAKE_REQUIRED_LIBRARIES.rst new file mode 100644 index 0000000..8611b9e --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_LIBRARIES.rst @@ -0,0 +1,5 @@ + ``CMAKE_REQUIRED_LIBRARIES`` + A :ref:`;-list ` of libraries to add to the link + command. These can be the name of system libraries or they can be + :ref:`Imported Targets ` (see :command:`try_compile` for + further details). diff --git a/Help/module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst b/Help/module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst new file mode 100644 index 0000000..35f433b --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst @@ -0,0 +1,5 @@ + ``CMAKE_REQUIRED_LINK_DIRECTORIES`` + .. versionadded:: 3.31 + + A :ref:`;-list ` of libraries search paths to pass to + the linker (see :command:`try_compile` for further details). diff --git a/Help/module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst b/Help/module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst new file mode 100644 index 0000000..f2a2474 --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst @@ -0,0 +1,5 @@ + ``CMAKE_REQUIRED_LINK_OPTIONS`` + .. versionadded:: 3.14 + + A :ref:`;-list ` of options to add to the link + command (see :command:`try_compile` for further details). diff --git a/Help/module/include/CMAKE_REQUIRED_QUIET.rst b/Help/module/include/CMAKE_REQUIRED_QUIET.rst new file mode 100644 index 0000000..aae8059 --- /dev/null +++ b/Help/module/include/CMAKE_REQUIRED_QUIET.rst @@ -0,0 +1,5 @@ + ``CMAKE_REQUIRED_QUIET`` + .. versionadded:: 3.1 + + If this variable evaluates to a boolean true value, all status messages + associated with the check will be suppressed. diff --git a/Help/policy/CMP0000.rst b/Help/policy/CMP0000.rst index e06a4c2..1c723c6 100644 --- a/Help/policy/CMP0000.rst +++ b/Help/policy/CMP0000.rst @@ -2,7 +2,7 @@ CMP0000 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst A minimum required CMake version must be specified. @@ -30,4 +30,4 @@ behavior is to issue an error instead of a warning. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0001.rst b/Help/policy/CMP0001.rst index 3a3c442..f35a61b 100644 --- a/Help/policy/CMP0001.rst +++ b/Help/policy/CMP0001.rst @@ -2,7 +2,7 @@ CMP0001 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst ``CMAKE_BACKWARDS_COMPATIBILITY`` should no longer be used. @@ -19,4 +19,4 @@ below. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0002.rst b/Help/policy/CMP0002.rst index 02fbf57..d2d2b97 100644 --- a/Help/policy/CMP0002.rst +++ b/Help/policy/CMP0002.rst @@ -2,7 +2,7 @@ CMP0002 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Logical target names must be globally unique. @@ -24,4 +24,4 @@ property :prop_gbl:`ALLOW_DUPLICATE_CUSTOM_TARGETS` with a Makefiles generator). .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0003.rst b/Help/policy/CMP0003.rst index e3c8fa6..417d23d 100644 --- a/Help/policy/CMP0003.rst +++ b/Help/policy/CMP0003.rst @@ -2,7 +2,7 @@ CMP0003 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Libraries linked via full path no longer produce linker search paths. @@ -102,4 +102,4 @@ when setting the policy once will probably fix all targets. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0004.rst b/Help/policy/CMP0004.rst index 94d04fe..2d62d8e 100644 --- a/Help/policy/CMP0004.rst +++ b/Help/policy/CMP0004.rst @@ -2,7 +2,7 @@ CMP0004 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Libraries linked may not have leading or trailing whitespace. @@ -24,4 +24,4 @@ command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0005.rst b/Help/policy/CMP0005.rst index 9163845..1c1f41a 100644 --- a/Help/policy/CMP0005.rst +++ b/Help/policy/CMP0005.rst @@ -2,7 +2,7 @@ CMP0005 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Preprocessor definition values are now escaped automatically. @@ -24,4 +24,4 @@ limitations of the escaping implementation. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0006.rst b/Help/policy/CMP0006.rst index 08776f2..2afc222 100644 --- a/Help/policy/CMP0006.rst +++ b/Help/policy/CMP0006.rst @@ -2,7 +2,7 @@ CMP0006 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Installing :prop_tgt:`MACOSX_BUNDLE` targets requires a ``BUNDLE DESTINATION``. @@ -22,4 +22,4 @@ without a ``BUNDLE DESTINATION``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0007.rst b/Help/policy/CMP0007.rst index 7b013db..37f90eb 100644 --- a/Help/policy/CMP0007.rst +++ b/Help/policy/CMP0007.rst @@ -2,7 +2,7 @@ CMP0007 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst list command no longer ignores empty elements. @@ -15,4 +15,4 @@ empty elements in a list. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0008.rst b/Help/policy/CMP0008.rst index 8a4b8c5..a66f174 100644 --- a/Help/policy/CMP0008.rst +++ b/Help/policy/CMP0008.rst @@ -2,7 +2,7 @@ CMP0008 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Libraries linked by full-path must have a valid library file name. @@ -33,4 +33,4 @@ pass it directly to the native build tool unchanged. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0009.rst b/Help/policy/CMP0009.rst index aeef533..7c9b6b1 100644 --- a/Help/policy/CMP0009.rst +++ b/Help/policy/CMP0009.rst @@ -2,7 +2,7 @@ CMP0009 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst FILE GLOB_RECURSE calls should not follow symlinks by default. @@ -19,4 +19,4 @@ as an additional argument to the ``FILE`` command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.2 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0010.rst b/Help/policy/CMP0010.rst index 1f32283..501ee38 100644 --- a/Help/policy/CMP0010.rst +++ b/Help/policy/CMP0010.rst @@ -2,7 +2,7 @@ CMP0010 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Bad variable reference syntax is an error. @@ -18,4 +18,4 @@ and is treated as always being ``NEW``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0011.rst b/Help/policy/CMP0011.rst index 98614b9..0f20f87 100644 --- a/Help/policy/CMP0011.rst +++ b/Help/policy/CMP0011.rst @@ -2,7 +2,7 @@ CMP0011 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Included scripts do automatic :command:`cmake_policy` PUSH and POP. @@ -23,4 +23,4 @@ their default cmake_policy ``PUSH`` and ``POP``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.6.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0012.rst b/Help/policy/CMP0012.rst index 24cc20b..8a6639b 100644 --- a/Help/policy/CMP0012.rst +++ b/Help/policy/CMP0012.rst @@ -2,7 +2,7 @@ CMP0012 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst :command:`if` recognizes numbers and boolean constants. @@ -26,4 +26,4 @@ dereferencing variables with such names. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0013.rst b/Help/policy/CMP0013.rst index c22d5c9..c396096 100644 --- a/Help/policy/CMP0013.rst +++ b/Help/policy/CMP0013.rst @@ -2,7 +2,7 @@ CMP0013 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Duplicate binary directories are not allowed. @@ -19,4 +19,4 @@ with an error. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0014.rst b/Help/policy/CMP0014.rst index e147705..49b9046 100644 --- a/Help/policy/CMP0014.rst +++ b/Help/policy/CMP0014.rst @@ -2,7 +2,7 @@ CMP0014 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Input directories must have ``CMakeLists.txt``. @@ -15,4 +15,4 @@ The ``NEW`` behavior for this policy is to report an error. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0015.rst b/Help/policy/CMP0015.rst index 6fbe833..de4cbe8 100644 --- a/Help/policy/CMP0015.rst +++ b/Help/policy/CMP0015.rst @@ -2,7 +2,7 @@ CMP0015 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst :command:`link_directories` treats paths relative to the source dir. @@ -17,4 +17,4 @@ paths by appending the relative path to ``CMAKE_CURRENT_SOURCE_DIR``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0016.rst b/Help/policy/CMP0016.rst index 2e5ac53..3da7280 100644 --- a/Help/policy/CMP0016.rst +++ b/Help/policy/CMP0016.rst @@ -2,7 +2,7 @@ CMP0016 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst :command:`target_link_libraries` reports error if its only argument is not a target. @@ -14,4 +14,4 @@ in this case. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0017.rst b/Help/policy/CMP0017.rst index 7bac8a6..65714ae 100644 --- a/Help/policy/CMP0017.rst +++ b/Help/policy/CMP0017.rst @@ -2,7 +2,7 @@ CMP0017 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Prefer files from the CMake module directory when including from there. @@ -19,4 +19,4 @@ from the CMake modules directory. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.4 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0018.rst b/Help/policy/CMP0018.rst index c3ae66f..322045c 100644 --- a/Help/policy/CMP0018.rst +++ b/Help/policy/CMP0018.rst @@ -2,7 +2,7 @@ CMP0018 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Ignore ``CMAKE_SHARED_LIBRARY__FLAGS`` variable. @@ -32,4 +32,4 @@ honor the :prop_tgt:`POSITION_INDEPENDENT_CODE` target property. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.9 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0019.rst b/Help/policy/CMP0019.rst index 004316f..0fece7e 100644 --- a/Help/policy/CMP0019.rst +++ b/Help/policy/CMP0019.rst @@ -2,7 +2,7 @@ CMP0019 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Do not re-expand variables in include and link information. @@ -20,4 +20,4 @@ the values untouched. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.11 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0020.rst b/Help/policy/CMP0020.rst index ceace31..7eee5af 100644 --- a/Help/policy/CMP0020.rst +++ b/Help/policy/CMP0020.rst @@ -2,7 +2,7 @@ CMP0020 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Automatically link Qt executables to ``qtmain`` target on Windows. @@ -25,4 +25,4 @@ automatically when they link to QtCore ``IMPORTED`` target. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.11 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0021.rst b/Help/policy/CMP0021.rst index b9074ab..7cb5fb8 100644 --- a/Help/policy/CMP0021.rst +++ b/Help/policy/CMP0021.rst @@ -2,7 +2,7 @@ CMP0021 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Fatal error on relative paths in :prop_tgt:`INCLUDE_DIRECTORIES` target property. @@ -19,4 +19,4 @@ relative path. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.12 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0022.rst b/Help/policy/CMP0022.rst index 91e7aa3..584b05e 100644 --- a/Help/policy/CMP0022.rst +++ b/Help/policy/CMP0022.rst @@ -2,7 +2,7 @@ CMP0022 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst :prop_tgt:`INTERFACE_LINK_LIBRARIES` defines the link interface. @@ -37,4 +37,4 @@ property for in-build targets, and ignore the old properties matching .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.12 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0023.rst b/Help/policy/CMP0023.rst index 6f582ec..e147d7c 100644 --- a/Help/policy/CMP0023.rst +++ b/Help/policy/CMP0023.rst @@ -2,7 +2,7 @@ CMP0023 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Plain and keyword :command:`target_link_libraries` signatures cannot be mixed. @@ -33,4 +33,4 @@ signatures. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 2.8.12 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0024.rst b/Help/policy/CMP0024.rst index 72dbc0e..02be08f 100644 --- a/Help/policy/CMP0024.rst +++ b/Help/policy/CMP0024.rst @@ -2,7 +2,7 @@ CMP0024 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Disallow include export result. @@ -22,4 +22,4 @@ allow including the result of an :command:`export` command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0025.rst b/Help/policy/CMP0025.rst index d0f67f9..481189e 100644 --- a/Help/policy/CMP0025.rst +++ b/Help/policy/CMP0025.rst @@ -2,7 +2,7 @@ CMP0025 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Compiler id for Apple Clang is now ``AppleClang``. @@ -23,7 +23,7 @@ The ``OLD`` behavior for this policy is to use compiler id ``Clang``. The .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn by default -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0025 >` diff --git a/Help/policy/CMP0026.rst b/Help/policy/CMP0026.rst index 06b1dd1..339d325 100644 --- a/Help/policy/CMP0026.rst +++ b/Help/policy/CMP0026.rst @@ -2,7 +2,7 @@ CMP0026 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Disallow use of the LOCATION property for build targets. @@ -27,4 +27,4 @@ not to allow reading the :prop_tgt:`LOCATION` properties from build-targets. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0027.rst b/Help/policy/CMP0027.rst index eaf1929..98581a7 100644 --- a/Help/policy/CMP0027.rst +++ b/Help/policy/CMP0027.rst @@ -2,7 +2,7 @@ CMP0027 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Conditionally linked imported targets with missing include directories. @@ -25,4 +25,4 @@ conditionally linked ``IMPORTED`` target does not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0028.rst b/Help/policy/CMP0028.rst index c0ba715..f7c5c9a 100644 --- a/Help/policy/CMP0028.rst +++ b/Help/policy/CMP0028.rst @@ -2,7 +2,7 @@ CMP0028 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Double colon in target name means ``ALIAS`` or ``IMPORTED`` target. @@ -25,4 +25,4 @@ double-colons but is not an ``IMPORTED`` target or an ``ALIAS`` target. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0029.rst b/Help/policy/CMP0029.rst index b5cca1e..afa27c3 100644 --- a/Help/policy/CMP0029.rst +++ b/Help/policy/CMP0029.rst @@ -2,7 +2,7 @@ CMP0029 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`subdir_depends` command should not be called. @@ -10,4 +10,4 @@ The implementation of this command has been empty since December 2001 but was kept in CMake for compatibility for a long time. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0030.rst b/Help/policy/CMP0030.rst index a0b11d5..5a88881 100644 --- a/Help/policy/CMP0030.rst +++ b/Help/policy/CMP0030.rst @@ -2,7 +2,7 @@ CMP0030 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`use_mangled_mesa` command should not be called. @@ -11,4 +11,4 @@ modern CMake language and custom command capabilities. VTK has not used it in years. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0031.rst b/Help/policy/CMP0031.rst index 7e5f22d..ca9bc81 100644 --- a/Help/policy/CMP0031.rst +++ b/Help/policy/CMP0031.rst @@ -2,7 +2,7 @@ CMP0031 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`load_command` command should not be called. @@ -13,4 +13,4 @@ the CMake process. It has been mostly superseded by the :command:`macro` and :command:`function` commands. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0032.rst b/Help/policy/CMP0032.rst index 26a9c15..554d56e 100644 --- a/Help/policy/CMP0032.rst +++ b/Help/policy/CMP0032.rst @@ -2,7 +2,7 @@ CMP0032 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`output_required_files` command should not be called. @@ -13,4 +13,4 @@ scanning capabilities of this command are very limited and this functionality is better achieved through dedicated outside tools. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0033.rst b/Help/policy/CMP0033.rst index 7f84dc0..ccb659e 100644 --- a/Help/policy/CMP0033.rst +++ b/Help/policy/CMP0033.rst @@ -2,7 +2,7 @@ CMP0033 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`export_library_dependencies` command should not be called. @@ -14,4 +14,4 @@ The functionality has been superseded by the :command:`export` and :command:`install(EXPORT)` commands. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0034.rst b/Help/policy/CMP0034.rst index 386cd34..a9646dd 100644 --- a/Help/policy/CMP0034.rst +++ b/Help/policy/CMP0034.rst @@ -2,7 +2,7 @@ CMP0034 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`utility_source` command should not be called. @@ -11,4 +11,4 @@ generate other files. This approach has long been replaced by :command:`add_executable` combined with :command:`add_custom_command`. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0035.rst b/Help/policy/CMP0035.rst index b3e818e..f63a5d4 100644 --- a/Help/policy/CMP0035.rst +++ b/Help/policy/CMP0035.rst @@ -2,7 +2,7 @@ CMP0035 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`variable_requires` command should not be called. @@ -10,4 +10,4 @@ This command was introduced in November 2001 to perform some conditional logic. It has long been replaced by the :command:`if` command. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0036.rst b/Help/policy/CMP0036.rst index 0d1f857..17dfa7b 100644 --- a/Help/policy/CMP0036.rst +++ b/Help/policy/CMP0036.rst @@ -2,7 +2,7 @@ CMP0036 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`build_name` command should not be called. @@ -12,4 +12,4 @@ documented as discouraged and replaced by the :variable:`CMAKE_SYSTEM` and :variable:`CMAKE__COMPILER` variables. .. |disallowed_version| replace:: 3.0 -.. include:: REMOVED_COMMAND.txt +.. include:: include/REMOVED_COMMAND.rst diff --git a/Help/policy/CMP0037.rst b/Help/policy/CMP0037.rst index 5d3f518..e74f49a 100644 --- a/Help/policy/CMP0037.rst +++ b/Help/policy/CMP0037.rst @@ -2,7 +2,7 @@ CMP0037 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Target names should not be reserved and should match a validity pattern. @@ -32,4 +32,4 @@ if an add_* command is used with an invalid target name. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0038.rst b/Help/policy/CMP0038.rst index df147de..b29fbd6 100644 --- a/Help/policy/CMP0038.rst +++ b/Help/policy/CMP0038.rst @@ -2,7 +2,7 @@ CMP0038 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Targets may not link directly to themselves. @@ -16,4 +16,4 @@ report an error if a target attempts to link to itself. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0039.rst b/Help/policy/CMP0039.rst index 4a0a7aa..136696d 100644 --- a/Help/policy/CMP0039.rst +++ b/Help/policy/CMP0039.rst @@ -2,7 +2,7 @@ CMP0039 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Utility targets may not have link dependencies. @@ -17,4 +17,4 @@ utility target. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0040.rst b/Help/policy/CMP0040.rst index 7d7bec0..6772ac0 100644 --- a/Help/policy/CMP0040.rst +++ b/Help/policy/CMP0040.rst @@ -2,7 +2,7 @@ CMP0040 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The target in the ``TARGET`` signature of :command:`add_custom_command` must exist and must be defined in the current directory. @@ -18,4 +18,4 @@ unknown or was defined outside the current directory. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0041.rst b/Help/policy/CMP0041.rst index d3f0043..bbc3c2f 100644 --- a/Help/policy/CMP0041.rst +++ b/Help/policy/CMP0041.rst @@ -2,7 +2,7 @@ CMP0041 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Error on relative include with generator expression. @@ -25,4 +25,4 @@ relative. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0042.rst b/Help/policy/CMP0042.rst index 3985e21..22ddf78 100644 --- a/Help/policy/CMP0042.rst +++ b/Help/policy/CMP0042.rst @@ -2,7 +2,7 @@ CMP0042 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst :prop_tgt:`MACOSX_RPATH` is enabled by default. @@ -19,4 +19,4 @@ variables. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0043.rst b/Help/policy/CMP0043.rst index 5b248b9..05a429b 100644 --- a/Help/policy/CMP0043.rst +++ b/Help/policy/CMP0043.rst @@ -2,7 +2,7 @@ CMP0043 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Ignore COMPILE_DEFINITIONS_ properties @@ -45,4 +45,4 @@ of the :prop_tgt:`COMPILE_DEFINITIONS_` target property . .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0044.rst b/Help/policy/CMP0044.rst index 9ee1be1..fa96435 100644 --- a/Help/policy/CMP0044.rst +++ b/Help/policy/CMP0044.rst @@ -2,7 +2,7 @@ CMP0044 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Case sensitive ``_COMPILER_ID`` generator expressions @@ -19,4 +19,4 @@ the ``_COMPILER_ID`` expression. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0045.rst b/Help/policy/CMP0045.rst index 5dea2b6..192b16f 100644 --- a/Help/policy/CMP0045.rst +++ b/Help/policy/CMP0045.rst @@ -2,7 +2,7 @@ CMP0045 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Error on non-existent target in get_target_property. @@ -17,4 +17,4 @@ non-existent target. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0046.rst b/Help/policy/CMP0046.rst index cf45945..e61c71f 100644 --- a/Help/policy/CMP0046.rst +++ b/Help/policy/CMP0046.rst @@ -2,7 +2,7 @@ CMP0046 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Error on non-existent dependency in add_dependencies. @@ -16,4 +16,4 @@ command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0047.rst b/Help/policy/CMP0047.rst index e890260..876375f 100644 --- a/Help/policy/CMP0047.rst +++ b/Help/policy/CMP0047.rst @@ -2,7 +2,7 @@ CMP0047 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Use ``QCC`` compiler id for the qcc drivers on QNX. @@ -24,7 +24,7 @@ is to use the ``QCC`` compiler id for those drivers. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn by default -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0047 >` diff --git a/Help/policy/CMP0048.rst b/Help/policy/CMP0048.rst index 76a74ce..07e5abd 100644 --- a/Help/policy/CMP0048.rst +++ b/Help/policy/CMP0048.rst @@ -2,7 +2,7 @@ CMP0048 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst The :command:`project` command manages ``VERSION`` variables. @@ -21,4 +21,4 @@ The ``NEW`` behavior for this policy is to set ``VERSION`` as documented by the .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0049.rst b/Help/policy/CMP0049.rst index c2500cd..c34f35e 100644 --- a/Help/policy/CMP0049.rst +++ b/Help/policy/CMP0049.rst @@ -2,7 +2,7 @@ CMP0049 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Do not expand variables in target source entries. @@ -22,4 +22,4 @@ if such variables need to be expanded. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0050.rst b/Help/policy/CMP0050.rst index dcd68a6..5a59019 100644 --- a/Help/policy/CMP0050.rst +++ b/Help/policy/CMP0050.rst @@ -2,7 +2,7 @@ CMP0050 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst Disallow add_custom_command SOURCE signatures. @@ -17,4 +17,4 @@ policy is to issue an error if such a signature is used. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.0 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0051.rst b/Help/policy/CMP0051.rst index ae4498a..aa4ec0c 100644 --- a/Help/policy/CMP0051.rst +++ b/Help/policy/CMP0051.rst @@ -2,7 +2,7 @@ CMP0051 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.1 @@ -25,4 +25,4 @@ in the output. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0052.rst b/Help/policy/CMP0052.rst index c4cd981..f88b44b 100644 --- a/Help/policy/CMP0052.rst +++ b/Help/policy/CMP0052.rst @@ -2,7 +2,7 @@ CMP0052 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.1 @@ -26,4 +26,4 @@ policy is to issue an error if such a directory is used. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0053.rst b/Help/policy/CMP0053.rst index 82ab716..f61427d 100644 --- a/Help/policy/CMP0053.rst +++ b/Help/policy/CMP0053.rst @@ -2,7 +2,7 @@ CMP0053 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.1 @@ -49,4 +49,4 @@ use the simpler variable expansion and escape sequence evaluation rules. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0054.rst b/Help/policy/CMP0054.rst index 560b706..cbdbdf3 100644 --- a/Help/policy/CMP0054.rst +++ b/Help/policy/CMP0054.rst @@ -2,7 +2,7 @@ CMP0054 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.1 @@ -51,4 +51,4 @@ further dereferenced: .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.1 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0055.rst b/Help/policy/CMP0055.rst index eda4700..d6e9f81 100644 --- a/Help/policy/CMP0055.rst +++ b/Help/policy/CMP0055.rst @@ -2,7 +2,7 @@ CMP0055 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.2 @@ -18,4 +18,4 @@ policy is to issue an error if a misplaced break or any arguments are found. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.2 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0056.rst b/Help/policy/CMP0056.rst index 41ca3ba..2158f14 100644 --- a/Help/policy/CMP0056.rst +++ b/Help/policy/CMP0056.rst @@ -2,7 +2,7 @@ CMP0056 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.2 @@ -32,7 +32,7 @@ variable in the cache. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.2 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn by default -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0056 >` diff --git a/Help/policy/CMP0057.rst b/Help/policy/CMP0057.rst index 4c78568..e1b1bb1 100644 --- a/Help/policy/CMP0057.rst +++ b/Help/policy/CMP0057.rst @@ -2,7 +2,7 @@ CMP0057 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -15,4 +15,4 @@ The ``NEW`` behavior is to interpret the IN_LIST operator. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0058.rst b/Help/policy/CMP0058.rst index 7069a93..605797b 100644 --- a/Help/policy/CMP0058.rst +++ b/Help/policy/CMP0058.rst @@ -2,7 +2,7 @@ CMP0058 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -113,4 +113,4 @@ The policy setting must be in scope at the end of the top-level .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned when it saw unknown dependencies in out-of-source build trees -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0059.rst b/Help/policy/CMP0059.rst index 3dfc81b..7ca407e 100644 --- a/Help/policy/CMP0059.rst +++ b/Help/policy/CMP0059.rst @@ -2,7 +2,7 @@ CMP0059 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -18,4 +18,4 @@ to behave as a normal user-defined directory property. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0060.rst b/Help/policy/CMP0060.rst index 078f22e..e1c0b22 100644 --- a/Help/policy/CMP0060.rst +++ b/Help/policy/CMP0060.rst @@ -2,7 +2,7 @@ CMP0060 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -63,7 +63,7 @@ if they are in implicit link directories. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn by default -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0060 >` diff --git a/Help/policy/CMP0061.rst b/Help/policy/CMP0061.rst index 765ecb7..52a4ee1 100644 --- a/Help/policy/CMP0061.rst +++ b/Help/policy/CMP0061.rst @@ -2,7 +2,7 @@ CMP0061 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -26,4 +26,4 @@ add ``-i``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0062.rst b/Help/policy/CMP0062.rst index c785b46..c90efcb 100644 --- a/Help/policy/CMP0062.rst +++ b/Help/policy/CMP0062.rst @@ -2,7 +2,7 @@ CMP0062 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -28,4 +28,4 @@ not to allow installing the result of an :command:`export()` command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0063.rst b/Help/policy/CMP0063.rst index 1f00c20..2446b7a 100644 --- a/Help/policy/CMP0063.rst +++ b/Help/policy/CMP0063.rst @@ -2,7 +2,7 @@ CMP0063 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.3 @@ -27,4 +27,4 @@ for all target types. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.3 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0064.rst b/Help/policy/CMP0064.rst index fca428b..8174eac 100644 --- a/Help/policy/CMP0064.rst +++ b/Help/policy/CMP0064.rst @@ -2,7 +2,7 @@ CMP0064 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.4 @@ -16,4 +16,4 @@ The ``NEW`` behavior is to interpret the ``TEST`` operator. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.4 .. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/CMP0065.rst b/Help/policy/CMP0065.rst index 7d70899..baabe0c 100644 --- a/Help/policy/CMP0065.rst +++ b/Help/policy/CMP0065.rst @@ -2,7 +2,7 @@ CMP0065 ------- .. |REMOVED_IN_CMAKE_VERSION| replace:: 4.0 -.. include:: REMOVED_PROLOGUE.txt +.. include:: include/REMOVED_PROLOGUE.rst .. versionadded:: 3.4 @@ -25,7 +25,7 @@ property is set to ``True``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.4 .. |WARNED_OR_DID_NOT_WARN| replace:: did *not* warn by default -.. include:: REMOVED_EPILOGUE.txt +.. include:: include/REMOVED_EPILOGUE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0065 >` diff --git a/Help/policy/CMP0066.rst b/Help/policy/CMP0066.rst index 947a186..e3dfc52 100644 --- a/Help/policy/CMP0066.rst +++ b/Help/policy/CMP0066.rst @@ -22,10 +22,10 @@ variables like :variable:`CMAKE__FLAGS_DEBUG`. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.7 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0066 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0067.rst b/Help/policy/CMP0067.rst index 0696131..19ce293 100644 --- a/Help/policy/CMP0067.rst +++ b/Help/policy/CMP0067.rst @@ -32,10 +32,10 @@ setting variables. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.8 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0067 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0068.rst b/Help/policy/CMP0068.rst index aad8c3a..5535e91 100644 --- a/Help/policy/CMP0068.rst +++ b/Help/policy/CMP0068.rst @@ -31,6 +31,6 @@ the ``RPATH`` settings for ``install_name`` on macOS. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.9 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0069.rst b/Help/policy/CMP0069.rst index 97665e6..3bc7ca4 100644 --- a/Help/policy/CMP0069.rst +++ b/Help/policy/CMP0069.rst @@ -28,9 +28,9 @@ compiler or produce an error if CMake does not know the flags. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.9 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst Examples ^^^^^^^^ diff --git a/Help/policy/CMP0070.rst b/Help/policy/CMP0070.rst index 33b5a97..cb9bed7 100644 --- a/Help/policy/CMP0070.rst +++ b/Help/policy/CMP0070.rst @@ -21,6 +21,6 @@ directory of the caller. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.10 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0071.rst b/Help/policy/CMP0071.rst index 5c86f55..88bf2a8 100644 --- a/Help/policy/CMP0071.rst +++ b/Help/policy/CMP0071.rst @@ -40,6 +40,6 @@ Source skip example: .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.10 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0072.rst b/Help/policy/CMP0072.rst index 430cb5a..9b20db0 100644 --- a/Help/policy/CMP0072.rst +++ b/Help/policy/CMP0072.rst @@ -22,6 +22,6 @@ The ``OLD`` behavior for this policy is to set ``OpenGL_GL_PREFERENCE`` to .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.11 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0073.rst b/Help/policy/CMP0073.rst index 897092e..8be6db3 100644 --- a/Help/policy/CMP0073.rst +++ b/Help/policy/CMP0073.rst @@ -21,6 +21,6 @@ entries. The ``NEW`` behavior for this policy is to not set them. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.12 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0074.rst b/Help/policy/CMP0074.rst index fff843f..6eacf98 100644 --- a/Help/policy/CMP0074.rst +++ b/Help/policy/CMP0074.rst @@ -19,6 +19,6 @@ variables. The ``NEW`` behavior for this policy is to use .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.12 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0075.rst b/Help/policy/CMP0075.rst index 479c629..a1022ee 100644 --- a/Help/policy/CMP0075.rst +++ b/Help/policy/CMP0075.rst @@ -22,6 +22,6 @@ honor ``CMAKE_REQUIRED_LIBRARIES`` in the include file check macros. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.12 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0076.rst b/Help/policy/CMP0076.rst index a30b4c9..453bcf3 100644 --- a/Help/policy/CMP0076.rst +++ b/Help/policy/CMP0076.rst @@ -22,6 +22,6 @@ policy is to convert relative paths to absolute according to above rules. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0077.rst b/Help/policy/CMP0077.rst index f64f92f..cefef61 100644 --- a/Help/policy/CMP0077.rst +++ b/Help/policy/CMP0077.rst @@ -52,10 +52,10 @@ between the two policies. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst Use the :variable:`CMAKE_POLICY_DEFAULT_CMP0077 >` variable to set the policy for a third-party project in a subdirectory without modifying it. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0078.rst b/Help/policy/CMP0078.rst index c4b8a64..6fc199f 100644 --- a/Help/policy/CMP0078.rst +++ b/Help/policy/CMP0078.rst @@ -20,6 +20,6 @@ explicit preference. The value may be one of: .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0079.rst b/Help/policy/CMP0079.rst index 039ac7b..1a8eb35 100644 --- a/Help/policy/CMP0079.rst +++ b/Help/policy/CMP0079.rst @@ -36,6 +36,6 @@ calls but use the new scoping rules. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0080.rst b/Help/policy/CMP0080.rst index cface96..040bf97 100644 --- a/Help/policy/CMP0080.rst +++ b/Help/policy/CMP0080.rst @@ -21,6 +21,6 @@ disallow such inclusion. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0081.rst b/Help/policy/CMP0081.rst index b89a353..6df7d9d 100644 --- a/Help/policy/CMP0081.rst +++ b/Help/policy/CMP0081.rst @@ -19,6 +19,6 @@ contains a relative path. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.13 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0082.rst b/Help/policy/CMP0082.rst index 2de0cd9..e5bc6f6 100644 --- a/Help/policy/CMP0082.rst +++ b/Help/policy/CMP0082.rst @@ -21,10 +21,10 @@ declared. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0082 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0083.rst b/Help/policy/CMP0083.rst index 2ba9e14..d00390b 100644 --- a/Help/policy/CMP0083.rst +++ b/Help/policy/CMP0083.rst @@ -27,7 +27,7 @@ honored at link time. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst .. Note:: @@ -35,7 +35,7 @@ honored at link time. to use the :module:`CheckPIESupported` module to ensure flags are passed to the linker. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst Examples ^^^^^^^^ diff --git a/Help/policy/CMP0084.rst b/Help/policy/CMP0084.rst index 3b86a73..827f40b 100644 --- a/Help/policy/CMP0084.rst +++ b/Help/policy/CMP0084.rst @@ -22,6 +22,6 @@ exist for :command:`find_package`. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0085.rst b/Help/policy/CMP0085.rst index 783c644..f1b080c 100644 --- a/Help/policy/CMP0085.rst +++ b/Help/policy/CMP0085.rst @@ -17,6 +17,6 @@ if the first argument is empty and the list contains an empty item. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0086.rst b/Help/policy/CMP0086.rst index c1abffe..2534e5a 100644 --- a/Help/policy/CMP0086.rst +++ b/Help/policy/CMP0086.rst @@ -16,6 +16,6 @@ The ``NEW`` behavior is to pass ``-module`` option to ``SWIG`` compiler if .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0087.rst b/Help/policy/CMP0087.rst index 3ef2c60..605e658 100644 --- a/Help/policy/CMP0087.rst +++ b/Help/policy/CMP0087.rst @@ -25,6 +25,6 @@ rather than :command:`add_subdirectory()`). .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0088.rst b/Help/policy/CMP0088.rst index e53078c..845849d 100644 --- a/Help/policy/CMP0088.rst +++ b/Help/policy/CMP0088.rst @@ -25,6 +25,6 @@ to generate implicit files. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.14 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0089.rst b/Help/policy/CMP0089.rst index 5f548c0..b5284fb 100644 --- a/Help/policy/CMP0089.rst +++ b/Help/policy/CMP0089.rst @@ -23,10 +23,10 @@ The ``OLD`` behavior for this policy is to use compiler id ``XL``. The .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0089 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0090.rst b/Help/policy/CMP0090.rst index df7726c..42c7aac 100644 --- a/Help/policy/CMP0090.rst +++ b/Help/policy/CMP0090.rst @@ -23,6 +23,6 @@ unless the :variable:`CMAKE_EXPORT_PACKAGE_REGISTRY` is enabled. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0091.rst b/Help/policy/CMP0091.rst index 110e655..5e140ec 100644 --- a/Help/policy/CMP0091.rst +++ b/Help/policy/CMP0091.rst @@ -45,6 +45,6 @@ library flags in the default cache entries and use the abstraction instead. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0092.rst b/Help/policy/CMP0092.rst index 03a9975..fed18cd 100644 --- a/Help/policy/CMP0092.rst +++ b/Help/policy/CMP0092.rst @@ -34,6 +34,6 @@ entries. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0093.rst b/Help/policy/CMP0093.rst index 5f7ae7d..27762d3 100644 --- a/Help/policy/CMP0093.rst +++ b/Help/policy/CMP0093.rst @@ -20,6 +20,6 @@ policy is for :module:`FindBoost` to report ``Boost_VERSION`` in .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0094.rst b/Help/policy/CMP0094.rst index 1b88a22..d465f48 100644 --- a/Help/policy/CMP0094.rst +++ b/Help/policy/CMP0094.rst @@ -18,6 +18,6 @@ The ``OLD`` behavior for this policy set value ``VERSION`` for variables .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.15 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0095.rst b/Help/policy/CMP0095.rst index cbeffc7..5237379 100644 --- a/Help/policy/CMP0095.rst +++ b/Help/policy/CMP0095.rst @@ -27,6 +27,6 @@ intermediary ``cmake_install.cmake`` script. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.16 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns when it detects use of CMake-like syntax -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0096.rst b/Help/policy/CMP0096.rst index 8ea3784..3772ec9 100644 --- a/Help/policy/CMP0096.rst +++ b/Help/policy/CMP0096.rst @@ -21,6 +21,6 @@ version ``1.07.06`` remains unchanged. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.16 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0097.rst b/Help/policy/CMP0097.rst index d9141f5..89fb977 100644 --- a/Help/policy/CMP0097.rst +++ b/Help/policy/CMP0097.rst @@ -21,7 +21,7 @@ an empty string to initialize and update no git submodules. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.16 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst .. note:: @@ -34,4 +34,4 @@ an empty string to initialize and update no git submodules. :command:`FetchContent_Declare` will continue to apply in future CMake releases. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0098.rst b/Help/policy/CMP0098.rst index 42c900b..631cb4e 100644 --- a/Help/policy/CMP0098.rst +++ b/Help/policy/CMP0098.rst @@ -26,6 +26,6 @@ which implicit files are generated unless provided as absolute path. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0099.rst b/Help/policy/CMP0099.rst index 0a2b786..5ea6d94 100644 --- a/Help/policy/CMP0099.rst +++ b/Help/policy/CMP0099.rst @@ -29,6 +29,6 @@ properties. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0100.rst b/Help/policy/CMP0100.rst index c3b782b..359b618 100644 --- a/Help/policy/CMP0100.rst +++ b/Help/policy/CMP0100.rst @@ -36,6 +36,6 @@ in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` just like other header files. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0101.rst b/Help/policy/CMP0101.rst index ceefcda..699a893 100644 --- a/Help/policy/CMP0101.rst +++ b/Help/policy/CMP0101.rst @@ -24,6 +24,6 @@ all cases. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0102.rst b/Help/policy/CMP0102.rst index 8590979..b4d7ca3 100644 --- a/Help/policy/CMP0102.rst +++ b/Help/policy/CMP0102.rst @@ -21,9 +21,9 @@ already exist in the cache. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0102 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0103.rst b/Help/policy/CMP0103.rst index 50bceba..e0740bd 100644 --- a/Help/policy/CMP0103.rst +++ b/Help/policy/CMP0103.rst @@ -18,6 +18,6 @@ The ``NEW`` behavior of this policy is to raise an error on second call to .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.18 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0104.rst b/Help/policy/CMP0104.rst index 9e8d222..4c82969 100644 --- a/Help/policy/CMP0104.rst +++ b/Help/policy/CMP0104.rst @@ -31,9 +31,9 @@ the rare cases where full control over the passed flags is required. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.18 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst Examples ^^^^^^^^ diff --git a/Help/policy/CMP0105.rst b/Help/policy/CMP0105.rst index 8726997..a2a1b5f 100644 --- a/Help/policy/CMP0105.rst +++ b/Help/policy/CMP0105.rst @@ -16,6 +16,6 @@ device link step. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.18 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0106.rst b/Help/policy/CMP0106.rst index 5f7e078..46c1281 100644 --- a/Help/policy/CMP0106.rst +++ b/Help/policy/CMP0106.rst @@ -16,6 +16,6 @@ behavior is to act as an empty module. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.18 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0107.rst b/Help/policy/CMP0107.rst index ece0b23..8332712 100644 --- a/Help/policy/CMP0107.rst +++ b/Help/policy/CMP0107.rst @@ -15,6 +15,6 @@ The ``NEW`` behavior of this policy is to prevent target overwriting. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0108.rst b/Help/policy/CMP0108.rst index fbb72b3..d6ce7e5 100644 --- a/Help/policy/CMP0108.rst +++ b/Help/policy/CMP0108.rst @@ -15,6 +15,6 @@ through an ``ALIAS`` target. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.17 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0109.rst b/Help/policy/CMP0109.rst index 2073d72..a51a3f8 100644 --- a/Help/policy/CMP0109.rst +++ b/Help/policy/CMP0109.rst @@ -19,6 +19,6 @@ execute permission but not read permission. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0110.rst b/Help/policy/CMP0110.rst index ad9e096..a916fb4 100644 --- a/Help/policy/CMP0110.rst +++ b/Help/policy/CMP0110.rst @@ -23,6 +23,6 @@ with whitespace and special characters for tests created by ``add_test``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0111.rst b/Help/policy/CMP0111.rst index 33a925b..2d3322a 100644 --- a/Help/policy/CMP0111.rst +++ b/Help/policy/CMP0111.rst @@ -22,6 +22,6 @@ The ``NEW`` behavior is to raise an error. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0112.rst b/Help/policy/CMP0112.rst index 2b21eaf..8706c31 100644 --- a/Help/policy/CMP0112.rst +++ b/Help/policy/CMP0112.rst @@ -36,10 +36,10 @@ above generator expressions. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0112 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0113.rst b/Help/policy/CMP0113.rst index 1908727..09a0d15 100644 --- a/Help/policy/CMP0113.rst +++ b/Help/policy/CMP0113.rst @@ -38,6 +38,6 @@ custom commands in dependent targets. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0114.rst b/Help/policy/CMP0114.rst index f4ca7ef..f1a59fc 100644 --- a/Help/policy/CMP0114.rst +++ b/Help/policy/CMP0114.rst @@ -81,6 +81,6 @@ by 3.19 and above. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.19 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0115.rst b/Help/policy/CMP0115.rst index b11f97d..867b883 100644 --- a/Help/policy/CMP0115.rst +++ b/Help/policy/CMP0115.rst @@ -29,6 +29,6 @@ to not append known extensions and require them to be explicit. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0116.rst b/Help/policy/CMP0116.rst index b0fc896..14a6e6a 100644 --- a/Help/policy/CMP0116.rst +++ b/Help/policy/CMP0116.rst @@ -36,10 +36,10 @@ before each custom command. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default (unless ``DEPFILE`` is used in a subdirectory) -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0116 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0117.rst b/Help/policy/CMP0117.rst index e1a0ee9..3b945a0 100644 --- a/Help/policy/CMP0117.rst +++ b/Help/policy/CMP0117.rst @@ -37,6 +37,6 @@ the default cache entry. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0118.rst b/Help/policy/CMP0118.rst index 5c04927..9fc1d43 100644 --- a/Help/policy/CMP0118.rst +++ b/Help/policy/CMP0118.rst @@ -33,6 +33,6 @@ for those directories. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns about setting the ``GENERATED`` property to a non-boolean value -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0119.rst b/Help/policy/CMP0119.rst index 78e9894..0050564 100644 --- a/Help/policy/CMP0119.rst +++ b/Help/policy/CMP0119.rst @@ -30,6 +30,6 @@ property using its documented meaning to "compile as a ```` source". .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0120.rst b/Help/policy/CMP0120.rst index bba2291..08573e9 100644 --- a/Help/policy/CMP0120.rst +++ b/Help/policy/CMP0120.rst @@ -40,8 +40,8 @@ behavior is for inclusion of the module to fail as if it does not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.20 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst .. _`Hedley`: https://nemequ.github.io/hedley/ diff --git a/Help/policy/CMP0121.rst b/Help/policy/CMP0121.rst index 6e08cb5..a2e1a95 100644 --- a/Help/policy/CMP0121.rst +++ b/Help/policy/CMP0121.rst @@ -16,6 +16,6 @@ behavior is for invalid indices to trigger an error. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0122.rst b/Help/policy/CMP0122.rst index 0b2da6c..908b4bb 100644 --- a/Help/policy/CMP0122.rst +++ b/Help/policy/CMP0122.rst @@ -11,6 +11,6 @@ that expect the legacy behavior. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0123.rst b/Help/policy/CMP0123.rst index 85f23a4..608efe0 100644 --- a/Help/policy/CMP0123.rst +++ b/Help/policy/CMP0123.rst @@ -27,6 +27,6 @@ setting correct options. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0124.rst b/Help/policy/CMP0124.rst index 2c19cac..a98e4b1 100644 --- a/Help/policy/CMP0124.rst +++ b/Help/policy/CMP0124.rst @@ -44,6 +44,6 @@ Under the ``NEW`` behavior, this code prints only ``var1: value``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0125.rst b/Help/policy/CMP0125.rst index 8c5e23a..9acb696 100644 --- a/Help/policy/CMP0125.rst +++ b/Help/policy/CMP0125.rst @@ -36,6 +36,6 @@ described above. When it is set to ``NEW``, the behavior is as follows: .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0126.rst b/Help/policy/CMP0126.rst index ca40709..83dfb02 100644 --- a/Help/policy/CMP0126.rst +++ b/Help/policy/CMP0126.rst @@ -26,7 +26,7 @@ already exists and :policy:`CMP0077` is set to ``NEW``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.21 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0126 >` @@ -36,4 +36,4 @@ The :variable:`CMAKE_POLICY_DEFAULT_CMP0126 >` variable may be used to set the policy for a third-party project in a subdirectory without modifying it. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0127.rst b/Help/policy/CMP0127.rst index 798140b..a9c838d 100644 --- a/Help/policy/CMP0127.rst +++ b/Help/policy/CMP0127.rst @@ -28,6 +28,6 @@ been updated to expect the new behavior. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.22 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0128.rst b/Help/policy/CMP0128.rst index 7d2c537..6817a71 100644 --- a/Help/policy/CMP0128.rst +++ b/Help/policy/CMP0128.rst @@ -63,10 +63,10 @@ default :variable:`standard _STANDARD_DEFAULT>` and .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.22 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0128 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0129.rst b/Help/policy/CMP0129.rst index 08ef8d1..7664fcd 100644 --- a/Help/policy/CMP0129.rst +++ b/Help/policy/CMP0129.rst @@ -25,10 +25,10 @@ The ``OLD`` behavior for this policy is to use compiler id ``GNU`` (and set .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.23 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0129 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0130.rst b/Help/policy/CMP0130.rst index 79f1ebb..25ccf0a 100644 --- a/Help/policy/CMP0130.rst +++ b/Help/policy/CMP0130.rst @@ -27,6 +27,6 @@ policy is to diagnose errors in :command:`while` conditions. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0131.rst b/Help/policy/CMP0131.rst index 8899943..cead486 100644 --- a/Help/policy/CMP0131.rst +++ b/Help/policy/CMP0131.rst @@ -25,6 +25,6 @@ the guarded content only for link dependencies. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0132.rst b/Help/policy/CMP0132.rst index 11a1212..405c52e 100644 --- a/Help/policy/CMP0132.rst +++ b/Help/policy/CMP0132.rst @@ -22,6 +22,6 @@ policy does not set any such environment variables. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0133.rst b/Help/policy/CMP0133.rst index 3bccd15..bbce7a9 100644 --- a/Help/policy/CMP0133.rst +++ b/Help/policy/CMP0133.rst @@ -23,10 +23,10 @@ The ``NEW`` behavior for this policy is to not enable it by default. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0133 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0134.rst b/Help/policy/CMP0134.rst index 986d58e..ec4d963 100644 --- a/Help/policy/CMP0134.rst +++ b/Help/policy/CMP0134.rst @@ -30,6 +30,6 @@ The ``NEW`` behavior for this policy is to use registry views ``TARGET`` and .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0135.rst b/Help/policy/CMP0135.rst index 09c688d..142302c 100644 --- a/Help/policy/CMP0135.rst +++ b/Help/policy/CMP0135.rst @@ -24,6 +24,6 @@ behavior sets the timestamps of extracted contents to the time of extraction. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0136.rst b/Help/policy/CMP0136.rst index 0980c87..00b9636 100644 --- a/Help/policy/CMP0136.rst +++ b/Help/policy/CMP0136.rst @@ -44,6 +44,6 @@ library flags in the default cache entries and use the abstraction instead. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0137.rst b/Help/policy/CMP0137.rst index 3d879d1..e784fab 100644 --- a/Help/policy/CMP0137.rst +++ b/Help/policy/CMP0137.rst @@ -27,6 +27,6 @@ to suppress passing the platform variables through either signature. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0138.rst b/Help/policy/CMP0138.rst index f933b90..6c98c2b 100644 --- a/Help/policy/CMP0138.rst +++ b/Help/policy/CMP0138.rst @@ -25,6 +25,6 @@ compiler flags in the test project. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0139.rst b/Help/policy/CMP0139.rst index 640055d..115cfbe 100644 --- a/Help/policy/CMP0139.rst +++ b/Help/policy/CMP0139.rst @@ -11,6 +11,6 @@ The ``NEW`` behavior is to interpret the ``PATH_EQUAL`` operator. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.24 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0140.rst b/Help/policy/CMP0140.rst index 4236017..bcb2319 100644 --- a/Help/policy/CMP0140.rst +++ b/Help/policy/CMP0140.rst @@ -11,6 +11,6 @@ The ``NEW`` behavior is to check the validity of the parameters. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.25 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0141.rst b/Help/policy/CMP0141.rst index ac3160c..daaaa3b 100644 --- a/Help/policy/CMP0141.rst +++ b/Help/policy/CMP0141.rst @@ -49,6 +49,6 @@ the abstraction instead. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.25 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0142.rst b/Help/policy/CMP0142.rst index e4b1440..5de544f 100644 --- a/Help/policy/CMP0142.rst +++ b/Help/policy/CMP0142.rst @@ -21,6 +21,6 @@ The ``NEW`` behavior is to not modify library search paths. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.25 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0143.rst b/Help/policy/CMP0143.rst index ce13752..85be4e7 100644 --- a/Help/policy/CMP0143.rst +++ b/Help/policy/CMP0143.rst @@ -26,6 +26,6 @@ differently in IDEs. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.26 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0144.rst b/Help/policy/CMP0144.rst index 81e622a..57c1c3a 100644 --- a/Help/policy/CMP0144.rst +++ b/Help/policy/CMP0144.rst @@ -20,6 +20,6 @@ variables. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0145.rst b/Help/policy/CMP0145.rst index 9b0d43f..1bd6644 100644 --- a/Help/policy/CMP0145.rst +++ b/Help/policy/CMP0145.rst @@ -24,6 +24,6 @@ behavior is for uses of the modules to fail as if they do not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0146.rst b/Help/policy/CMP0146.rst index 7d6ba19..2f24d2b 100644 --- a/Help/policy/CMP0146.rst +++ b/Help/policy/CMP0146.rst @@ -23,6 +23,6 @@ module to fail as if it does not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0147.rst b/Help/policy/CMP0147.rst index 1790678..50baaa5 100644 --- a/Help/policy/CMP0147.rst +++ b/Help/policy/CMP0147.rst @@ -19,6 +19,6 @@ VS 15.8 and newer. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0148.rst b/Help/policy/CMP0148.rst index c522c6a..1436fb7 100644 --- a/Help/policy/CMP0148.rst +++ b/Help/policy/CMP0148.rst @@ -23,6 +23,6 @@ behavior is for uses of the modules to fail as if they do not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0149.rst b/Help/policy/CMP0149.rst index 11e935d..de3f862 100644 --- a/Help/policy/CMP0149.rst +++ b/Help/policy/CMP0149.rst @@ -48,6 +48,6 @@ for this policy is to ignore it. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0150.rst b/Help/policy/CMP0150.rst index e8c58ef..c0be926 100644 --- a/Help/policy/CMP0150.rst +++ b/Help/policy/CMP0150.rst @@ -34,6 +34,6 @@ will be raised. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns when a relative path is encountered -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0151.rst b/Help/policy/CMP0151.rst index 49b0811..0e29f80 100644 --- a/Help/policy/CMP0151.rst +++ b/Help/policy/CMP0151.rst @@ -22,6 +22,6 @@ the target's system include directories. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.27 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0152.rst b/Help/policy/CMP0152.rst index 94109e3..02c7923 100644 --- a/Help/policy/CMP0152.rst +++ b/Help/policy/CMP0152.rst @@ -16,6 +16,6 @@ collapsing ``../`` components. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0153.rst b/Help/policy/CMP0153.rst index 838f082..187107c 100644 --- a/Help/policy/CMP0153.rst +++ b/Help/policy/CMP0153.rst @@ -9,6 +9,6 @@ This command has long been superseded by the :command:`execute_process` command and has been deprecated since CMake 3.0. .. |disallowed_version| replace:: 3.28 -.. include:: DISALLOWED_COMMAND.txt +.. include:: include/DISALLOWED_COMMAND.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0154.rst b/Help/policy/CMP0154.rst index 89a4f67..f3030ec 100644 --- a/Help/policy/CMP0154.rst +++ b/Help/policy/CMP0154.rst @@ -53,6 +53,6 @@ and for :ref:`Ninja Generators` to produce more efficient build graphs. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0155.rst b/Help/policy/CMP0155.rst index 5397c0d..9e8571c 100644 --- a/Help/policy/CMP0155.rst +++ b/Help/policy/CMP0155.rst @@ -22,6 +22,6 @@ understands how to scan for their dependencies, and need to be scanned. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.28 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0156.rst b/Help/policy/CMP0156.rst index 7956742..2258d44 100644 --- a/Help/policy/CMP0156.rst +++ b/Help/policy/CMP0156.rst @@ -46,6 +46,6 @@ is to apply different strategies based on linker capabilities. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0157.rst b/Help/policy/CMP0157.rst index c607203..c8f5ea8 100644 --- a/Help/policy/CMP0157.rst +++ b/Help/policy/CMP0157.rst @@ -42,6 +42,6 @@ target is created by the :variable:`CMAKE_Swift_COMPILATION_MODE` variable. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0158.rst b/Help/policy/CMP0158.rst index 66e5a62..4882e15 100644 --- a/Help/policy/CMP0158.rst +++ b/Help/policy/CMP0158.rst @@ -23,6 +23,6 @@ the :prop_tgt:`CROSSCOMPILING_EMULATOR` target property only when .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0159.rst b/Help/policy/CMP0159.rst index 908ef0f..365fc28 100644 --- a/Help/policy/CMP0159.rst +++ b/Help/policy/CMP0159.rst @@ -18,6 +18,6 @@ variables. The ``NEW`` behavior is to store the capture groups. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0160.rst b/Help/policy/CMP0160.rst index 46318ab..2b12358 100644 --- a/Help/policy/CMP0160.rst +++ b/Help/policy/CMP0160.rst @@ -34,6 +34,6 @@ that are documented as read-only. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0161.rst b/Help/policy/CMP0161.rst index 34bb64c..94e1803 100644 --- a/Help/policy/CMP0161.rst +++ b/Help/policy/CMP0161.rst @@ -28,9 +28,9 @@ The ``NEW`` behavior for this policy is to use a default value of true for .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.29 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst Note that a warning will only be emitted if the :variable:`CPACK_BINARY_PRODUCTBUILD >` variable is set to true and the project is being built for an Apple platform. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0162.rst b/Help/policy/CMP0162.rst index df46d96..26c7b4b 100644 --- a/Help/policy/CMP0162.rst +++ b/Help/policy/CMP0162.rst @@ -42,6 +42,6 @@ controls ``UseDebugLibraries`` generation regardless of this policy. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0163.rst b/Help/policy/CMP0163.rst index 40b3535..c710c8b 100644 --- a/Help/policy/CMP0163.rst +++ b/Help/policy/CMP0163.rst @@ -32,6 +32,6 @@ be set only to boolean values, and may not be turned off once turned on. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0164.rst b/Help/policy/CMP0164.rst index 9702cc2..dd7b8b3 100644 --- a/Help/policy/CMP0164.rst +++ b/Help/policy/CMP0164.rst @@ -26,6 +26,6 @@ to fail. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn about the behavior change -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0165.rst b/Help/policy/CMP0165.rst index 7a79c44..4741f04 100644 --- a/Help/policy/CMP0165.rst +++ b/Help/policy/CMP0165.rst @@ -21,6 +21,6 @@ is to fail with a fatal error in such cases. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0166.rst b/Help/policy/CMP0166.rst index 0534559..fa0c31b 100644 --- a/Help/policy/CMP0166.rst +++ b/Help/policy/CMP0166.rst @@ -35,6 +35,6 @@ dependencies of static libraries. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0167.rst b/Help/policy/CMP0167.rst index 763ef69..2812378 100644 --- a/Help/policy/CMP0167.rst +++ b/Help/policy/CMP0167.rst @@ -23,6 +23,6 @@ load CMake's :module:`FindBoost` module. The ``NEW`` behavior is for .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0168.rst b/Help/policy/CMP0168.rst index ec8ef2a..e39a35c 100644 --- a/Help/policy/CMP0168.rst +++ b/Help/policy/CMP0168.rst @@ -67,6 +67,6 @@ internally-generated files in different locations. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0169.rst b/Help/policy/CMP0169.rst index 38b8dcb..5e8ce90 100644 --- a/Help/policy/CMP0169.rst +++ b/Help/policy/CMP0169.rst @@ -44,6 +44,6 @@ The ``NEW`` behavior halts with a fatal error in such cases. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0170.rst b/Help/policy/CMP0170.rst index 9d7860a..65d47aa 100644 --- a/Help/policy/CMP0170.rst +++ b/Help/policy/CMP0170.rst @@ -25,6 +25,6 @@ would be skipped, but that dependency's source directory doesn't exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.30 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0171.rst b/Help/policy/CMP0171.rst index c364bf4..904af65 100644 --- a/Help/policy/CMP0171.rst +++ b/Help/policy/CMP0171.rst @@ -21,6 +21,6 @@ if a target with the name ``codegen`` is created. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0172.rst b/Help/policy/CMP0172.rst index c316975..bb5718a 100644 --- a/Help/policy/CMP0172.rst +++ b/Help/policy/CMP0172.rst @@ -30,10 +30,10 @@ by default. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst See documentation of the :variable:`CMAKE_POLICY_WARNING_CMP0172 >` variable to control the warning. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0173.rst b/Help/policy/CMP0173.rst index 30de19f..39e1e9f 100644 --- a/Help/policy/CMP0173.rst +++ b/Help/policy/CMP0173.rst @@ -17,6 +17,6 @@ the module. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0174.rst b/Help/policy/CMP0174.rst index 748fdba..3cecc0a 100644 --- a/Help/policy/CMP0174.rst +++ b/Help/policy/CMP0174.rst @@ -32,6 +32,6 @@ given using just ``if(DEFINED _)``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0175.rst b/Help/policy/CMP0175.rst index a71aadf..13ce568 100644 --- a/Help/policy/CMP0175.rst +++ b/Help/policy/CMP0175.rst @@ -35,6 +35,6 @@ following as errors that previously went unreported: .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0176.rst b/Help/policy/CMP0176.rst index 4683174..7acdd8a 100644 --- a/Help/policy/CMP0176.rst +++ b/Help/policy/CMP0176.rst @@ -22,6 +22,6 @@ behavior for this policy is to use ``UTF-8`` as the default ``ENCODING``. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0177.rst b/Help/policy/CMP0177.rst index 3eca9f3..bfe8f7c 100644 --- a/Help/policy/CMP0177.rst +++ b/Help/policy/CMP0177.rst @@ -35,4 +35,4 @@ If it is not set, CMake will warn if it detects a path that would be different if normalized, and uses ``OLD`` behavior. If a destination path contains a generator expression, no such warning will be issued regardless of the value. -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0178.rst b/Help/policy/CMP0178.rst index f6152eb..d4878c4 100644 --- a/Help/policy/CMP0178.rst +++ b/Help/policy/CMP0178.rst @@ -32,6 +32,6 @@ properties, and in values given after ``EXTRA_ARGS`` for .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0179.rst b/Help/policy/CMP0179.rst index 7c9498f..7aa83c5 100644 --- a/Help/policy/CMP0179.rst +++ b/Help/policy/CMP0179.rst @@ -23,6 +23,6 @@ libraries when they are de-duplicated, regardless of the platform. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0180.rst b/Help/policy/CMP0180.rst index f69c0bc..7e42b0f 100644 --- a/Help/policy/CMP0180.rst +++ b/Help/policy/CMP0180.rst @@ -31,6 +31,6 @@ The ``NEW`` behavior for this policy will always set normal variables for .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0181.rst b/Help/policy/CMP0181.rst index 807ab05..88c0527 100644 --- a/Help/policy/CMP0181.rst +++ b/Help/policy/CMP0181.rst @@ -36,6 +36,6 @@ expand the ``LINKER:`` prefix. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0182.rst b/Help/policy/CMP0182.rst index 4cc8603..63f346d 100644 --- a/Help/policy/CMP0182.rst +++ b/Help/policy/CMP0182.rst @@ -26,6 +26,6 @@ archives when :prop_tgt:`AIX_SHARED_LIBRARY_ARCHIVE` is not set. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0183.rst b/Help/policy/CMP0183.rst index 5d1b59d..6804c3b 100644 --- a/Help/policy/CMP0183.rst +++ b/Help/policy/CMP0183.rst @@ -28,6 +28,6 @@ been updated to expect the new behavior. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0184.rst b/Help/policy/CMP0184.rst index 5020829..140aaa3 100644 --- a/Help/policy/CMP0184.rst +++ b/Help/policy/CMP0184.rst @@ -49,6 +49,6 @@ the abstraction instead. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0185.rst b/Help/policy/CMP0185.rst index 2020d21..6efa3e7 100644 --- a/Help/policy/CMP0185.rst +++ b/Help/policy/CMP0185.rst @@ -20,6 +20,6 @@ only ``Ruby_`` variables and not ``RUBY_`` variables. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.0 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0186.rst b/Help/policy/CMP0186.rst index 747bce2..9078a03 100644 --- a/Help/policy/CMP0186.rst +++ b/Help/policy/CMP0186.rst @@ -38,6 +38,6 @@ to match ``^`` at most once, at the start of the input string. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0187.rst b/Help/policy/CMP0187.rst index d833d84..b5664d0 100644 --- a/Help/policy/CMP0187.rst +++ b/Help/policy/CMP0187.rst @@ -28,6 +28,6 @@ The ``NEW`` behavior for this policy is to include it. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0188.rst b/Help/policy/CMP0188.rst index 6b4cb83..98165d1 100644 --- a/Help/policy/CMP0188.rst +++ b/Help/policy/CMP0188.rst @@ -16,6 +16,6 @@ to fail as if the module does not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0189.rst b/Help/policy/CMP0189.rst index c15217c..6f26f2d 100644 --- a/Help/policy/CMP0189.rst +++ b/Help/policy/CMP0189.rst @@ -25,6 +25,6 @@ transitively. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0190.rst b/Help/policy/CMP0190.rst index e46306b..d100649 100644 --- a/Help/policy/CMP0190.rst +++ b/Help/policy/CMP0190.rst @@ -26,6 +26,6 @@ cross-compiling mode and will, potentially, returns a mix of artifacts .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0191.rst b/Help/policy/CMP0191.rst index 42a7270..839bf4a 100644 --- a/Help/policy/CMP0191.rst +++ b/Help/policy/CMP0191.rst @@ -16,6 +16,6 @@ to fail as if the module does not exist. .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/CMP0192.rst b/Help/policy/CMP0192.rst index 04c0330..cd86d6d 100644 --- a/Help/policy/CMP0192.rst +++ b/Help/policy/CMP0192.rst @@ -36,6 +36,6 @@ Subsequent calls of ``include(GNUInstallDirs)`` reuse cached .. |INTRODUCED_IN_CMAKE_VERSION| replace:: 4.1 .. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn -.. include:: STANDARD_ADVICE.txt +.. include:: include/STANDARD_ADVICE.rst -.. include:: DEPRECATED.txt +.. include:: include/DEPRECATED.rst diff --git a/Help/policy/DEPRECATED.txt b/Help/policy/DEPRECATED.txt deleted file mode 100644 index f66de55..0000000 --- a/Help/policy/DEPRECATED.txt +++ /dev/null @@ -1,4 +0,0 @@ -.. note:: - The ``OLD`` behavior of a policy is - :manual:`deprecated by definition ` - and may be removed in a future version of CMake. diff --git a/Help/policy/DISALLOWED_COMMAND.txt b/Help/policy/DISALLOWED_COMMAND.txt deleted file mode 100644 index 506f2bb..0000000 --- a/Help/policy/DISALLOWED_COMMAND.txt +++ /dev/null @@ -1,8 +0,0 @@ -CMake >= |disallowed_version| prefer that this command never be called. -The ``OLD`` behavior for this policy is to allow the command to be called. -The ``NEW`` behavior for this policy is to issue a ``FATAL_ERROR`` when the -command is called. - -.. |INTRODUCED_IN_CMAKE_VERSION| replace:: |disallowed_version| -.. |WARNS_OR_DOES_NOT_WARN| replace:: warns -.. include:: STANDARD_ADVICE.txt diff --git a/Help/policy/REMOVED_COMMAND.txt b/Help/policy/REMOVED_COMMAND.txt deleted file mode 100644 index 1c8c963..0000000 --- a/Help/policy/REMOVED_COMMAND.txt +++ /dev/null @@ -1,8 +0,0 @@ -CMake >= |disallowed_version| prefer that this command never be called. -The ``OLD`` behavior for this policy is to allow the command to be called. -The ``NEW`` behavior for this policy is to issue a ``FATAL_ERROR`` when the -command is called. - -.. |INTRODUCED_IN_CMAKE_VERSION| replace:: |disallowed_version| -.. |WARNED_OR_DID_NOT_WARN| replace:: warned -.. include:: REMOVED_EPILOGUE.txt diff --git a/Help/policy/REMOVED_EPILOGUE.txt b/Help/policy/REMOVED_EPILOGUE.txt deleted file mode 100644 index b7434bc..0000000 --- a/Help/policy/REMOVED_EPILOGUE.txt +++ /dev/null @@ -1,4 +0,0 @@ -This policy was introduced in CMake version |INTRODUCED_IN_CMAKE_VERSION|. -Prior to removal in CMake version |REMOVED_IN_CMAKE_VERSION|, it could be -set by :command:`cmake_policy` or :command:`cmake_minimum_required`. -If it was not set, CMake |WARNED_OR_DID_NOT_WARN|, and used ``OLD`` behavior. diff --git a/Help/policy/REMOVED_PROLOGUE.txt b/Help/policy/REMOVED_PROLOGUE.txt deleted file mode 100644 index 5141b6e..0000000 --- a/Help/policy/REMOVED_PROLOGUE.txt +++ /dev/null @@ -1,5 +0,0 @@ -.. warning:: - The ``OLD`` behavior of this policy was removed - in CMake version |REMOVED_IN_CMAKE_VERSION|. - This policy must be set to ``NEW`` by a call to - :command:`cmake_minimum_required` or :command:`cmake_policy`. diff --git a/Help/policy/STANDARD_ADVICE.txt b/Help/policy/STANDARD_ADVICE.txt deleted file mode 100644 index 925c174..0000000 --- a/Help/policy/STANDARD_ADVICE.txt +++ /dev/null @@ -1,3 +0,0 @@ -This policy was introduced in CMake version |INTRODUCED_IN_CMAKE_VERSION|. -It may be set by :command:`cmake_policy` or :command:`cmake_minimum_required`. -If it is not set, CMake |WARNS_OR_DOES_NOT_WARN|, and uses ``OLD`` behavior. diff --git a/Help/policy/include/DEPRECATED.rst b/Help/policy/include/DEPRECATED.rst new file mode 100644 index 0000000..f66de55 --- /dev/null +++ b/Help/policy/include/DEPRECATED.rst @@ -0,0 +1,4 @@ +.. note:: + The ``OLD`` behavior of a policy is + :manual:`deprecated by definition ` + and may be removed in a future version of CMake. diff --git a/Help/policy/include/DISALLOWED_COMMAND.rst b/Help/policy/include/DISALLOWED_COMMAND.rst new file mode 100644 index 0000000..723054d --- /dev/null +++ b/Help/policy/include/DISALLOWED_COMMAND.rst @@ -0,0 +1,8 @@ +CMake >= |disallowed_version| prefer that this command never be called. +The ``OLD`` behavior for this policy is to allow the command to be called. +The ``NEW`` behavior for this policy is to issue a ``FATAL_ERROR`` when the +command is called. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: |disallowed_version| +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: include/STANDARD_ADVICE.rst diff --git a/Help/policy/include/REMOVED_COMMAND.rst b/Help/policy/include/REMOVED_COMMAND.rst new file mode 100644 index 0000000..dd6184d --- /dev/null +++ b/Help/policy/include/REMOVED_COMMAND.rst @@ -0,0 +1,8 @@ +CMake >= |disallowed_version| prefer that this command never be called. +The ``OLD`` behavior for this policy is to allow the command to be called. +The ``NEW`` behavior for this policy is to issue a ``FATAL_ERROR`` when the +command is called. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: |disallowed_version| +.. |WARNED_OR_DID_NOT_WARN| replace:: warned +.. include:: include/REMOVED_EPILOGUE.rst diff --git a/Help/policy/include/REMOVED_EPILOGUE.rst b/Help/policy/include/REMOVED_EPILOGUE.rst new file mode 100644 index 0000000..b7434bc --- /dev/null +++ b/Help/policy/include/REMOVED_EPILOGUE.rst @@ -0,0 +1,4 @@ +This policy was introduced in CMake version |INTRODUCED_IN_CMAKE_VERSION|. +Prior to removal in CMake version |REMOVED_IN_CMAKE_VERSION|, it could be +set by :command:`cmake_policy` or :command:`cmake_minimum_required`. +If it was not set, CMake |WARNED_OR_DID_NOT_WARN|, and used ``OLD`` behavior. diff --git a/Help/policy/include/REMOVED_PROLOGUE.rst b/Help/policy/include/REMOVED_PROLOGUE.rst new file mode 100644 index 0000000..5141b6e --- /dev/null +++ b/Help/policy/include/REMOVED_PROLOGUE.rst @@ -0,0 +1,5 @@ +.. warning:: + The ``OLD`` behavior of this policy was removed + in CMake version |REMOVED_IN_CMAKE_VERSION|. + This policy must be set to ``NEW`` by a call to + :command:`cmake_minimum_required` or :command:`cmake_policy`. diff --git a/Help/policy/include/STANDARD_ADVICE.rst b/Help/policy/include/STANDARD_ADVICE.rst new file mode 100644 index 0000000..925c174 --- /dev/null +++ b/Help/policy/include/STANDARD_ADVICE.rst @@ -0,0 +1,3 @@ +This policy was introduced in CMake version |INTRODUCED_IN_CMAKE_VERSION|. +It may be set by :command:`cmake_policy` or :command:`cmake_minimum_required`. +If it is not set, CMake |WARNS_OR_DOES_NOT_WARN|, and uses ``OLD`` behavior. diff --git a/Help/prop_dir/COMPILE_DEFINITIONS.rst b/Help/prop_dir/COMPILE_DEFINITIONS.rst index 5a12c1e..fe31cdb 100644 --- a/Help/prop_dir/COMPILE_DEFINITIONS.rst +++ b/Help/prop_dir/COMPILE_DEFINITIONS.rst @@ -22,7 +22,7 @@ by the native build tool. .. versionadded:: 3.26 Any leading ``-D`` on an item will be removed. -.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.rst Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` diff --git a/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst index fd2f941..88ad10e 100644 --- a/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_CUDA_KNOWN_FEATURES.rst @@ -41,4 +41,4 @@ The features known to this version of CMake are: Compiler mode is at least CUDA/C++ 26. -.. include:: CMAKE_LANG_STD_FLAGS.txt +.. include:: include/CMAKE_LANG_STD_FLAGS.rst diff --git a/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst index 177659a..6c1f234 100644 --- a/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.rst @@ -51,7 +51,7 @@ but it does not necessarily imply complete conformance to that standard. Compiler mode is at least C++ 26. -.. include:: CMAKE_LANG_STD_FLAGS.txt +.. include:: include/CMAKE_LANG_STD_FLAGS.rst Low level individual compile features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst index 7aca9e8..ccb452b 100644 --- a/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_C_KNOWN_FEATURES.rst @@ -39,7 +39,7 @@ High level meta features indicating C standard support Compiler mode is at least C 23. -.. include:: CMAKE_LANG_STD_FLAGS.txt +.. include:: include/CMAKE_LANG_STD_FLAGS.rst Low level individual compile features ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst b/Help/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst index 9d13c81..d6d2099 100644 --- a/Help/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst +++ b/Help/prop_gbl/CMAKE_HIP_KNOWN_FEATURES.rst @@ -39,4 +39,4 @@ The features known to this version of CMake are: Compiler mode is at least HIP/C++ 26. -.. include:: CMAKE_LANG_STD_FLAGS.txt +.. include:: include/CMAKE_LANG_STD_FLAGS.rst diff --git a/Help/prop_gbl/CMAKE_LANG_STD_FLAGS.txt b/Help/prop_gbl/CMAKE_LANG_STD_FLAGS.txt deleted file mode 100644 index 0de2d3d..0000000 --- a/Help/prop_gbl/CMAKE_LANG_STD_FLAGS.txt +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - If the compiler's default standard level is at least that - of the requested feature, CMake may omit the ``-std=`` flag. - The flag may still be added if the compiler's default extensions mode - does not match the :prop_tgt:`_EXTENSIONS` target property, - or if the :prop_tgt:`_STANDARD` target property is set. diff --git a/Help/prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst b/Help/prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst new file mode 100644 index 0000000..0de2d3d --- /dev/null +++ b/Help/prop_gbl/include/CMAKE_LANG_STD_FLAGS.rst @@ -0,0 +1,7 @@ +.. note:: + + If the compiler's default standard level is at least that + of the requested feature, CMake may omit the ``-std=`` flag. + The flag may still be added if the compiler's default extensions mode + does not match the :prop_tgt:`_EXTENSIONS` target property, + or if the :prop_tgt:`_STANDARD` target property is set. diff --git a/Help/prop_sf/COMPILE_DEFINITIONS.rst b/Help/prop_sf/COMPILE_DEFINITIONS.rst index d14d637..9af87c9 100644 --- a/Help/prop_sf/COMPILE_DEFINITIONS.rst +++ b/Help/prop_sf/COMPILE_DEFINITIONS.rst @@ -19,7 +19,7 @@ definitions on source files. .. versionadded:: 3.26 Any leading ``-D`` on an item will be removed. -.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.rst Contents of ``COMPILE_DEFINITIONS`` may use :manual:`cmake-generator-expressions(7)` with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst index abb627c..c093c15 100644 --- a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -4,9 +4,9 @@ ARCHIVE_OUTPUT_DIRECTORY .. |XXX| replace:: :ref:`ARCHIVE ` .. |xxx| replace:: archive .. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY` -.. include:: XXX_OUTPUT_DIRECTORY.txt +.. include:: include/XXX_OUTPUT_DIRECTORY.rst .. |IDEM| replace:: in the same directory -.. include:: MACOS_IMPORT_FILES.txt +.. include:: include/MACOS_IMPORT_FILES.rst See also the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_` target property. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst index 1f1c467..5b95a28 100644 --- a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -3,9 +3,9 @@ ARCHIVE_OUTPUT_NAME .. |XXX| replace:: :ref:`ARCHIVE ` .. |xxx| replace:: archive -.. include:: XXX_OUTPUT_NAME.txt +.. include:: include/XXX_OUTPUT_NAME.rst .. |IDEM| replace:: with the same name -.. include:: MACOS_IMPORT_FILES.txt +.. include:: include/MACOS_IMPORT_FILES.rst See also the :prop_tgt:`ARCHIVE_OUTPUT_NAME_` target property. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst index c128a9b..56bf3b4 100644 --- a/Help/prop_tgt/COMPILE_DEFINITIONS.rst +++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -16,7 +16,7 @@ by the native build tool. .. versionadded:: 3.26 Any leading ``-D`` on an item will be removed. -.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.rst Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual diff --git a/Help/prop_tgt/COMPILE_OPTIONS.rst b/Help/prop_tgt/COMPILE_OPTIONS.rst index 8b032ad..1b8d53f 100644 --- a/Help/prop_tgt/COMPILE_OPTIONS.rst +++ b/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -24,4 +24,4 @@ syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. -.. include:: ../command/OPTIONS_SHELL.txt +.. include:: ../command/include/OPTIONS_SHELL.rst diff --git a/Help/prop_tgt/COMPILE_PDB_NAME.rst b/Help/prop_tgt/COMPILE_PDB_NAME.rst index 0649993..1b4657e 100644 --- a/Help/prop_tgt/COMPILE_PDB_NAME.rst +++ b/Help/prop_tgt/COMPILE_PDB_NAME.rst @@ -15,4 +15,4 @@ If not set, the default is unspecified. :manual:`generator expressions `. .. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME` -.. include:: COMPILE_PDB_NOTE.txt +.. include:: include/COMPILE_PDB_NOTE.rst diff --git a/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst b/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst index 4a78f85..f21bdc9 100644 --- a/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst +++ b/Help/prop_tgt/COMPILE_PDB_NAME_CONFIG.rst @@ -14,4 +14,4 @@ This is the configuration-specific version of :prop_tgt:`COMPILE_PDB_NAME`. :manual:`generator expressions `. .. |PDB_XXX| replace:: :prop_tgt:`PDB_NAME_` -.. include:: COMPILE_PDB_NOTE.txt +.. include:: include/COMPILE_PDB_NOTE.rst diff --git a/Help/prop_tgt/COMPILE_PDB_NOTE.txt b/Help/prop_tgt/COMPILE_PDB_NOTE.txt deleted file mode 100644 index 43003d9..0000000 --- a/Help/prop_tgt/COMPILE_PDB_NOTE.txt +++ /dev/null @@ -1,5 +0,0 @@ -.. note:: - The compiler-generated program database files are specified by the - ``/Fd`` compiler flag and are not the same as linker-generated - program database files specified by the ``/pdb`` linker flag. - Use the |PDB_XXX| property to specify the latter. diff --git a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst index 626b5e0..5bfb50b 100644 --- a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY.rst @@ -22,4 +22,4 @@ This property is initialized by the value of the set when a target is created. .. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY` -.. include:: COMPILE_PDB_NOTE.txt +.. include:: include/COMPILE_PDB_NOTE.rst diff --git a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst index 8a870f8..25c7f2e 100644 --- a/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -20,4 +20,4 @@ if it is set when a target is created. :manual:`generator expressions `. .. |PDB_XXX| replace:: :prop_tgt:`PDB_OUTPUT_DIRECTORY_` -.. include:: COMPILE_PDB_NOTE.txt +.. include:: include/COMPILE_PDB_NOTE.rst diff --git a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt b/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt deleted file mode 100644 index a6d7050..0000000 --- a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt +++ /dev/null @@ -1,9 +0,0 @@ -``None`` - Link with ``-cudart=none`` or equivalent flag(s) to use no CUDA - runtime library. -``Shared`` - Link with ``-cudart=shared`` or equivalent flag(s) to use a - dynamically-linked CUDA runtime library. -``Static`` - Link with ``-cudart=static`` or equivalent flag(s) to use a - statically-linked CUDA runtime library. diff --git a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst b/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst index e937fc6..99954e9 100644 --- a/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst +++ b/Help/prop_tgt/CUDA_RUNTIME_LIBRARY.rst @@ -7,7 +7,7 @@ Select the CUDA runtime library for use by compilers targeting the CUDA language The allowed case insensitive values are: -.. include:: CUDA_RUNTIME_LIBRARY-VALUES.txt +.. include:: include/CUDA_RUNTIME_LIBRARY-VALUES.rst Contents of ``CUDA_RUNTIME_LIBRARY`` may use :manual:`generator expressions `. diff --git a/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst b/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst index cf7bc5b..632337a 100644 --- a/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst +++ b/Help/prop_tgt/IMPORTED_CXX_MODULES_COMPILE_OPTIONS.rst @@ -6,4 +6,4 @@ IMPORTED_CXX_MODULES_COMPILE_OPTIONS List of options to pass to the compiler for this ``IMPORTED`` target's C++ modules. -.. include:: ../command/OPTIONS_SHELL.txt +.. include:: ../command/include/OPTIONS_SHELL.rst diff --git a/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt b/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt deleted file mode 100644 index 4188b8d..0000000 --- a/Help/prop_tgt/INTERFACE_BUILD_PROPERTY.txt +++ /dev/null @@ -1,16 +0,0 @@ - -List of public |property_name| requirements for a library. - -Targets may populate this property to publish the |property_name| -required to compile against the headers for the target. The |command_name| -command populates this property with values given to the ``PUBLIC`` and -``INTERFACE`` keywords. Projects may also get and set the property directly. - -When target dependencies are specified using :command:`target_link_libraries`, -CMake will read this property from all target dependencies to determine the -build properties of the consumer. - -Contents of |PROPERTY_INTERFACE_NAME| may use "generator expressions" -with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` -manual for available expressions. See the :manual:`cmake-buildsystem(7)` --manual for more on defining buildsystem properties. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst index 9cc12a1..deda872 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -5,4 +5,4 @@ INTERFACE_COMPILE_DEFINITIONS .. |command_name| replace:: :command:`target_compile_definitions` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_DEFINITIONS`` .. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_DEFINITIONS` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst diff --git a/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst b/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst index 50d6161..2c2a859 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_FEATURES.rst @@ -7,7 +7,7 @@ INTERFACE_COMPILE_FEATURES .. |command_name| replace:: :command:`target_compile_features` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_FEATURES`` .. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_FEATURES` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst See the :manual:`cmake-compile-features(7)` manual for information on compile features and a list of supported compilers. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst index 2af7a99..3d529d0 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -5,4 +5,4 @@ INTERFACE_COMPILE_OPTIONS .. |command_name| replace:: :command:`target_compile_options` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_COMPILE_OPTIONS`` .. |PROPERTY_LINK| replace:: :prop_tgt:`COMPILE_OPTIONS` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst diff --git a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst index 8795c80..b69fed5 100644 --- a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst +++ b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -5,7 +5,7 @@ INTERFACE_INCLUDE_DIRECTORIES .. |command_name| replace:: :command:`target_include_directories` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` .. |PROPERTY_LINK| replace:: :prop_tgt:`INCLUDE_DIRECTORIES` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst Include directories usage requirements commonly differ between the build-tree and the install-tree. The ``BUILD_INTERFACE`` and ``INSTALL_INTERFACE`` @@ -25,4 +25,4 @@ Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_INCLUDE_DIRECTORIES`` -.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.txt +.. include:: /include/INTERFACE_INCLUDE_DIRECTORIES_WARNING.rst diff --git a/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst index 45b3225..845e674 100644 --- a/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst +++ b/Help/prop_tgt/INTERFACE_LINK_DIRECTORIES.rst @@ -7,4 +7,4 @@ INTERFACE_LINK_DIRECTORIES .. |command_name| replace:: :command:`target_link_directories` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_DIRECTORIES`` .. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_DIRECTORIES` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst index 73d273b..a73c22d 100644 --- a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -24,7 +24,7 @@ with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for available expressions. See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. -.. include:: LINK_LIBRARIES_INDIRECTION.txt +.. include:: include/LINK_LIBRARIES_INDIRECTION.rst ``INTERFACE_LINK_LIBRARIES`` adds transitive link dependencies for a target's dependents. In advanced use cases, one may update the @@ -32,10 +32,10 @@ direct link dependencies of a target's dependents by using the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` and :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target properties. -.. include:: ../command/LINK_LIBRARIES_LINKER.txt +.. include:: ../command/include/LINK_LIBRARIES_LINKER.rst Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: ``INTERFACE_LINK_LIBRARIES`` -.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.rst diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst index c87c825..d0a51e5 100644 --- a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.rst @@ -22,7 +22,7 @@ by any dependency's :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE` target property. .. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT`` -.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt +.. include:: include/INTERFACE_LINK_LIBRARIES_DIRECT.rst Direct Link Dependencies as Usage Requirements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt deleted file mode 100644 index 077af42..0000000 --- a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT.txt +++ /dev/null @@ -1,9 +0,0 @@ -The value of |INTERFACE_PROPERTY_LINK_DIRECT| may use -:manual:`generator expressions `. - -.. note:: - - The |INTERFACE_PROPERTY_LINK_DIRECT| target property is intended for - advanced use cases such as injection of static plugins into a consuming - executable. It should not be used as a substitute for organizing - normal calls to :command:`target_link_libraries`. diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst index 2f8f87f..3ed2afb 100644 --- a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE.rst @@ -28,7 +28,7 @@ may still be linked as an indirect link dependency via the :prop_tgt:`INTERFACE_LINK_LIBRARIES` property on other dependencies. .. |INTERFACE_PROPERTY_LINK_DIRECT| replace:: ``INTERFACE_LINK_LIBRARIES_DIRECT_EXCLUDE`` -.. include:: INTERFACE_LINK_LIBRARIES_DIRECT.txt +.. include:: include/INTERFACE_LINK_LIBRARIES_DIRECT.rst See the :prop_tgt:`INTERFACE_LINK_LIBRARIES_DIRECT` target property documentation for more details and examples. diff --git a/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst b/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst index 886adf2..1694da7 100644 --- a/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst +++ b/Help/prop_tgt/INTERFACE_LINK_OPTIONS.rst @@ -7,10 +7,10 @@ INTERFACE_LINK_OPTIONS .. |command_name| replace:: :command:`target_link_options` .. |PROPERTY_INTERFACE_NAME| replace:: ``INTERFACE_LINK_OPTIONS`` .. |PROPERTY_LINK| replace:: :prop_tgt:`LINK_OPTIONS` -.. include:: INTERFACE_BUILD_PROPERTY.txt +.. include:: include/INTERFACE_BUILD_PROPERTY.rst -.. include:: ../command/DEVICE_LINK_OPTIONS.txt +.. include:: ../command/include/DEVICE_LINK_OPTIONS.rst -.. include:: ../command/OPTIONS_SHELL.txt +.. include:: ../command/include/OPTIONS_SHELL.rst -.. include:: ../command/LINK_OPTIONS_LINKER.txt +.. include:: ../command/include/LINK_OPTIONS_LINKER.rst diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst index 9fbe904..b075369 100644 --- a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -4,6 +4,6 @@ LIBRARY_OUTPUT_DIRECTORY .. |XXX| replace:: :ref:`LIBRARY ` .. |xxx| replace:: library .. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY` -.. include:: XXX_OUTPUT_DIRECTORY.txt +.. include:: include/XXX_OUTPUT_DIRECTORY.rst See also the :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY_` target property. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst index 6027f7f..a304357 100644 --- a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -3,6 +3,6 @@ LIBRARY_OUTPUT_NAME .. |XXX| replace:: :ref:`LIBRARY ` .. |xxx| replace:: library -.. include:: XXX_OUTPUT_NAME.txt +.. include:: include/XXX_OUTPUT_NAME.rst See also the :prop_tgt:`LIBRARY_OUTPUT_NAME_` target property. diff --git a/Help/prop_tgt/LINKER_TYPE.rst b/Help/prop_tgt/LINKER_TYPE.rst index 23e1e4c..ce1eaeb 100644 --- a/Help/prop_tgt/LINKER_TYPE.rst +++ b/Help/prop_tgt/LINKER_TYPE.rst @@ -6,7 +6,7 @@ LINKER_TYPE Specify which linker will be used for the link step. The property value may use :manual:`generator expressions `. -.. include:: ../variable/LINKER_PREDEFINED_TYPES.txt +.. include:: ../variable/include/LINKER_PREDEFINED_TYPES.rst This property is not supported on :generator:`Green Hills MULTI` generator. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst index 2dcf45c..1c255b1 100644 --- a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst @@ -28,4 +28,4 @@ Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES`` -.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.rst diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst index 22ee5a6..502616b 100644 --- a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -17,4 +17,4 @@ Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. |INTERFACE_PROPERTY_LINK| replace:: ``LINK_INTERFACE_LIBRARIES_`` -.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.txt +.. include:: /include/INTERFACE_LINK_LIBRARIES_WARNING.rst diff --git a/Help/prop_tgt/LINK_LIBRARIES.rst b/Help/prop_tgt/LINK_LIBRARIES.rst index 8814980..e5aa3c6 100644 --- a/Help/prop_tgt/LINK_LIBRARIES.rst +++ b/Help/prop_tgt/LINK_LIBRARIES.rst @@ -22,7 +22,7 @@ syntax ``$<...>``. Policy :policy:`CMP0131` affects the behavior of the See the :manual:`cmake-buildsystem(7)` manual for more on defining buildsystem properties. -.. include:: LINK_LIBRARIES_INDIRECTION.txt +.. include:: include/LINK_LIBRARIES_INDIRECTION.rst In advanced use cases, the list of direct link dependencies specified by this property may be updated by usage requirements from dependencies. @@ -34,4 +34,4 @@ corresponding :prop_tgt:`LINK_LIBRARIES_STRATEGY` target property for details on how CMake orders direct link dependencies on linker command lines. -.. include:: ../command/LINK_LIBRARIES_LINKER.txt +.. include:: ../command/include/LINK_LIBRARIES_LINKER.rst diff --git a/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt b/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt deleted file mode 100644 index 476e4a6..0000000 --- a/Help/prop_tgt/LINK_LIBRARIES_INDIRECTION.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. note:: - A call to :command:`target_link_libraries( ...)` may update this - property on ````. If ```` was not created in the same - directory as the call then :command:`target_link_libraries` will wrap each - entry with the form ``::@(directory-id);...;::@``, where the ``::@`` is - literal and the ``(directory-id)`` is unspecified. - This tells the generators that the named libraries must be looked up in - the scope of the caller rather than in the scope in which the - ```` was created. Valid directory ids are stripped on export - by the :command:`install(EXPORT)` and :command:`export` commands. diff --git a/Help/prop_tgt/LINK_OPTIONS.rst b/Help/prop_tgt/LINK_OPTIONS.rst index fcdac59..fd14c96 100644 --- a/Help/prop_tgt/LINK_OPTIONS.rst +++ b/Help/prop_tgt/LINK_OPTIONS.rst @@ -29,8 +29,8 @@ for more on defining buildsystem properties. This property must be used in preference to :prop_tgt:`LINK_FLAGS` property. -.. include:: ../command/DEVICE_LINK_OPTIONS.txt +.. include:: ../command/include/DEVICE_LINK_OPTIONS.rst -.. include:: ../command/OPTIONS_SHELL.txt +.. include:: ../command/include/OPTIONS_SHELL.rst -.. include:: ../command/LINK_OPTIONS_LINKER.txt +.. include:: ../command/include/LINK_OPTIONS_LINKER.rst diff --git a/Help/prop_tgt/MACOS_IMPORT_FILES.txt b/Help/prop_tgt/MACOS_IMPORT_FILES.txt deleted file mode 100644 index 3c98fc8..0000000 --- a/Help/prop_tgt/MACOS_IMPORT_FILES.txt +++ /dev/null @@ -1,12 +0,0 @@ -.. note:: - - On macOS, this property will be ignored for the linker import files (e.g. - ``.tbd`` files, see :prop_tgt:`ENABLE_EXPORTS` property for details) when: - - * The :prop_tgt:`FRAMEWORK` is set, because the framework layout cannot be - changed. - * The :generator:`Xcode` generator is used, due to the limitations and - constraints of the ``Xcode`` tool. - - In both cases, the linker import files will be generated |IDEM| as the shared - library. diff --git a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt deleted file mode 100644 index 7f19bc0..0000000 --- a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt +++ /dev/null @@ -1,16 +0,0 @@ -``Embedded`` - Compile with ``-Z7`` or equivalent flag(s) to produce object files - with full symbolic debugging information. -``ProgramDatabase`` - Compile with ``-Zi`` or equivalent flag(s) to produce a program - database that contains all the symbolic debugging information. -``EditAndContinue`` - Compile with ``-ZI`` or equivalent flag(s) to produce a program - database that supports the Edit and Continue feature. - -The value is ignored on compilers not targeting the MSVC ABI, but an -unsupported value will be rejected as an error when using a compiler -targeting the MSVC ABI. - -The value may also be the empty string (``""``), in which case no debug -information format flag will be added explicitly by CMake. diff --git a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst index 94ee20d..7758b2c 100644 --- a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst +++ b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst @@ -7,7 +7,7 @@ Select debug information format when targeting the MSVC ABI. The allowed values are: -.. include:: MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt +.. include:: include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt b/Help/prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt deleted file mode 100644 index 44df3bf..0000000 --- a/Help/prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt +++ /dev/null @@ -1,16 +0,0 @@ -``PossibleDataLoss`` - Compile with ``-RTCc`` or equivalent flag(s) to enable possible - data loss checks. -``StackFrameErrorCheck`` - Compile with ``-RTCs`` or equivalent flag(s) to enable stack frame - error checks. -``UninitializedVariable`` - Compile with ``-RTCu`` or equivalent flag(s) to enable uninitialized - variables checks. - -The value is ignored on compilers not targeting the MSVC ABI, but an -unsupported value will be rejected as an error when using a compiler -targeting the MSVC ABI. - -The value may also be the empty string (``""``), in which case no runtime -error check flags will be added explicitly by CMake. diff --git a/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst b/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst index 72639d5..8b647d4 100644 --- a/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst +++ b/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst @@ -7,7 +7,7 @@ Select the list of enabled runtime checks when targeting the MSVC ABI. The allowed values are: -.. include:: MSVC_RUNTIME_CHECKS-VALUES.txt +.. include:: include/MSVC_RUNTIME_CHECKS-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt b/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt deleted file mode 100644 index 5f8b82d..0000000 --- a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt +++ /dev/null @@ -1,21 +0,0 @@ -``MultiThreaded`` - Compile with ``-MT`` or equivalent flag(s) to use a multi-threaded - statically-linked runtime library. -``MultiThreadedDLL`` - Compile with ``-MD`` or equivalent flag(s) to use a multi-threaded - dynamically-linked runtime library. -``MultiThreadedDebug`` - Compile with ``-MTd`` or equivalent flag(s) to use a multi-threaded - statically-linked runtime library. -``MultiThreadedDebugDLL`` - Compile with ``-MDd`` or equivalent flag(s) to use a multi-threaded - dynamically-linked runtime library. - -The value is ignored on compilers not targeting the MSVC ABI, but an -unsupported value will be rejected as an error when using a compiler -targeting the MSVC ABI. - -The value may also be the empty string (``""``) in which case no runtime -library selection flag will be added explicitly by CMake. Note that with -:ref:`Visual Studio Generators` the native build system may choose to -add its own default runtime library selection flag. diff --git a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst b/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst index 9f13d38..fd92417 100644 --- a/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst +++ b/Help/prop_tgt/MSVC_RUNTIME_LIBRARY.rst @@ -7,7 +7,7 @@ Select the MSVC runtime library for use by compilers targeting the MSVC ABI. The allowed values are: -.. include:: MSVC_RUNTIME_LIBRARY-VALUES.txt +.. include:: include/MSVC_RUNTIME_LIBRARY-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst index e8cb4e6..6d9dfd4 100644 --- a/Help/prop_tgt/PDB_NAME.rst +++ b/Help/prop_tgt/PDB_NAME.rst @@ -14,4 +14,4 @@ logical target name is used by default. :manual:`generator expressions `. .. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME` -.. include:: PDB_NOTE.txt +.. include:: include/PDB_NOTE.rst diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst index 7b1edda..99ebc4c 100644 --- a/Help/prop_tgt/PDB_NAME_CONFIG.rst +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -12,4 +12,4 @@ This is the configuration-specific version of :prop_tgt:`PDB_NAME`. :manual:`generator expressions `. .. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_NAME_` -.. include:: PDB_NOTE.txt +.. include:: include/PDB_NOTE.rst diff --git a/Help/prop_tgt/PDB_NOTE.txt b/Help/prop_tgt/PDB_NOTE.txt deleted file mode 100644 index b5ada07..0000000 --- a/Help/prop_tgt/PDB_NOTE.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. note:: - This property does not apply to STATIC library targets because no linker - is invoked to produce them so they have no linker-generated ``.pdb`` file - containing debug symbols. - - The linker-generated program database files are specified by the - ``/pdb`` linker flag and are not the same as compiler-generated - program database files specified by the ``/Fd`` compiler flag. - Use the |COMPILE_PDB_XXX| property to specify the latter. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst index e39643c..e576fb0 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -20,4 +20,4 @@ This property is initialized by the value of the set when a target is created. .. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` -.. include:: PDB_NOTE.txt +.. include:: include/PDB_NOTE.rst diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst index 064b91d..47a6f95 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -18,4 +18,4 @@ set when a target is created. :manual:`generator expressions `. .. |COMPILE_PDB_XXX| replace:: :prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY_` -.. include:: PDB_NOTE.txt +.. include:: include/PDB_NOTE.rst diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst index 3c37546..8f4e238 100644 --- a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -4,6 +4,6 @@ RUNTIME_OUTPUT_DIRECTORY .. |XXX| replace:: :ref:`RUNTIME ` .. |xxx| replace:: runtime .. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY` -.. include:: XXX_OUTPUT_DIRECTORY.txt +.. include:: include/XXX_OUTPUT_DIRECTORY.rst See also the :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY_` target property. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst index 11729c3..c9caa3d 100644 --- a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -3,6 +3,6 @@ RUNTIME_OUTPUT_NAME .. |XXX| replace:: :ref:`RUNTIME ` .. |xxx| replace:: runtime -.. include:: XXX_OUTPUT_NAME.txt +.. include:: include/XXX_OUTPUT_NAME.rst See also the :prop_tgt:`RUNTIME_OUTPUT_NAME_` target property. diff --git a/Help/prop_tgt/SOVERSION.rst b/Help/prop_tgt/SOVERSION.rst index 4f8b1b5..9f874ad 100644 --- a/Help/prop_tgt/SOVERSION.rst +++ b/Help/prop_tgt/SOVERSION.rst @@ -10,7 +10,7 @@ symlinks and the linker supports so-names. If only one of both is specified the missing is assumed to have the same version number. ``SOVERSION`` is ignored if :prop_tgt:`NO_SONAME` property is set. -.. include:: VERSION_SOVERSION_EXAMPLE.txt +.. include:: include/VERSION_SOVERSION_EXAMPLE.rst Windows Versions ^^^^^^^^^^^^^^^^ diff --git a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst b/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst index 370c75c..2a9c4a9 100644 --- a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst +++ b/Help/prop_tgt/STATIC_LIBRARY_OPTIONS.rst @@ -21,6 +21,6 @@ for more on defining buildsystem properties. This property must be used in preference to :prop_tgt:`STATIC_LIBRARY_FLAGS` property. -.. include:: ../command/OPTIONS_SHELL.txt +.. include:: ../command/include/OPTIONS_SHELL.rst -.. include:: ../prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt +.. include:: ../prop_tgt/include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst diff --git a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt b/Help/prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt deleted file mode 100644 index 16a989a..0000000 --- a/Help/prop_tgt/STATIC_LIBRARY_OPTIONS_ARCHIVER.txt +++ /dev/null @@ -1,23 +0,0 @@ -Handling Archiver Driver Differences -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. versionadded:: 4.0 - -To pass options to the archiver tool, each compiler driver has its own syntax. -The ``ARCHIVER:`` prefix and ``,`` separator can be used to specify, in a portable -way, options to pass to the archiver tool. ``ARCHIVER:`` is replaced by the -appropriate driver option and ``,`` by the appropriate driver separator. -The driver prefix and driver separator are given by the values of the -:variable:`CMAKE__ARCHIVER_WRAPPER_FLAG` and -:variable:`CMAKE__ARCHIVER_WRAPPER_FLAG_SEP` variables. - -The ``ARCHIVER:`` prefix can be specified as part of a ``SHELL:`` prefix -expression. - -The ``ARCHIVER:`` prefix supports, as an alternative syntax, specification of -arguments using the ``SHELL:`` prefix and space as separator. - -.. note:: - - Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the - ``ARCHIVER:`` prefix is not supported. diff --git a/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt b/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt deleted file mode 100644 index b94380a..0000000 --- a/Help/prop_tgt/Swift_COMPILATION_MODE-VALUES.txt +++ /dev/null @@ -1,19 +0,0 @@ -``incremental`` - Compiles each Swift source in the module separately, resulting in better - parallelism in the build. The compiler emits additional information into - the build directory improving rebuild performance when small changes are made - to the source between rebuilds. This is the best option to use while - iterating on changes in a project. - -``wholemodule`` - Whole-module optimizations are slowest to compile, but results in the most - optimized library. The entire context is loaded into once instance of the - compiler, so there is no parallelism across source files in the module. - -``singlefile`` - Compiles each source in a Swift modules separately, resulting in better - parallelism. Unlike the ``incremental`` build mode, no additional information - is emitted by the compiler during the build, so rebuilding after making small - changes to the source file will not run faster. This option should be used - sparingly, preferring ``incremental`` builds, unless working around a compiler - bug. diff --git a/Help/prop_tgt/Swift_COMPILATION_MODE.rst b/Help/prop_tgt/Swift_COMPILATION_MODE.rst index e26474a..955dad0 100644 --- a/Help/prop_tgt/Swift_COMPILATION_MODE.rst +++ b/Help/prop_tgt/Swift_COMPILATION_MODE.rst @@ -7,7 +7,7 @@ Specify how Swift compiles a target. The allowed values are: -.. include:: Swift_COMPILATION_MODE-VALUES.txt +.. include:: include/Swift_COMPILATION_MODE-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/prop_tgt/VERSION.rst b/Help/prop_tgt/VERSION.rst index f9cb020..28ddb5d 100644 --- a/Help/prop_tgt/VERSION.rst +++ b/Help/prop_tgt/VERSION.rst @@ -12,7 +12,7 @@ executables ``VERSION`` can be used to specify the build version. When building or installing appropriate symlinks are created if the platform supports symlinks. -.. include:: VERSION_SOVERSION_EXAMPLE.txt +.. include:: include/VERSION_SOVERSION_EXAMPLE.rst Windows Versions ^^^^^^^^^^^^^^^^ diff --git a/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt b/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt deleted file mode 100644 index ff2a958..0000000 --- a/Help/prop_tgt/VERSION_SOVERSION_EXAMPLE.txt +++ /dev/null @@ -1,9 +0,0 @@ -A common convention is to specify both ``VERSION`` and ``SOVERSION`` -such that ``SOVERSION`` matches the first component of ``VERSION``: - -.. code-block:: cmake - - set_target_properties(mylib PROPERTIES VERSION 1.2.3 SOVERSION 1) - -The idea is that breaking changes to the ABI increment both the -``SOVERSION`` and the major ``VERSION`` number. diff --git a/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt b/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt deleted file mode 100644 index 8d3714e..0000000 --- a/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt +++ /dev/null @@ -1,18 +0,0 @@ -Indicate to :ref:`Visual Studio Generators` what configurations are considered -debug configurations. This controls the ``UseDebugLibraries`` setting in -each configuration of a ``.vcxproj`` file. - -The "Use Debug Libraries" setting in Visual Studio projects, despite its -specific-sounding name, is a general-purpose indicator of what configurations -are considered debug configurations. In standalone projects, this may affect -MSBuild's default selection of MSVC runtime library, optimization flags, -runtime checks, and similar settings. In CMake projects those settings are -typically generated explicitly based on the project's specification, e.g., -the MSVC runtime library is controlled by |MSVC_RUNTIME_LIBRARY|. However, -the ``UseDebugLibraries`` indicator is useful for reference by both humans -and tools, and may also affect the behavior of platform-specific SDKs. - -Set |VS_USE_DEBUG_LIBRARIES| to a true or false value to indicate whether -each configuration is considered a debug configuration. The value may also -be the empty string (``""``) in which case no ``UseDebugLibraries`` will be -added explicitly by CMake, and MSBuild will use its default value, ``false``. diff --git a/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst b/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst index 3d5ada4..f25e2a7 100644 --- a/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst +++ b/Help/prop_tgt/VS_USE_DEBUG_LIBRARIES.rst @@ -6,7 +6,7 @@ VS_USE_DEBUG_LIBRARIES .. |VS_USE_DEBUG_LIBRARIES| replace:: ``VS_USE_DEBUG_LIBRARIES`` .. |MSVC_RUNTIME_LIBRARY| replace:: :prop_tgt:`MSVC_RUNTIME_LIBRARY` -.. include:: VS_USE_DEBUG_LIBRARIES-PURPOSE.txt +.. include:: include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst Use :manual:`generator expressions ` for per-configuration specification. For example, the code: diff --git a/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt b/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt deleted file mode 100644 index cdf99d0..0000000 --- a/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt +++ /dev/null @@ -1,20 +0,0 @@ -``SingleThreaded`` - Compile without additional flags to use a single-threaded - statically-linked runtime library. -``SingleThreadedDLL`` - Compile with ``-br`` or equivalent flag(s) to use a single-threaded - dynamically-linked runtime library. This is not available for Linux - targets. -``MultiThreaded`` - Compile with ``-bm`` or equivalent flag(s) to use a multi-threaded - statically-linked runtime library. -``MultiThreadedDLL`` - Compile with ``-bm -br`` or equivalent flag(s) to use a multi-threaded - dynamically-linked runtime library. This is not available for Linux - targets. - -The value is ignored on non-Watcom compilers but an unsupported value will -be rejected as an error when using a compiler targeting the Watcom ABI. - -The value may also be the empty string (``""``) in which case no runtime -library selection flag will be added explicitly by CMake. diff --git a/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst b/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst index 3752862..4f9b8e9 100644 --- a/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst +++ b/Help/prop_tgt/WATCOM_RUNTIME_LIBRARY.rst @@ -7,7 +7,7 @@ Select the Watcom runtime library for use by compilers targeting the Watcom ABI. The allowed values are: -.. include:: WATCOM_RUNTIME_LIBRARY-VALUES.txt +.. include:: include/WATCOM_RUNTIME_LIBRARY-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. diff --git a/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt deleted file mode 100644 index d38a96e..0000000 --- a/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt +++ /dev/null @@ -1,12 +0,0 @@ -Output directory in which to build |XXX| target files. - -This property specifies the directory into which |xxx| target files -should be built. The property value may use -:manual:`generator expressions `. -Multi-configuration generators (:ref:`Visual Studio `, -:generator:`Xcode`, :generator:`Ninja Multi-Config`) append a -per-configuration subdirectory to the specified directory unless a generator -expression is used. - -This property is initialized by the value of the -|CMAKE_XXX_OUTPUT_DIRECTORY| variable if it is set when a target is created. diff --git a/Help/prop_tgt/XXX_OUTPUT_NAME.txt b/Help/prop_tgt/XXX_OUTPUT_NAME.txt deleted file mode 100644 index 126f391..0000000 --- a/Help/prop_tgt/XXX_OUTPUT_NAME.txt +++ /dev/null @@ -1,5 +0,0 @@ -Output name for |XXX| target files. - -This property specifies the base name for |xxx| target files. It -overrides :prop_tgt:`OUTPUT_NAME` and :prop_tgt:`OUTPUT_NAME_` -properties. diff --git a/Help/prop_tgt/include/COMPILE_PDB_NOTE.rst b/Help/prop_tgt/include/COMPILE_PDB_NOTE.rst new file mode 100644 index 0000000..43003d9 --- /dev/null +++ b/Help/prop_tgt/include/COMPILE_PDB_NOTE.rst @@ -0,0 +1,5 @@ +.. note:: + The compiler-generated program database files are specified by the + ``/Fd`` compiler flag and are not the same as linker-generated + program database files specified by the ``/pdb`` linker flag. + Use the |PDB_XXX| property to specify the latter. diff --git a/Help/prop_tgt/include/CUDA_RUNTIME_LIBRARY-VALUES.rst b/Help/prop_tgt/include/CUDA_RUNTIME_LIBRARY-VALUES.rst new file mode 100644 index 0000000..a6d7050 --- /dev/null +++ b/Help/prop_tgt/include/CUDA_RUNTIME_LIBRARY-VALUES.rst @@ -0,0 +1,9 @@ +``None`` + Link with ``-cudart=none`` or equivalent flag(s) to use no CUDA + runtime library. +``Shared`` + Link with ``-cudart=shared`` or equivalent flag(s) to use a + dynamically-linked CUDA runtime library. +``Static`` + Link with ``-cudart=static`` or equivalent flag(s) to use a + statically-linked CUDA runtime library. diff --git a/Help/prop_tgt/include/INTERFACE_BUILD_PROPERTY.rst b/Help/prop_tgt/include/INTERFACE_BUILD_PROPERTY.rst new file mode 100644 index 0000000..4188b8d --- /dev/null +++ b/Help/prop_tgt/include/INTERFACE_BUILD_PROPERTY.rst @@ -0,0 +1,16 @@ + +List of public |property_name| requirements for a library. + +Targets may populate this property to publish the |property_name| +required to compile against the headers for the target. The |command_name| +command populates this property with values given to the ``PUBLIC`` and +``INTERFACE`` keywords. Projects may also get and set the property directly. + +When target dependencies are specified using :command:`target_link_libraries`, +CMake will read this property from all target dependencies to determine the +build properties of the consumer. + +Contents of |PROPERTY_INTERFACE_NAME| may use "generator expressions" +with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` +manual for available expressions. See the :manual:`cmake-buildsystem(7)` +-manual for more on defining buildsystem properties. diff --git a/Help/prop_tgt/include/INTERFACE_LINK_LIBRARIES_DIRECT.rst b/Help/prop_tgt/include/INTERFACE_LINK_LIBRARIES_DIRECT.rst new file mode 100644 index 0000000..077af42 --- /dev/null +++ b/Help/prop_tgt/include/INTERFACE_LINK_LIBRARIES_DIRECT.rst @@ -0,0 +1,9 @@ +The value of |INTERFACE_PROPERTY_LINK_DIRECT| may use +:manual:`generator expressions `. + +.. note:: + + The |INTERFACE_PROPERTY_LINK_DIRECT| target property is intended for + advanced use cases such as injection of static plugins into a consuming + executable. It should not be used as a substitute for organizing + normal calls to :command:`target_link_libraries`. diff --git a/Help/prop_tgt/include/LINK_LIBRARIES_INDIRECTION.rst b/Help/prop_tgt/include/LINK_LIBRARIES_INDIRECTION.rst new file mode 100644 index 0000000..476e4a6 --- /dev/null +++ b/Help/prop_tgt/include/LINK_LIBRARIES_INDIRECTION.rst @@ -0,0 +1,10 @@ +.. note:: + A call to :command:`target_link_libraries( ...)` may update this + property on ````. If ```` was not created in the same + directory as the call then :command:`target_link_libraries` will wrap each + entry with the form ``::@(directory-id);...;::@``, where the ``::@`` is + literal and the ``(directory-id)`` is unspecified. + This tells the generators that the named libraries must be looked up in + the scope of the caller rather than in the scope in which the + ```` was created. Valid directory ids are stripped on export + by the :command:`install(EXPORT)` and :command:`export` commands. diff --git a/Help/prop_tgt/include/MACOS_IMPORT_FILES.rst b/Help/prop_tgt/include/MACOS_IMPORT_FILES.rst new file mode 100644 index 0000000..3c98fc8 --- /dev/null +++ b/Help/prop_tgt/include/MACOS_IMPORT_FILES.rst @@ -0,0 +1,12 @@ +.. note:: + + On macOS, this property will be ignored for the linker import files (e.g. + ``.tbd`` files, see :prop_tgt:`ENABLE_EXPORTS` property for details) when: + + * The :prop_tgt:`FRAMEWORK` is set, because the framework layout cannot be + changed. + * The :generator:`Xcode` generator is used, due to the limitations and + constraints of the ``Xcode`` tool. + + In both cases, the linker import files will be generated |IDEM| as the shared + library. diff --git a/Help/prop_tgt/include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst b/Help/prop_tgt/include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst new file mode 100644 index 0000000..7f19bc0 --- /dev/null +++ b/Help/prop_tgt/include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst @@ -0,0 +1,16 @@ +``Embedded`` + Compile with ``-Z7`` or equivalent flag(s) to produce object files + with full symbolic debugging information. +``ProgramDatabase`` + Compile with ``-Zi`` or equivalent flag(s) to produce a program + database that contains all the symbolic debugging information. +``EditAndContinue`` + Compile with ``-ZI`` or equivalent flag(s) to produce a program + database that supports the Edit and Continue feature. + +The value is ignored on compilers not targeting the MSVC ABI, but an +unsupported value will be rejected as an error when using a compiler +targeting the MSVC ABI. + +The value may also be the empty string (``""``), in which case no debug +information format flag will be added explicitly by CMake. diff --git a/Help/prop_tgt/include/MSVC_RUNTIME_CHECKS-VALUES.rst b/Help/prop_tgt/include/MSVC_RUNTIME_CHECKS-VALUES.rst new file mode 100644 index 0000000..44df3bf --- /dev/null +++ b/Help/prop_tgt/include/MSVC_RUNTIME_CHECKS-VALUES.rst @@ -0,0 +1,16 @@ +``PossibleDataLoss`` + Compile with ``-RTCc`` or equivalent flag(s) to enable possible + data loss checks. +``StackFrameErrorCheck`` + Compile with ``-RTCs`` or equivalent flag(s) to enable stack frame + error checks. +``UninitializedVariable`` + Compile with ``-RTCu`` or equivalent flag(s) to enable uninitialized + variables checks. + +The value is ignored on compilers not targeting the MSVC ABI, but an +unsupported value will be rejected as an error when using a compiler +targeting the MSVC ABI. + +The value may also be the empty string (``""``), in which case no runtime +error check flags will be added explicitly by CMake. diff --git a/Help/prop_tgt/include/MSVC_RUNTIME_LIBRARY-VALUES.rst b/Help/prop_tgt/include/MSVC_RUNTIME_LIBRARY-VALUES.rst new file mode 100644 index 0000000..5f8b82d --- /dev/null +++ b/Help/prop_tgt/include/MSVC_RUNTIME_LIBRARY-VALUES.rst @@ -0,0 +1,21 @@ +``MultiThreaded`` + Compile with ``-MT`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDLL`` + Compile with ``-MD`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. +``MultiThreadedDebug`` + Compile with ``-MTd`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDebugDLL`` + Compile with ``-MDd`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. + +The value is ignored on compilers not targeting the MSVC ABI, but an +unsupported value will be rejected as an error when using a compiler +targeting the MSVC ABI. + +The value may also be the empty string (``""``) in which case no runtime +library selection flag will be added explicitly by CMake. Note that with +:ref:`Visual Studio Generators` the native build system may choose to +add its own default runtime library selection flag. diff --git a/Help/prop_tgt/include/PDB_NOTE.rst b/Help/prop_tgt/include/PDB_NOTE.rst new file mode 100644 index 0000000..b5ada07 --- /dev/null +++ b/Help/prop_tgt/include/PDB_NOTE.rst @@ -0,0 +1,9 @@ +.. note:: + This property does not apply to STATIC library targets because no linker + is invoked to produce them so they have no linker-generated ``.pdb`` file + containing debug symbols. + + The linker-generated program database files are specified by the + ``/pdb`` linker flag and are not the same as compiler-generated + program database files specified by the ``/Fd`` compiler flag. + Use the |COMPILE_PDB_XXX| property to specify the latter. diff --git a/Help/prop_tgt/include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst b/Help/prop_tgt/include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst new file mode 100644 index 0000000..16a989a --- /dev/null +++ b/Help/prop_tgt/include/STATIC_LIBRARY_OPTIONS_ARCHIVER.rst @@ -0,0 +1,23 @@ +Handling Archiver Driver Differences +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 4.0 + +To pass options to the archiver tool, each compiler driver has its own syntax. +The ``ARCHIVER:`` prefix and ``,`` separator can be used to specify, in a portable +way, options to pass to the archiver tool. ``ARCHIVER:`` is replaced by the +appropriate driver option and ``,`` by the appropriate driver separator. +The driver prefix and driver separator are given by the values of the +:variable:`CMAKE__ARCHIVER_WRAPPER_FLAG` and +:variable:`CMAKE__ARCHIVER_WRAPPER_FLAG_SEP` variables. + +The ``ARCHIVER:`` prefix can be specified as part of a ``SHELL:`` prefix +expression. + +The ``ARCHIVER:`` prefix supports, as an alternative syntax, specification of +arguments using the ``SHELL:`` prefix and space as separator. + +.. note:: + + Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the + ``ARCHIVER:`` prefix is not supported. diff --git a/Help/prop_tgt/include/Swift_COMPILATION_MODE-VALUES.rst b/Help/prop_tgt/include/Swift_COMPILATION_MODE-VALUES.rst new file mode 100644 index 0000000..b94380a --- /dev/null +++ b/Help/prop_tgt/include/Swift_COMPILATION_MODE-VALUES.rst @@ -0,0 +1,19 @@ +``incremental`` + Compiles each Swift source in the module separately, resulting in better + parallelism in the build. The compiler emits additional information into + the build directory improving rebuild performance when small changes are made + to the source between rebuilds. This is the best option to use while + iterating on changes in a project. + +``wholemodule`` + Whole-module optimizations are slowest to compile, but results in the most + optimized library. The entire context is loaded into once instance of the + compiler, so there is no parallelism across source files in the module. + +``singlefile`` + Compiles each source in a Swift modules separately, resulting in better + parallelism. Unlike the ``incremental`` build mode, no additional information + is emitted by the compiler during the build, so rebuilding after making small + changes to the source file will not run faster. This option should be used + sparingly, preferring ``incremental`` builds, unless working around a compiler + bug. diff --git a/Help/prop_tgt/include/VERSION_SOVERSION_EXAMPLE.rst b/Help/prop_tgt/include/VERSION_SOVERSION_EXAMPLE.rst new file mode 100644 index 0000000..ff2a958 --- /dev/null +++ b/Help/prop_tgt/include/VERSION_SOVERSION_EXAMPLE.rst @@ -0,0 +1,9 @@ +A common convention is to specify both ``VERSION`` and ``SOVERSION`` +such that ``SOVERSION`` matches the first component of ``VERSION``: + +.. code-block:: cmake + + set_target_properties(mylib PROPERTIES VERSION 1.2.3 SOVERSION 1) + +The idea is that breaking changes to the ABI increment both the +``SOVERSION`` and the major ``VERSION`` number. diff --git a/Help/prop_tgt/include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst b/Help/prop_tgt/include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst new file mode 100644 index 0000000..8d3714e --- /dev/null +++ b/Help/prop_tgt/include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst @@ -0,0 +1,18 @@ +Indicate to :ref:`Visual Studio Generators` what configurations are considered +debug configurations. This controls the ``UseDebugLibraries`` setting in +each configuration of a ``.vcxproj`` file. + +The "Use Debug Libraries" setting in Visual Studio projects, despite its +specific-sounding name, is a general-purpose indicator of what configurations +are considered debug configurations. In standalone projects, this may affect +MSBuild's default selection of MSVC runtime library, optimization flags, +runtime checks, and similar settings. In CMake projects those settings are +typically generated explicitly based on the project's specification, e.g., +the MSVC runtime library is controlled by |MSVC_RUNTIME_LIBRARY|. However, +the ``UseDebugLibraries`` indicator is useful for reference by both humans +and tools, and may also affect the behavior of platform-specific SDKs. + +Set |VS_USE_DEBUG_LIBRARIES| to a true or false value to indicate whether +each configuration is considered a debug configuration. The value may also +be the empty string (``""``) in which case no ``UseDebugLibraries`` will be +added explicitly by CMake, and MSBuild will use its default value, ``false``. diff --git a/Help/prop_tgt/include/WATCOM_RUNTIME_LIBRARY-VALUES.rst b/Help/prop_tgt/include/WATCOM_RUNTIME_LIBRARY-VALUES.rst new file mode 100644 index 0000000..cdf99d0 --- /dev/null +++ b/Help/prop_tgt/include/WATCOM_RUNTIME_LIBRARY-VALUES.rst @@ -0,0 +1,20 @@ +``SingleThreaded`` + Compile without additional flags to use a single-threaded + statically-linked runtime library. +``SingleThreadedDLL`` + Compile with ``-br`` or equivalent flag(s) to use a single-threaded + dynamically-linked runtime library. This is not available for Linux + targets. +``MultiThreaded`` + Compile with ``-bm`` or equivalent flag(s) to use a multi-threaded + statically-linked runtime library. +``MultiThreadedDLL`` + Compile with ``-bm -br`` or equivalent flag(s) to use a multi-threaded + dynamically-linked runtime library. This is not available for Linux + targets. + +The value is ignored on non-Watcom compilers but an unsupported value will +be rejected as an error when using a compiler targeting the Watcom ABI. + +The value may also be the empty string (``""``) in which case no runtime +library selection flag will be added explicitly by CMake. diff --git a/Help/prop_tgt/include/XXX_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/include/XXX_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..d38a96e --- /dev/null +++ b/Help/prop_tgt/include/XXX_OUTPUT_DIRECTORY.rst @@ -0,0 +1,12 @@ +Output directory in which to build |XXX| target files. + +This property specifies the directory into which |xxx| target files +should be built. The property value may use +:manual:`generator expressions `. +Multi-configuration generators (:ref:`Visual Studio `, +:generator:`Xcode`, :generator:`Ninja Multi-Config`) append a +per-configuration subdirectory to the specified directory unless a generator +expression is used. + +This property is initialized by the value of the +|CMAKE_XXX_OUTPUT_DIRECTORY| variable if it is set when a target is created. diff --git a/Help/prop_tgt/include/XXX_OUTPUT_NAME.rst b/Help/prop_tgt/include/XXX_OUTPUT_NAME.rst new file mode 100644 index 0000000..126f391 --- /dev/null +++ b/Help/prop_tgt/include/XXX_OUTPUT_NAME.rst @@ -0,0 +1,5 @@ +Output name for |XXX| target files. + +This property specifies the base name for |xxx| target files. It +overrides :prop_tgt:`OUTPUT_NAME` and :prop_tgt:`OUTPUT_NAME_` +properties. diff --git a/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst b/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst index 69b9d93..e2336ed 100644 --- a/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst +++ b/Help/variable/CMAKE_CUDA_RUNTIME_LIBRARY.rst @@ -9,7 +9,7 @@ property on all targets as they are created. The allowed case insensitive values are: -.. include:: ../prop_tgt/CUDA_RUNTIME_LIBRARY-VALUES.txt +.. include:: ../prop_tgt/include/CUDA_RUNTIME_LIBRARY-VALUES.rst Contents of ``CMAKE_CUDA_RUNTIME_LIBRARY`` may use :manual:`generator expressions `. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst index a978d11..0bb08ce 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst @@ -5,4 +5,4 @@ Linker flags to be used to create executables. These flags will be used by the linker when creating an executable. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst index 1d74077..30aad20 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst @@ -6,4 +6,4 @@ Flags to be used when linking an executable. Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating executables. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE.rst b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE.rst index df1af5a..2c42ac6 100644 --- a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE.rst +++ b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE.rst @@ -3,4 +3,4 @@ CMAKE_FIND_ROOT_PATH_MODE_INCLUDE .. |FIND_XXX| replace:: :command:`find_file` and :command:`find_path` -.. include:: CMAKE_FIND_ROOT_PATH_MODE_XXX.txt +.. include:: include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst diff --git a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY.rst b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY.rst index 52ab89d..a2b64ee 100644 --- a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY.rst +++ b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY.rst @@ -3,4 +3,4 @@ CMAKE_FIND_ROOT_PATH_MODE_LIBRARY .. |FIND_XXX| replace:: :command:`find_library` -.. include:: CMAKE_FIND_ROOT_PATH_MODE_XXX.txt +.. include:: include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst diff --git a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.rst b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.rst index 3872947..13dc457 100644 --- a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.rst +++ b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.rst @@ -3,4 +3,4 @@ CMAKE_FIND_ROOT_PATH_MODE_PACKAGE .. |FIND_XXX| replace:: :command:`find_package` -.. include:: CMAKE_FIND_ROOT_PATH_MODE_XXX.txt +.. include:: include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst diff --git a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM.rst b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM.rst index d24a78a..4f4e12d 100644 --- a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM.rst +++ b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM.rst @@ -3,4 +3,4 @@ CMAKE_FIND_ROOT_PATH_MODE_PROGRAM .. |FIND_XXX| replace:: :command:`find_program` -.. include:: CMAKE_FIND_ROOT_PATH_MODE_XXX.txt +.. include:: include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst diff --git a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_XXX.txt b/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_XXX.txt deleted file mode 100644 index ab65e09..0000000 --- a/Help/variable/CMAKE_FIND_ROOT_PATH_MODE_XXX.txt +++ /dev/null @@ -1,8 +0,0 @@ -This variable controls whether the :variable:`CMAKE_FIND_ROOT_PATH` and -:variable:`CMAKE_SYSROOT` are used by |FIND_XXX|. - -If set to ``ONLY``, then only the roots in :variable:`CMAKE_FIND_ROOT_PATH` -will be searched. If set to ``NEVER``, then the roots in -:variable:`CMAKE_FIND_ROOT_PATH` will be ignored and only the host system -root will be used. If set to ``BOTH``, then the host system paths and the -paths in :variable:`CMAKE_FIND_ROOT_PATH` will be searched. diff --git a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst index 4317622..885fad6 100644 --- a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst +++ b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst @@ -44,7 +44,7 @@ Supported pairs are: Specify the 4-component VS Build Version, a.k.a. Build Number. - .. include:: CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt + .. include:: include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst .. versionadded:: 3.23 diff --git a/Help/variable/CMAKE_IGNORE_PATH.rst b/Help/variable/CMAKE_IGNORE_PATH.rst index 4b2bd8a..1d041e1 100644 --- a/Help/variable/CMAKE_IGNORE_PATH.rst +++ b/Help/variable/CMAKE_IGNORE_PATH.rst @@ -4,9 +4,9 @@ CMAKE_IGNORE_PATH .. |CMAKE_IGNORE_VAR| replace:: ``CMAKE_IGNORE_PATH`` .. |CMAKE_IGNORE_PREFIX_VAR| replace:: :variable:`CMAKE_IGNORE_PREFIX_PATH` -.. include:: IGNORE_SEARCH_PATH.txt -.. include:: IGNORE_SEARCH_LOCATIONS.txt -.. include:: IGNORE_SEARCH_NONSYSTEM.txt +.. include:: include/IGNORE_SEARCH_PATH.rst +.. include:: include/IGNORE_SEARCH_LOCATIONS.rst +.. include:: include/IGNORE_SEARCH_NONSYSTEM.rst See also the following variables: diff --git a/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst b/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst index b81cc57..c55e9c6 100644 --- a/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst @@ -6,9 +6,9 @@ CMAKE_IGNORE_PREFIX_PATH .. |CMAKE_IGNORE_VAR| replace:: ``CMAKE_IGNORE_PREFIX_PATH`` .. |CMAKE_IGNORE_NONPREFIX_VAR| replace:: :variable:`CMAKE_IGNORE_PATH` -.. include:: IGNORE_SEARCH_PREFIX.txt -.. include:: IGNORE_SEARCH_LOCATIONS.txt -.. include:: IGNORE_SEARCH_NONSYSTEM.txt +.. include:: include/IGNORE_SEARCH_PREFIX.rst +.. include:: include/IGNORE_SEARCH_LOCATIONS.rst +.. include:: include/IGNORE_SEARCH_NONSYSTEM.rst See also the following variables: diff --git a/Help/variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE.rst b/Help/variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE.rst index 7c929d0..9ddf6ea 100644 --- a/Help/variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE.rst +++ b/Help/variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE.rst @@ -13,4 +13,4 @@ must be set to true. The :variable:`CMAKE_LINK_GROUP_USING_` variable should be defined instead for features that are independent of the link language. -.. include:: CMAKE_LINK_GROUP_USING_FEATURE.txt +.. include:: include/CMAKE_LINK_GROUP_USING_FEATURE.rst diff --git a/Help/variable/CMAKE_LANG_LINK_LIBRARY_USING_FEATURE.rst b/Help/variable/CMAKE_LANG_LINK_LIBRARY_USING_FEATURE.rst index 39fcff8..505f740 100644 --- a/Help/variable/CMAKE_LANG_LINK_LIBRARY_USING_FEATURE.rst +++ b/Help/variable/CMAKE_LANG_LINK_LIBRARY_USING_FEATURE.rst @@ -13,4 +13,4 @@ must be set to true. The :variable:`CMAKE_LINK_LIBRARY_USING_` variable should be defined instead for features that are independent of the link language. -.. include:: CMAKE_LINK_LIBRARY_USING_FEATURE.txt +.. include:: include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst diff --git a/Help/variable/CMAKE_LINKER_TYPE.rst b/Help/variable/CMAKE_LINKER_TYPE.rst index e2989ec..2697acd 100644 --- a/Help/variable/CMAKE_LINKER_TYPE.rst +++ b/Help/variable/CMAKE_LINKER_TYPE.rst @@ -11,4 +11,4 @@ on each target created by a call to :command:`add_library` or link step. If set, its value is also used by the :command:`try_compile` command. -.. include:: LINKER_PREDEFINED_TYPES.txt +.. include:: include/LINKER_PREDEFINED_TYPES.rst diff --git a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst b/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst index 90b7f8b..5cbe5ec 100644 --- a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst +++ b/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst @@ -19,4 +19,4 @@ effect: The :variable:`CMAKE__LINK_GROUP_USING_` variable should be defined instead for features that are dependent on the link language. -.. include:: CMAKE_LINK_GROUP_USING_FEATURE.txt +.. include:: include/CMAKE_LINK_GROUP_USING_FEATURE.rst diff --git a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.txt b/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.txt deleted file mode 100644 index 23ea157..0000000 --- a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.txt +++ /dev/null @@ -1,78 +0,0 @@ -Feature names are case-sensitive and may only contain letters, numbers -and underscores. Feature names defined in all uppercase are reserved for -CMake's own built-in features (see `Predefined Features`_ further below). - - -Feature Definitions -^^^^^^^^^^^^^^^^^^^ - -A group feature definition is a list that contains exactly two elements: - -:: - - - -On the linker command line, ```` will precede the list of libraries -in the group and ```` will follow after. - -For the elements of this variable, the ``LINKER:`` prefix can be used. - -.. include:: ../command/LINK_OPTIONS_LINKER.txt - :start-line: 3 - -Examples -^^^^^^^^ - -Solving cross-references between two static libraries -""""""""""""""""""""""""""""""""""""""""""""""""""""" - -A project may define two or more static libraries which have circular -dependencies between them. In order for the linker to resolve all symbols -at link time, it may need to search repeatedly among the libraries until no -new undefined references are created. Different linkers use different syntax -for achieving this. The following example shows how this may be implemented -for some linkers. Note that this is for illustration purposes only. -Projects should use the built-in ``RESCAN`` group feature instead -(see `Predefined Features`_), which provides a more complete and more robust -implementation of this functionality. - -.. code-block:: cmake - - set(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED TRUE) - if(CMAKE_C_COMPILER_ID STREQUAL "GNU" AND CMAKE_SYSTEM_NAME STREQUAL "Linux") - set(CMAKE_C_LINK_GROUP_USING_cross_refs - "LINKER:--start-group" - "LINKER:--end-group" - ) - elseif(CMAKE_C_COMPILER_ID STREQUAL "SunPro" AND CMAKE_SYSTEM_NAME STREQUAL "SunOS") - set(CMAKE_C_LINK_GROUP_USING_cross_refs - "LINKER:-z,rescan-start" - "LINKER:-z,rescan-end" - ) - else() - # feature not yet supported for the other environments - set(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED FALSE) - endif() - - add_library(lib1 STATIC ...) - add_library(lib2 SHARED ...) - - if(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED) - target_link_libraries(lib2 PRIVATE "$") - else() - target_link_libraries(lib2 PRIVATE lib1 external) - endif() - -CMake will generate the following linker command line fragments when linking -``lib2``: - -* ``GNU``: ``-Wl,--start-group /path/to/lib1.a -lexternal -Wl,--end-group`` -* ``SunPro``: ``-Wl,-z,rescan-start /path/to/lib1.a -lexternal -Wl,-z,rescan-end`` - - -Predefined Features -^^^^^^^^^^^^^^^^^^^ - -The following built-in group features are pre-defined by CMake: - -.. include:: LINK_GROUP_PREDEFINED_FEATURES.txt diff --git a/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.rst b/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.rst index c652733..30877c2 100644 --- a/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.rst +++ b/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.rst @@ -16,4 +16,4 @@ effect: cannot be true for the link language used by the target for which the :genex:`LINK_LIBRARY` generator expression is evaluated. -.. include:: CMAKE_LINK_LIBRARY_USING_FEATURE.txt +.. include:: include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst diff --git a/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.txt b/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.txt deleted file mode 100644 index f5c19e0..0000000 --- a/Help/variable/CMAKE_LINK_LIBRARY_USING_FEATURE.txt +++ /dev/null @@ -1,153 +0,0 @@ -Feature names are case-sensitive and may only contain letters, numbers -and underscores. Feature names defined in all uppercase are reserved for -CMake's own built-in features (see `Predefined Features`_ further below). - -Some aspects of feature behavior can be defined by the -:variable:`CMAKE__LINK_LIBRARY__ATTRIBUTES` and -:variable:`CMAKE_LINK_LIBRARY__ATTRIBUTES` variables. - -Feature Definitions -^^^^^^^^^^^^^^^^^^^ - -A library feature definition is a list that contains one or three elements: - -:: - - [] [] - -When ```` and ```` are specified, they precede and follow -respectively the whole list of libraries specified in the -:genex:`LINK_LIBRARY` expression, not each library item individually. -There is no guarantee that the list of specified libraries will be kept -grouped together though, so the ```` and ```` may appear -more than once if the library list is reorganized by CMake to satisfy other -constraints. This means constructs like ``--start-group`` and ``--end-group``, -as supported by the GNU ``ld`` linker, cannot be used in this way. The -:genex:`LINK_GROUP` generator expression should be used instead for such -constructs. - -```` is used to specify the pattern for constructing the -corresponding fragment on the linker command line for each library. -The following placeholders can be used in the expression: - -* ```` is expanded to the full path to the library for CMake targets, - or to a platform-specific value based on the item otherwise (the same as - ```` on Windows, or the library base name for other platforms). -* ```` is expanded to how the library would normally be linked on - the linker command line. -* ```` is expanded to the full path to the library for CMake targets, - or the item itself exactly as specified in the ```` - otherwise. - -In addition to the above, it is possible to have one pattern for paths -(CMake targets and external libraries specified with file paths) and another -for other items specified by name only. The ``PATH{}`` and ``NAME{}`` wrappers -can be used to provide the expansion for those two cases, respectively. -When wrappers are used, both must be present. For example: - -.. code-block:: cmake - - set(CMAKE_LINK_LIBRARY_USING_weak_library - "PATH{-weak_library }NAME{LINKER:-weak-l}" - ) - -For all three elements of this variable (````, ````, -and ````), the ``LINKER:`` prefix can be used. - -.. include:: ../command/LINK_OPTIONS_LINKER.txt - :start-line: 3 - -Examples -^^^^^^^^ - -Loading a whole static library -"""""""""""""""""""""""""""""" - -A common need is to prevent the linker from discarding any symbols from a -static library. Different linkers use different syntax for achieving this. -The following example shows how this may be implemented for some linkers. -Note that this is for illustration purposes only. Projects should use the -built-in ``WHOLE_ARCHIVE`` feature instead (see `Predefined Features`_), which -provides a more complete and more robust implementation of this functionality. - -.. code-block:: cmake - - set(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED TRUE) - if(CMAKE_C_COMPILER_ID STREQUAL "AppleClang") - set(CMAKE_C_LINK_LIBRARY_USING_load_archive "-force_load ") - elseif(CMAKE_C_COMPILER_ID STREQUAL "GNU" AND CMAKE_SYSTEM_NAME STREQUAL "Linux") - set(CMAKE_C_LINK_LIBRARY_USING_load_archive - "LINKER:--push-state,--whole-archive" - "" - "LINKER:--pop-state" - ) - elseif(CMAKE_C_COMPILER_ID STREQUAL "MSVC") - set(CMAKE_C_LINK_LIBRARY_USING_load_archive "/WHOLEARCHIVE:") - else() - # feature not yet supported for the other environments - set(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED FALSE) - endif() - - add_library(lib1 STATIC ...) - add_library(lib2 SHARED ...) - - if(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED) - # The -force_load Apple linker option requires a file name - set(external_lib - "$,libexternal.a,external>" - ) - target_link_libraries(lib2 PRIVATE - "$" - ) - else() - target_link_libraries(lib2 PRIVATE lib1 external) - endif() - -CMake will generate the following link expressions: - -* ``AppleClang``: ``-force_load /path/to/lib1.a -force_load libexternal.a`` -* ``GNU``: ``-Wl,--push-state,--whole-archive /path/to/lib1.a -lexternal -Wl,--pop-state`` -* ``MSVC``: ``/WHOLEARCHIVE:/path/to/lib1.lib /WHOLEARCHIVE:external.lib`` - -Linking a library as weak -""""""""""""""""""""""""" - -On macOS, it is possible to link a library in weak mode (the library and all -references are marked as weak imports). Different flags must be used for a -library specified by file path compared to one specified by name. -This constraint can be solved using ``PATH{}`` and ``NAME{}`` wrappers. -Again, the following example shows how this may be implemented for some -linkers, but it is for illustration purposes only. Projects should use the -built-in ``WEAK_FRAMEWORK`` or ``WEAK_LIBRARY`` features instead (see -`Predefined Features`_), which provide more complete and more robust -implementations of this functionality. - -.. code-block:: cmake - - if (CMAKE_C_COMPILER_ID STREQUAL "AppleClang") - set(CMAKE_LINK_LIBRARY_USING_weak_library - "PATH{-weak_library }NAME{LINKER:-weak-l}" - ) - set(CMAKE_LINK_LIBRARY_USING_weak_library_SUPPORTED TRUE) - endif() - - add_library(lib SHARED ...) - add_executable(main ...) - if(CMAKE_LINK_LIBRARY_USING_weak_library_SUPPORTED) - target_link_libraries(main PRIVATE "$") - else() - target_link_libraries(main PRIVATE lib external) - endif() - -CMake will generate the following linker command line fragment when linking -``main`` using the ``AppleClang`` toolchain: - -``-weak_library /path/to/lib -Xlinker -weak-lexternal``. - - -Predefined Features -^^^^^^^^^^^^^^^^^^^ - -The following built-in library features are pre-defined by CMake: - -.. include:: LINK_LIBRARY_PREDEFINED_FEATURES.txt diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst index eed6b65..e74b6ee 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst @@ -5,4 +5,4 @@ Linker flags to be used to create modules. These flags will be used by the linker when creating a module. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst index fd0769c..693565a 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst @@ -5,4 +5,4 @@ Flags to be used when linking a module. Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating modules. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_MSVC_DEBUG_INFORMATION_FORMAT.rst b/Help/variable/CMAKE_MSVC_DEBUG_INFORMATION_FORMAT.rst index 84c2584..a899f63 100644 --- a/Help/variable/CMAKE_MSVC_DEBUG_INFORMATION_FORMAT.rst +++ b/Help/variable/CMAKE_MSVC_DEBUG_INFORMATION_FORMAT.rst @@ -11,7 +11,7 @@ into the test project. The allowed values are: -.. include:: ../prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt +.. include:: ../prop_tgt/include/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/variable/CMAKE_MSVC_RUNTIME_CHECKS.rst b/Help/variable/CMAKE_MSVC_RUNTIME_CHECKS.rst index 5ba8547..c793674 100644 --- a/Help/variable/CMAKE_MSVC_RUNTIME_CHECKS.rst +++ b/Help/variable/CMAKE_MSVC_RUNTIME_CHECKS.rst @@ -11,7 +11,7 @@ into the test project. The allowed values are: -.. include:: ../prop_tgt/MSVC_RUNTIME_CHECKS-VALUES.txt +.. include:: ../prop_tgt/include/MSVC_RUNTIME_CHECKS-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst b/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst index 14806e6..22c3d45 100644 --- a/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst +++ b/Help/variable/CMAKE_MSVC_RUNTIME_LIBRARY.rst @@ -10,7 +10,7 @@ calls to the :command:`try_compile` command into the test project. The allowed values are: -.. include:: ../prop_tgt/MSVC_RUNTIME_LIBRARY-VALUES.txt +.. include:: ../prop_tgt/include/MSVC_RUNTIME_LIBRARY-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/variable/CMAKE_OSX_ARCHITECTURES.rst b/Help/variable/CMAKE_OSX_ARCHITECTURES.rst index fdaca28..f660df9 100644 --- a/Help/variable/CMAKE_OSX_ARCHITECTURES.rst +++ b/Help/variable/CMAKE_OSX_ARCHITECTURES.rst @@ -7,4 +7,4 @@ This variable is used to initialize the :prop_tgt:`OSX_ARCHITECTURES` property on each target as it is created. See that target property for additional information. -.. include:: CMAKE_OSX_VARIABLE.txt +.. include:: include/CMAKE_OSX_VARIABLE.rst diff --git a/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst b/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst index 9df5edd..390c9d5 100644 --- a/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst +++ b/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst @@ -12,4 +12,4 @@ If not set explicitly the value is initialized by the ``MACOSX_DEPLOYMENT_TARGET`` environment variable, if set, and otherwise computed based on the host platform. -.. include:: CMAKE_OSX_VARIABLE.txt +.. include:: include/CMAKE_OSX_VARIABLE.rst diff --git a/Help/variable/CMAKE_OSX_SYSROOT.rst b/Help/variable/CMAKE_OSX_SYSROOT.rst index bd2df5f..b054620 100644 --- a/Help/variable/CMAKE_OSX_SYSROOT.rst +++ b/Help/variable/CMAKE_OSX_SYSROOT.rst @@ -23,4 +23,4 @@ sysroot is used. installed in ``/usr/local`` should pass ``-DCMAKE_OSX_SYSROOT=macosx``, or ``export SDKROOT=macosx``, when not building with Homebrew tools. -.. include:: CMAKE_OSX_VARIABLE.txt +.. include:: include/CMAKE_OSX_VARIABLE.rst diff --git a/Help/variable/CMAKE_OSX_VARIABLE.txt b/Help/variable/CMAKE_OSX_VARIABLE.txt deleted file mode 100644 index 962fcd3..0000000 --- a/Help/variable/CMAKE_OSX_VARIABLE.txt +++ /dev/null @@ -1,12 +0,0 @@ -The value of this variable should be set prior to the first -:command:`project` or :command:`enable_language` command invocation -because it may influence configuration of the toolchain and flags. -It is intended to be set locally by the user creating a build tree. -This variable should be set as a ``CACHE`` entry (or else CMake may -remove it while initializing a cache entry of the same name) unless -policy :policy:`CMP0126` is set to ``NEW``. - -Despite the ``OSX`` part in the variable name(s) they apply also to -other SDKs than macOS like iOS, tvOS, visionOS, or watchOS. - -This variable is ignored on platforms other than Apple. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst index 45748ff..93c84ee 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst @@ -5,4 +5,4 @@ Linker flags to be used to create shared libraries. These flags will be used by the linker when creating a shared library. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst index b968820..d0eb4fd 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst @@ -6,4 +6,4 @@ Flags to be used when linking a shared library. Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating shared libraries. -.. include:: ../variable/LINKER_FLAGS.txt +.. include:: ../variable/include/LINKER_FLAGS.rst diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst index a6d8016..a56b452 100644 --- a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst @@ -5,9 +5,9 @@ CMAKE_SYSTEM_IGNORE_PATH .. |CMAKE_IGNORE_PREFIX_VAR| replace:: :variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` .. |CMAKE_IGNORE_NONSYSTEM_VAR| replace:: :variable:`CMAKE_IGNORE_PATH` -.. include:: IGNORE_SEARCH_PATH.txt -.. include:: IGNORE_SEARCH_LOCATIONS.txt -.. include:: IGNORE_SEARCH_SYSTEM.txt +.. include:: include/IGNORE_SEARCH_PATH.rst +.. include:: include/IGNORE_SEARCH_LOCATIONS.rst +.. include:: include/IGNORE_SEARCH_SYSTEM.rst See also the following variables: diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst index 48a2994..400b9c5 100644 --- a/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst @@ -7,9 +7,9 @@ CMAKE_SYSTEM_IGNORE_PREFIX_PATH .. |CMAKE_IGNORE_NONPREFIX_VAR| replace:: :variable:`CMAKE_SYSTEM_IGNORE_PATH` .. |CMAKE_IGNORE_NONSYSTEM_VAR| replace:: :variable:`CMAKE_IGNORE_PREFIX_PATH` -.. include:: IGNORE_SEARCH_PREFIX.txt -.. include:: IGNORE_SEARCH_LOCATIONS.txt -.. include:: IGNORE_SEARCH_SYSTEM.txt +.. include:: include/IGNORE_SEARCH_PREFIX.rst +.. include:: include/IGNORE_SEARCH_LOCATIONS.rst +.. include:: include/IGNORE_SEARCH_SYSTEM.rst See also the following variables: diff --git a/Help/variable/CMAKE_Swift_COMPILATION_MODE.rst b/Help/variable/CMAKE_Swift_COMPILATION_MODE.rst index 5e55d8c..6e466c1 100644 --- a/Help/variable/CMAKE_Swift_COMPILATION_MODE.rst +++ b/Help/variable/CMAKE_Swift_COMPILATION_MODE.rst @@ -8,7 +8,7 @@ Specify how Swift compiles a target. This variable is used to initialize the The allowed values are: -.. include:: ../prop_tgt/Swift_COMPILATION_MODE-VALUES.txt +.. include:: ../prop_tgt/include/Swift_COMPILATION_MODE-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. For example, the code: diff --git a/Help/variable/CMAKE_TLS_VERSION-VALUES.txt b/Help/variable/CMAKE_TLS_VERSION-VALUES.txt deleted file mode 100644 index 47fd2bc..0000000 --- a/Help/variable/CMAKE_TLS_VERSION-VALUES.txt +++ /dev/null @@ -1,7 +0,0 @@ -* ``1.0`` - -* ``1.1`` - -* ``1.2`` - -* ``1.3`` diff --git a/Help/variable/CMAKE_TLS_VERSION.rst b/Help/variable/CMAKE_TLS_VERSION.rst index ff0918b..be8cca3 100644 --- a/Help/variable/CMAKE_TLS_VERSION.rst +++ b/Help/variable/CMAKE_TLS_VERSION.rst @@ -15,7 +15,7 @@ If neither is set, the default is TLS 1.2. The value may be one of: -.. include:: CMAKE_TLS_VERSION-VALUES.txt +.. include:: include/CMAKE_TLS_VERSION-VALUES.rst This variable is also used by the :module:`ExternalProject` and :module:`FetchContent` modules for internal calls to diff --git a/Help/variable/CMAKE_VS_USE_DEBUG_LIBRARIES.rst b/Help/variable/CMAKE_VS_USE_DEBUG_LIBRARIES.rst index 35d94bc..43befe6 100644 --- a/Help/variable/CMAKE_VS_USE_DEBUG_LIBRARIES.rst +++ b/Help/variable/CMAKE_VS_USE_DEBUG_LIBRARIES.rst @@ -6,7 +6,7 @@ CMAKE_VS_USE_DEBUG_LIBRARIES .. |VS_USE_DEBUG_LIBRARIES| replace:: ``CMAKE_VS_USE_DEBUG_LIBRARIES`` .. |MSVC_RUNTIME_LIBRARY| replace:: :variable:`CMAKE_MSVC_RUNTIME_LIBRARY` -.. include:: ../prop_tgt/VS_USE_DEBUG_LIBRARIES-PURPOSE.txt +.. include:: ../prop_tgt/include/VS_USE_DEBUG_LIBRARIES-PURPOSE.rst Use :manual:`generator expressions ` for per-configuration specification. For example, the code: diff --git a/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER.rst b/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER.rst index f86ed7c..9850a32 100644 --- a/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER.rst +++ b/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER.rst @@ -9,6 +9,6 @@ Visual Studio version. variable to the Visual Studio version build number in the format ``...``. -.. include:: CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt +.. include:: include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst See also the :variable:`CMAKE_GENERATOR_INSTANCE` variable. diff --git a/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt b/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt deleted file mode 100644 index 6bdede7..0000000 --- a/Help/variable/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.txt +++ /dev/null @@ -1,18 +0,0 @@ -The components are: - -``.`` - - The VS major and minor version numbers. - These are the same as the release version numbers. - -```` - - A build date in the format ``MMMDD``, where ``MMM`` is a month index - since an epoch used by Microsoft, and ``DD`` is a day in that month. - -```` - - A build index on the day represented by ````. - -The build number is reported by ``vswhere`` as ``installationVersion``. -For example, VS 16.11.10 has build number ``16.11.32126.315``. diff --git a/Help/variable/CMAKE_WATCOM_RUNTIME_LIBRARY.rst b/Help/variable/CMAKE_WATCOM_RUNTIME_LIBRARY.rst index feb2a60..8d1f36c 100644 --- a/Help/variable/CMAKE_WATCOM_RUNTIME_LIBRARY.rst +++ b/Help/variable/CMAKE_WATCOM_RUNTIME_LIBRARY.rst @@ -10,7 +10,7 @@ calls to the :command:`try_compile` command into the test project. The allowed values are: -.. include:: ../prop_tgt/WATCOM_RUNTIME_LIBRARY-VALUES.txt +.. include:: ../prop_tgt/include/WATCOM_RUNTIME_LIBRARY-VALUES.rst Use :manual:`generator expressions ` to support per-configuration specification. diff --git a/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst b/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst index d5893c9..12e6327 100644 --- a/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst +++ b/Help/variable/CTEST_CUSTOM_COVERAGE_EXCLUDE.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_COVERAGE_EXCLUDE A list of regular expressions which will be used to exclude files by their path from coverage output by the :command:`ctest_coverage` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst b/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst index b8ea1e9..a1212c6 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_EXCEPTION.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_ERROR_EXCEPTION A list of regular expressions which will be used to exclude when detecting error messages in build outputs by the :command:`ctest_build` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst b/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst index e8f4ad4..a3a8b6a 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_MATCH.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_ERROR_MATCH A list of regular expressions which will be used to detect error messages in build outputs by the :command:`ctest_build` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst b/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst index 31c99e7..cb1b9ca 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_POST_CONTEXT.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_ERROR_POST_CONTEXT The number of lines to include as context which follow an error message by the :command:`ctest_build` command. The default is 10. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst b/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst index ae03a5c..5790146 100644 --- a/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst +++ b/Help/variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_ERROR_PRE_CONTEXT The number of lines to include as context which precede an error message by the :command:`ctest_build` command. The default is 10. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst index 007cfe0..035551c 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.rst @@ -9,7 +9,7 @@ truncation modes. If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and may exceed the maximum size. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst For controlling the output collection of passing tests, see :variable:`CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE`. diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst index 920cb04..dee7020 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS.rst @@ -5,4 +5,4 @@ The maximum number of errors in a single build step which will be detected. After this, the :command:`ctest_test` command will truncate the output. Defaults to 50. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst index a1f1cc1..25c1135 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS.rst @@ -5,4 +5,4 @@ The maximum number of warnings in a single build step which will be detected. After this, the :command:`ctest_test` command will truncate the output. Defaults to 50. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst index 8545fc4..bc9d62c 100644 --- a/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst +++ b/Help/variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.rst @@ -9,7 +9,7 @@ truncation modes. If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and may exceed the maximum size. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst For controlling the output collection of failing tests, see :variable:`CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE`. diff --git a/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst b/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst index 578576c..ae7f6a5 100644 --- a/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst +++ b/Help/variable/CTEST_CUSTOM_MEMCHECK_IGNORE.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_MEMCHECK_IGNORE A list of regular expressions to use to exclude tests during the :command:`ctest_memcheck` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst b/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst index 40291fe..a4b6dbd 100644 --- a/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst +++ b/Help/variable/CTEST_CUSTOM_POST_MEMCHECK.rst @@ -3,4 +3,4 @@ CTEST_CUSTOM_POST_MEMCHECK A list of commands to run at the end of the :command:`ctest_memcheck` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_POST_TEST.rst b/Help/variable/CTEST_CUSTOM_POST_TEST.rst index 791292c..36af898 100644 --- a/Help/variable/CTEST_CUSTOM_POST_TEST.rst +++ b/Help/variable/CTEST_CUSTOM_POST_TEST.rst @@ -3,4 +3,4 @@ CTEST_CUSTOM_POST_TEST A list of commands to run at the end of the :command:`ctest_test` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst b/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst index 00de8aa..458be84 100644 --- a/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst +++ b/Help/variable/CTEST_CUSTOM_PRE_MEMCHECK.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_PRE_MEMCHECK A list of commands to run at the start of the :command:`ctest_memcheck` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_PRE_TEST.rst b/Help/variable/CTEST_CUSTOM_PRE_TEST.rst index 6af7152..cbea85b 100644 --- a/Help/variable/CTEST_CUSTOM_PRE_TEST.rst +++ b/Help/variable/CTEST_CUSTOM_PRE_TEST.rst @@ -3,4 +3,4 @@ CTEST_CUSTOM_PRE_TEST A list of commands to run at the start of the :command:`ctest_test` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst b/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst index 7b1a4b8..cb0c3fc 100644 --- a/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst +++ b/Help/variable/CTEST_CUSTOM_TESTS_IGNORE.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_TESTS_IGNORE A list of test names to be excluded from the set of tests run by the :command:`ctest_test` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.rst b/Help/variable/CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.rst index 2d4219e..3ecc8e8 100644 --- a/Help/variable/CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.rst +++ b/Help/variable/CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.rst @@ -9,4 +9,4 @@ via the :variable:`CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE` or By default the ``tail`` of the output will be truncated. Other possible values are ``middle`` and ``head``. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst b/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst index a03d473..d37148b 100644 --- a/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst +++ b/Help/variable/CTEST_CUSTOM_WARNING_EXCEPTION.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_WARNING_EXCEPTION A list of regular expressions which will be used to exclude when detecting warning messages in build outputs by the :command:`ctest_build` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst b/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst index 18aa6b3..c276473 100644 --- a/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst +++ b/Help/variable/CTEST_CUSTOM_WARNING_MATCH.rst @@ -4,4 +4,4 @@ CTEST_CUSTOM_WARNING_MATCH A list of regular expressions which will be used to detect warning messages in build outputs by the :command:`ctest_build` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_CUSTOM_XXX.txt b/Help/variable/CTEST_CUSTOM_XXX.txt deleted file mode 100644 index 02d1547..0000000 --- a/Help/variable/CTEST_CUSTOM_XXX.txt +++ /dev/null @@ -1,2 +0,0 @@ -It is initialized by :manual:`ctest(1)`, but may be edited in a ``CTestCustom`` -file. See :command:`ctest_read_custom_files` documentation. diff --git a/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst b/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst index 1d7e8d4..03540dd 100644 --- a/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst +++ b/Help/variable/CTEST_EXTRA_COVERAGE_GLOB.rst @@ -6,4 +6,4 @@ CTEST_EXTRA_COVERAGE_GLOB A list of regular expressions which will be used to find files which should be covered by the :command:`ctest_coverage` command. -.. include:: CTEST_CUSTOM_XXX.txt +.. include:: include/CTEST_CUSTOM_XXX.rst diff --git a/Help/variable/CTEST_TLS_VERSION.rst b/Help/variable/CTEST_TLS_VERSION.rst index f8123df..b2aec5b 100644 --- a/Help/variable/CTEST_TLS_VERSION.rst +++ b/Help/variable/CTEST_TLS_VERSION.rst @@ -10,7 +10,7 @@ TLS version allowed when submitting to a dashboard via ``https://`` URLs. The value may be one of: -.. include:: CMAKE_TLS_VERSION-VALUES.txt +.. include:: include/CMAKE_TLS_VERSION-VALUES.rst If ``CTEST_TLS_VERSION`` is not set, the :variable:`CMAKE_TLS_VERSION` variable or :envvar:`CMAKE_TLS_VERSION` environment variable is used instead. diff --git a/Help/variable/IGNORE_SEARCH_LOCATIONS.txt b/Help/variable/IGNORE_SEARCH_LOCATIONS.txt deleted file mode 100644 index a98f359..0000000 --- a/Help/variable/IGNORE_SEARCH_LOCATIONS.txt +++ /dev/null @@ -1,4 +0,0 @@ -Ignoring search locations can be useful in cross-compiling environments where -some system directories contain incompatible but possibly linkable libraries. -For example, on cross-compiled cluster environments, this allows a user to -ignore directories containing libraries meant for the front-end machine. diff --git a/Help/variable/IGNORE_SEARCH_NONSYSTEM.txt b/Help/variable/IGNORE_SEARCH_NONSYSTEM.txt deleted file mode 100644 index a32a189..0000000 --- a/Help/variable/IGNORE_SEARCH_NONSYSTEM.txt +++ /dev/null @@ -1,2 +0,0 @@ -By default, |CMAKE_IGNORE_VAR| is empty. It is intended to be set by the -project or the end user. diff --git a/Help/variable/IGNORE_SEARCH_PATH.txt b/Help/variable/IGNORE_SEARCH_PATH.txt deleted file mode 100644 index 0811e02..0000000 --- a/Help/variable/IGNORE_SEARCH_PATH.txt +++ /dev/null @@ -1,19 +0,0 @@ -:ref:`Semicolon-separated list ` of directories -to be ignored by the various ``find...()`` commands. - -For :command:`find_program`, :command:`find_library`, :command:`find_file`, -and :command:`find_path`, any file found in one of the listed directories -will be ignored. The listed directories do not apply recursively, so any -subdirectories to be ignored must also be explicitly listed. -|CMAKE_IGNORE_VAR| does not affect the search *prefixes* used by these -four commands. To ignore individual paths under a search prefix -(e.g. ``bin``, ``include``, ``lib``, etc.), each path must be listed in -|CMAKE_IGNORE_VAR| as a full absolute path. |CMAKE_IGNORE_PREFIX_VAR| -provides a more appropriate way to ignore a whole search prefix. - -:command:`find_package` is also affected by |CMAKE_IGNORE_VAR|, but only -for *Config mode* searches. Any ``Config.cmake`` or -``-config.cmake`` file found in one of the specified directories -will be ignored. In addition, any search *prefix* found in |CMAKE_IGNORE_VAR| -will be skipped for backward compatibility reasons, but new code should -prefer to use |CMAKE_IGNORE_PREFIX_VAR| to ignore prefixes instead. diff --git a/Help/variable/IGNORE_SEARCH_PREFIX.txt b/Help/variable/IGNORE_SEARCH_PREFIX.txt deleted file mode 100644 index f5ec3dc..0000000 --- a/Help/variable/IGNORE_SEARCH_PREFIX.txt +++ /dev/null @@ -1,6 +0,0 @@ -:ref:`Semicolon-separated list ` of search *prefixes* -to be ignored by the :command:`find_program`, :command:`find_library`, -:command:`find_file`, and :command:`find_path` commands. -The prefixes are also ignored by the *Config mode* of the -:command:`find_package` command (*Module mode* is unaffected). -To ignore specific directories instead, see |CMAKE_IGNORE_NONPREFIX_VAR|. diff --git a/Help/variable/IGNORE_SEARCH_SYSTEM.txt b/Help/variable/IGNORE_SEARCH_SYSTEM.txt deleted file mode 100644 index 78b285d6..0000000 --- a/Help/variable/IGNORE_SEARCH_SYSTEM.txt +++ /dev/null @@ -1,5 +0,0 @@ -|CMAKE_IGNORE_VAR| is populated by CMake as part of its platform -and toolchain setup. Its purpose is to ignore locations containing -incompatible binaries meant for the host rather than the target platform. -The project or end user should not modify this variable, they should use -|CMAKE_IGNORE_NONSYSTEM_VAR| instead. diff --git a/Help/variable/LINKER_FLAGS.txt b/Help/variable/LINKER_FLAGS.txt deleted file mode 100644 index 7b0630a..0000000 --- a/Help/variable/LINKER_FLAGS.txt +++ /dev/null @@ -1,5 +0,0 @@ - -.. include:: ../command/LINK_LIBRARIES_LINKER.txt - -This support implies to parse and re-quote the content of the variable. See -policy :policy:`CMP0181`. diff --git a/Help/variable/LINKER_PREDEFINED_TYPES.txt b/Help/variable/LINKER_PREDEFINED_TYPES.txt deleted file mode 100644 index 3c1b7b8..0000000 --- a/Help/variable/LINKER_PREDEFINED_TYPES.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. note:: - It is assumed that the linker specified is fully compatible with the default - one the compiler would normally invoke. CMake will not do any option - translation. - -Linker types are case-sensitive and may only contain letters, numbers and -underscores. Linker types defined in all uppercase are reserved for CMake's own -built-in types. The pre-defined linker types are: - -``DEFAULT`` - This type corresponds to standard linking, essentially equivalent to the - :prop_tgt:`LINKER_TYPE` target property not being set at all. - -``SYSTEM`` - Use the standard linker provided by the platform or toolchain. For example, - this implies the Microsoft linker for all MSVC-compatible compilers. - This type is supported for the following platform-compiler combinations: - - * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, ``NVIDIA``, and ``Swift`` - compilers. - * Apple platforms: ``AppleClang``, ``Clang``, ``GNU``, and ``Swift`` - compilers. - * Windows: ``MSVC``, ``GNU``, ``Clang``, ``NVIDIA``, and ``Swift`` compilers. - -``LLD`` - Use the ``LLVM`` linker. This type is supported for the following - platform-compiler combinations: - - * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, ``NVIDIA``, and ``Swift`` - compilers. - * Apple platforms: ``Clang``, ``AppleClang``, and ``Swift`` compilers. - * Windows: ``GNU``, ``Clang`` with MSVC-like front-end, ``Clang`` with - GNU-like front-end, ``MSVC``, ``NVIDIA`` with MSVC-like front-end, - and ``Swift``. - -``BFD`` - Use the ``GNU`` linker. This type is supported for the following - platform-compiler combinations: - - * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, and ``NVIDIA`` compilers. - * Windows: ``GNU``, ``Clang`` with GNU-like front-end. - -``GOLD`` - Supported on Linux platform with ``GNU``, ``Clang``, ``LLVMFlang``, - ``NVIDIA``, and ``Swift`` compilers. - -``MOLD`` - Use the `mold linker `_. This type is - supported on the following platform-compiler combinations: - - * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, and ``NVIDIA`` compilers. - * Apple platforms: ``Clang`` and ``AppleClang`` compilers (acts as an - alias to the `sold linker`_). - -``SOLD`` - Use the `sold linker`_. This type is only supported on Apple platforms - with ``Clang`` and ``AppleClang`` compilers. - -``APPLE_CLASSIC`` - Use the Apple linker in the classic behavior (i.e. before ``Xcode 15.0``). - This type is only supported on Apple platforms with ``GNU``, ``Clang``, - ``AppleClang``, and ``Swift`` compilers. - -``MSVC`` - Use the Microsoft linker. This type is only supported on the Windows - platform with ``MSVC``, ``Clang`` with MSVC-like front-end, and ``Swift`` - compilers. - -.. _sold linker: https://github.com/bluewhalesystems/sold diff --git a/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt b/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt deleted file mode 100644 index 557886e..0000000 --- a/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt +++ /dev/null @@ -1,22 +0,0 @@ -``RESCAN`` - Some linkers are single-pass only. For such linkers, circular references - between libraries typically result in unresolved symbols. This feature - instructs the linker to search the specified static libraries repeatedly - until no new undefined references are created. - - Normally, a static library is searched only once in the order that it is - specified on the command line. If a symbol in that library is needed to - resolve an undefined symbol referred to by an object in a library that - appears later on the command line, the linker would not be able to resolve - that reference. By grouping the static libraries with the ``RESCAN`` - feature, they will all be searched repeatedly until all possible references - are resolved. This will use linker options like ``--start-group`` and - ``--end-group``, or on SunOS, ``-z rescan-start`` and ``-z rescan-end``. - - Using this feature has a significant performance cost. It is best to use it - only when there are unavoidable circular references between two or more - static libraries. - - This feature is available when using toolchains that target Linux, BSD, and - SunOS. It can also be used when targeting Windows platforms if the GNU - toolchain is used. diff --git a/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt b/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt deleted file mode 100644 index 75fe0e6..0000000 --- a/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt +++ /dev/null @@ -1,111 +0,0 @@ -``DEFAULT`` - This feature corresponds to standard linking, essentially equivalent to - using no feature at all. It is typically only used with the - :prop_tgt:`LINK_LIBRARY_OVERRIDE` and - :prop_tgt:`LINK_LIBRARY_OVERRIDE_` target properties. - -``WHOLE_ARCHIVE`` - Force inclusion of all members of a static library when linked as a - dependency of consuming :ref:`Executables`, :ref:`Shared Libraries`, - and :ref:`Module Libraries`. This feature is only supported for the - following platforms, with limitations as noted: - - * Linux. - * All BSD variants. - * SunOS. - * All Apple variants. The library must be specified as a CMake target name, - a library file name (such as ``libfoo.a``), or a library file path (such as - ``/path/to/libfoo.a``). Due to a limitation of the Apple linker, it - cannot be specified as a plain library name like ``foo``, where ``foo`` - is not a CMake target. - * Windows. When using a MSVC or MSVC-like toolchain, the MSVC version must - be greater than 1900. - * Cygwin. - * MSYS. - - .. note:: - - Since :ref:`Static Libraries` are archives and not linked binaries, - CMake records their link dependencies for transitive use when linking - consuming binaries. Therefore ``WHOLE_ARCHIVE`` does not cause a - static library's objects to be included in other static libraries. - Use :ref:`Object Libraries` for that. - -``FRAMEWORK`` - This option tells the linker to search for the specified framework using - the ``-framework`` linker option. It can only be used on Apple platforms, - and only with a linker that understands the option used (i.e. the linker - provided with Xcode, or one compatible with it). - - The framework can be specified as a CMake framework target, a bare framework - name, or a file path. If a target is given, that target must have the - :prop_tgt:`FRAMEWORK` target property set to true. For a file path, if it - contains a directory part, that directory will be added as a framework - search path. - - .. code-block:: cmake - - add_library(lib SHARED ...) - target_link_libraries(lib PRIVATE "$") - - # The constructed linker command line will contain: - # -F/path/to -framework my_framework - - File paths must conform to one of the following patterns (``*`` is a - wildcard, and optional parts are shown as ``[...]``): - - * ``[/path/to/]FwName[.framework]`` - * ``[/path/to/]FwName.framework/FwName[suffix]`` - * ``[/path/to/]FwName.framework/Versions/*/FwName[suffix]`` - - Note that CMake recognizes and automatically handles framework targets, - even without using the :genex:`$` expression. - The generator expression can still be used with a CMake target if the - project wants to be explicit about it, but it is not required to do so. - The linker command line may have some differences between using the - generator expression or not, but the final result should be the same. - On the other hand, if a file path is given, CMake will recognize some paths - automatically, but not all cases. The project may want to use - :genex:`$` for file paths so that the expected - behavior is clear. - - .. versionadded:: 3.25 - The :prop_tgt:`FRAMEWORK_MULTI_CONFIG_POSTFIX_` target property as - well as the ``suffix`` of the framework library name are now supported by - the ``FRAMEWORK`` features. - -``NEEDED_FRAMEWORK`` - This is similar to the ``FRAMEWORK`` feature, except it forces the linker - to link with the framework even if no symbols are used from it. It uses - the ``-needed_framework`` option and has the same linker constraints as - ``FRAMEWORK``. - -``REEXPORT_FRAMEWORK`` - This is similar to the ``FRAMEWORK`` feature, except it tells the linker - that the framework should be available to clients linking to the library - being created. It uses the ``-reexport_framework`` option and has the - same linker constraints as ``FRAMEWORK``. - -``WEAK_FRAMEWORK`` - This is similar to the ``FRAMEWORK`` feature, except it forces the linker - to mark the framework and all references to it as weak imports. It uses - the ``-weak_framework`` option and has the same linker constraints as - ``FRAMEWORK``. - -``NEEDED_LIBRARY`` - This is similar to the ``NEEDED_FRAMEWORK`` feature, except it is for use - with non-framework targets or libraries (Apple platforms only). - It uses the ``-needed_library`` or ``-needed-l`` option as appropriate, - and has the same linker constraints as ``NEEDED_FRAMEWORK``. - -``REEXPORT_LIBRARY`` - This is similar to the ``REEXPORT_FRAMEWORK`` feature, except it is for use - with non-framework targets or libraries (Apple platforms only). - It uses the ``-reexport_library`` or ``-reexport-l`` option as appropriate, - and has the same linker constraints as ``REEXPORT_FRAMEWORK``. - -``WEAK_LIBRARY`` - This is similar to the ``WEAK_FRAMEWORK`` feature, except it is for use - with non-framework targets or libraries (Apple platforms only). - It uses the ``-weak_library`` or ``-weak-l`` option as appropriate, - and has the same linker constraints as ``WEAK_FRAMEWORK``. diff --git a/Help/variable/include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst b/Help/variable/include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst new file mode 100644 index 0000000..ab65e09 --- /dev/null +++ b/Help/variable/include/CMAKE_FIND_ROOT_PATH_MODE_XXX.rst @@ -0,0 +1,8 @@ +This variable controls whether the :variable:`CMAKE_FIND_ROOT_PATH` and +:variable:`CMAKE_SYSROOT` are used by |FIND_XXX|. + +If set to ``ONLY``, then only the roots in :variable:`CMAKE_FIND_ROOT_PATH` +will be searched. If set to ``NEVER``, then the roots in +:variable:`CMAKE_FIND_ROOT_PATH` will be ignored and only the host system +root will be used. If set to ``BOTH``, then the host system paths and the +paths in :variable:`CMAKE_FIND_ROOT_PATH` will be searched. diff --git a/Help/variable/include/CMAKE_LINK_GROUP_USING_FEATURE.rst b/Help/variable/include/CMAKE_LINK_GROUP_USING_FEATURE.rst new file mode 100644 index 0000000..0f23d00 --- /dev/null +++ b/Help/variable/include/CMAKE_LINK_GROUP_USING_FEATURE.rst @@ -0,0 +1,78 @@ +Feature names are case-sensitive and may only contain letters, numbers +and underscores. Feature names defined in all uppercase are reserved for +CMake's own built-in features (see `Predefined Features`_ further below). + + +Feature Definitions +^^^^^^^^^^^^^^^^^^^ + +A group feature definition is a list that contains exactly two elements: + +:: + + + +On the linker command line, ```` will precede the list of libraries +in the group and ```` will follow after. + +For the elements of this variable, the ``LINKER:`` prefix can be used. + +.. include:: ../command/include/LINK_OPTIONS_LINKER.rst + :start-line: 3 + +Examples +^^^^^^^^ + +Solving cross-references between two static libraries +""""""""""""""""""""""""""""""""""""""""""""""""""""" + +A project may define two or more static libraries which have circular +dependencies between them. In order for the linker to resolve all symbols +at link time, it may need to search repeatedly among the libraries until no +new undefined references are created. Different linkers use different syntax +for achieving this. The following example shows how this may be implemented +for some linkers. Note that this is for illustration purposes only. +Projects should use the built-in ``RESCAN`` group feature instead +(see `Predefined Features`_), which provides a more complete and more robust +implementation of this functionality. + +.. code-block:: cmake + + set(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED TRUE) + if(CMAKE_C_COMPILER_ID STREQUAL "GNU" AND CMAKE_SYSTEM_NAME STREQUAL "Linux") + set(CMAKE_C_LINK_GROUP_USING_cross_refs + "LINKER:--start-group" + "LINKER:--end-group" + ) + elseif(CMAKE_C_COMPILER_ID STREQUAL "SunPro" AND CMAKE_SYSTEM_NAME STREQUAL "SunOS") + set(CMAKE_C_LINK_GROUP_USING_cross_refs + "LINKER:-z,rescan-start" + "LINKER:-z,rescan-end" + ) + else() + # feature not yet supported for the other environments + set(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED FALSE) + endif() + + add_library(lib1 STATIC ...) + add_library(lib2 SHARED ...) + + if(CMAKE_C_LINK_GROUP_USING_cross_refs_SUPPORTED) + target_link_libraries(lib2 PRIVATE "$") + else() + target_link_libraries(lib2 PRIVATE lib1 external) + endif() + +CMake will generate the following linker command line fragments when linking +``lib2``: + +* ``GNU``: ``-Wl,--start-group /path/to/lib1.a -lexternal -Wl,--end-group`` +* ``SunPro``: ``-Wl,-z,rescan-start /path/to/lib1.a -lexternal -Wl,-z,rescan-end`` + + +Predefined Features +^^^^^^^^^^^^^^^^^^^ + +The following built-in group features are pre-defined by CMake: + +.. include:: include/LINK_GROUP_PREDEFINED_FEATURES.rst diff --git a/Help/variable/include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst b/Help/variable/include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst new file mode 100644 index 0000000..41c2172 --- /dev/null +++ b/Help/variable/include/CMAKE_LINK_LIBRARY_USING_FEATURE.rst @@ -0,0 +1,153 @@ +Feature names are case-sensitive and may only contain letters, numbers +and underscores. Feature names defined in all uppercase are reserved for +CMake's own built-in features (see `Predefined Features`_ further below). + +Some aspects of feature behavior can be defined by the +:variable:`CMAKE__LINK_LIBRARY__ATTRIBUTES` and +:variable:`CMAKE_LINK_LIBRARY__ATTRIBUTES` variables. + +Feature Definitions +^^^^^^^^^^^^^^^^^^^ + +A library feature definition is a list that contains one or three elements: + +:: + + [] [] + +When ```` and ```` are specified, they precede and follow +respectively the whole list of libraries specified in the +:genex:`LINK_LIBRARY` expression, not each library item individually. +There is no guarantee that the list of specified libraries will be kept +grouped together though, so the ```` and ```` may appear +more than once if the library list is reorganized by CMake to satisfy other +constraints. This means constructs like ``--start-group`` and ``--end-group``, +as supported by the GNU ``ld`` linker, cannot be used in this way. The +:genex:`LINK_GROUP` generator expression should be used instead for such +constructs. + +```` is used to specify the pattern for constructing the +corresponding fragment on the linker command line for each library. +The following placeholders can be used in the expression: + +* ```` is expanded to the full path to the library for CMake targets, + or to a platform-specific value based on the item otherwise (the same as + ```` on Windows, or the library base name for other platforms). +* ```` is expanded to how the library would normally be linked on + the linker command line. +* ```` is expanded to the full path to the library for CMake targets, + or the item itself exactly as specified in the ```` + otherwise. + +In addition to the above, it is possible to have one pattern for paths +(CMake targets and external libraries specified with file paths) and another +for other items specified by name only. The ``PATH{}`` and ``NAME{}`` wrappers +can be used to provide the expansion for those two cases, respectively. +When wrappers are used, both must be present. For example: + +.. code-block:: cmake + + set(CMAKE_LINK_LIBRARY_USING_weak_library + "PATH{-weak_library }NAME{LINKER:-weak-l}" + ) + +For all three elements of this variable (````, ````, +and ````), the ``LINKER:`` prefix can be used. + +.. include:: ../command/include/LINK_OPTIONS_LINKER.rst + :start-line: 3 + +Examples +^^^^^^^^ + +Loading a whole static library +"""""""""""""""""""""""""""""" + +A common need is to prevent the linker from discarding any symbols from a +static library. Different linkers use different syntax for achieving this. +The following example shows how this may be implemented for some linkers. +Note that this is for illustration purposes only. Projects should use the +built-in ``WHOLE_ARCHIVE`` feature instead (see `Predefined Features`_), which +provides a more complete and more robust implementation of this functionality. + +.. code-block:: cmake + + set(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED TRUE) + if(CMAKE_C_COMPILER_ID STREQUAL "AppleClang") + set(CMAKE_C_LINK_LIBRARY_USING_load_archive "-force_load ") + elseif(CMAKE_C_COMPILER_ID STREQUAL "GNU" AND CMAKE_SYSTEM_NAME STREQUAL "Linux") + set(CMAKE_C_LINK_LIBRARY_USING_load_archive + "LINKER:--push-state,--whole-archive" + "" + "LINKER:--pop-state" + ) + elseif(CMAKE_C_COMPILER_ID STREQUAL "MSVC") + set(CMAKE_C_LINK_LIBRARY_USING_load_archive "/WHOLEARCHIVE:") + else() + # feature not yet supported for the other environments + set(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED FALSE) + endif() + + add_library(lib1 STATIC ...) + add_library(lib2 SHARED ...) + + if(CMAKE_C_LINK_LIBRARY_USING_load_archive_SUPPORTED) + # The -force_load Apple linker option requires a file name + set(external_lib + "$,libexternal.a,external>" + ) + target_link_libraries(lib2 PRIVATE + "$" + ) + else() + target_link_libraries(lib2 PRIVATE lib1 external) + endif() + +CMake will generate the following link expressions: + +* ``AppleClang``: ``-force_load /path/to/lib1.a -force_load libexternal.a`` +* ``GNU``: ``-Wl,--push-state,--whole-archive /path/to/lib1.a -lexternal -Wl,--pop-state`` +* ``MSVC``: ``/WHOLEARCHIVE:/path/to/lib1.lib /WHOLEARCHIVE:external.lib`` + +Linking a library as weak +""""""""""""""""""""""""" + +On macOS, it is possible to link a library in weak mode (the library and all +references are marked as weak imports). Different flags must be used for a +library specified by file path compared to one specified by name. +This constraint can be solved using ``PATH{}`` and ``NAME{}`` wrappers. +Again, the following example shows how this may be implemented for some +linkers, but it is for illustration purposes only. Projects should use the +built-in ``WEAK_FRAMEWORK`` or ``WEAK_LIBRARY`` features instead (see +`Predefined Features`_), which provide more complete and more robust +implementations of this functionality. + +.. code-block:: cmake + + if (CMAKE_C_COMPILER_ID STREQUAL "AppleClang") + set(CMAKE_LINK_LIBRARY_USING_weak_library + "PATH{-weak_library }NAME{LINKER:-weak-l}" + ) + set(CMAKE_LINK_LIBRARY_USING_weak_library_SUPPORTED TRUE) + endif() + + add_library(lib SHARED ...) + add_executable(main ...) + if(CMAKE_LINK_LIBRARY_USING_weak_library_SUPPORTED) + target_link_libraries(main PRIVATE "$") + else() + target_link_libraries(main PRIVATE lib external) + endif() + +CMake will generate the following linker command line fragment when linking +``main`` using the ``AppleClang`` toolchain: + +``-weak_library /path/to/lib -Xlinker -weak-lexternal``. + + +Predefined Features +^^^^^^^^^^^^^^^^^^^ + +The following built-in library features are pre-defined by CMake: + +.. include:: include/LINK_LIBRARY_PREDEFINED_FEATURES.rst diff --git a/Help/variable/include/CMAKE_OSX_VARIABLE.rst b/Help/variable/include/CMAKE_OSX_VARIABLE.rst new file mode 100644 index 0000000..962fcd3 --- /dev/null +++ b/Help/variable/include/CMAKE_OSX_VARIABLE.rst @@ -0,0 +1,12 @@ +The value of this variable should be set prior to the first +:command:`project` or :command:`enable_language` command invocation +because it may influence configuration of the toolchain and flags. +It is intended to be set locally by the user creating a build tree. +This variable should be set as a ``CACHE`` entry (or else CMake may +remove it while initializing a cache entry of the same name) unless +policy :policy:`CMP0126` is set to ``NEW``. + +Despite the ``OSX`` part in the variable name(s) they apply also to +other SDKs than macOS like iOS, tvOS, visionOS, or watchOS. + +This variable is ignored on platforms other than Apple. diff --git a/Help/variable/include/CMAKE_TLS_VERSION-VALUES.rst b/Help/variable/include/CMAKE_TLS_VERSION-VALUES.rst new file mode 100644 index 0000000..47fd2bc --- /dev/null +++ b/Help/variable/include/CMAKE_TLS_VERSION-VALUES.rst @@ -0,0 +1,7 @@ +* ``1.0`` + +* ``1.1`` + +* ``1.2`` + +* ``1.3`` diff --git a/Help/variable/include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst b/Help/variable/include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst new file mode 100644 index 0000000..6bdede7 --- /dev/null +++ b/Help/variable/include/CMAKE_VS_VERSION_BUILD_NUMBER_COMPONENTS.rst @@ -0,0 +1,18 @@ +The components are: + +``.`` + + The VS major and minor version numbers. + These are the same as the release version numbers. + +```` + + A build date in the format ``MMMDD``, where ``MMM`` is a month index + since an epoch used by Microsoft, and ``DD`` is a day in that month. + +```` + + A build index on the day represented by ````. + +The build number is reported by ``vswhere`` as ``installationVersion``. +For example, VS 16.11.10 has build number ``16.11.32126.315``. diff --git a/Help/variable/include/CTEST_CUSTOM_XXX.rst b/Help/variable/include/CTEST_CUSTOM_XXX.rst new file mode 100644 index 0000000..02d1547 --- /dev/null +++ b/Help/variable/include/CTEST_CUSTOM_XXX.rst @@ -0,0 +1,2 @@ +It is initialized by :manual:`ctest(1)`, but may be edited in a ``CTestCustom`` +file. See :command:`ctest_read_custom_files` documentation. diff --git a/Help/variable/include/IGNORE_SEARCH_LOCATIONS.rst b/Help/variable/include/IGNORE_SEARCH_LOCATIONS.rst new file mode 100644 index 0000000..a98f359 --- /dev/null +++ b/Help/variable/include/IGNORE_SEARCH_LOCATIONS.rst @@ -0,0 +1,4 @@ +Ignoring search locations can be useful in cross-compiling environments where +some system directories contain incompatible but possibly linkable libraries. +For example, on cross-compiled cluster environments, this allows a user to +ignore directories containing libraries meant for the front-end machine. diff --git a/Help/variable/include/IGNORE_SEARCH_NONSYSTEM.rst b/Help/variable/include/IGNORE_SEARCH_NONSYSTEM.rst new file mode 100644 index 0000000..a32a189 --- /dev/null +++ b/Help/variable/include/IGNORE_SEARCH_NONSYSTEM.rst @@ -0,0 +1,2 @@ +By default, |CMAKE_IGNORE_VAR| is empty. It is intended to be set by the +project or the end user. diff --git a/Help/variable/include/IGNORE_SEARCH_PATH.rst b/Help/variable/include/IGNORE_SEARCH_PATH.rst new file mode 100644 index 0000000..0811e02 --- /dev/null +++ b/Help/variable/include/IGNORE_SEARCH_PATH.rst @@ -0,0 +1,19 @@ +:ref:`Semicolon-separated list ` of directories +to be ignored by the various ``find...()`` commands. + +For :command:`find_program`, :command:`find_library`, :command:`find_file`, +and :command:`find_path`, any file found in one of the listed directories +will be ignored. The listed directories do not apply recursively, so any +subdirectories to be ignored must also be explicitly listed. +|CMAKE_IGNORE_VAR| does not affect the search *prefixes* used by these +four commands. To ignore individual paths under a search prefix +(e.g. ``bin``, ``include``, ``lib``, etc.), each path must be listed in +|CMAKE_IGNORE_VAR| as a full absolute path. |CMAKE_IGNORE_PREFIX_VAR| +provides a more appropriate way to ignore a whole search prefix. + +:command:`find_package` is also affected by |CMAKE_IGNORE_VAR|, but only +for *Config mode* searches. Any ``Config.cmake`` or +``-config.cmake`` file found in one of the specified directories +will be ignored. In addition, any search *prefix* found in |CMAKE_IGNORE_VAR| +will be skipped for backward compatibility reasons, but new code should +prefer to use |CMAKE_IGNORE_PREFIX_VAR| to ignore prefixes instead. diff --git a/Help/variable/include/IGNORE_SEARCH_PREFIX.rst b/Help/variable/include/IGNORE_SEARCH_PREFIX.rst new file mode 100644 index 0000000..f5ec3dc --- /dev/null +++ b/Help/variable/include/IGNORE_SEARCH_PREFIX.rst @@ -0,0 +1,6 @@ +:ref:`Semicolon-separated list ` of search *prefixes* +to be ignored by the :command:`find_program`, :command:`find_library`, +:command:`find_file`, and :command:`find_path` commands. +The prefixes are also ignored by the *Config mode* of the +:command:`find_package` command (*Module mode* is unaffected). +To ignore specific directories instead, see |CMAKE_IGNORE_NONPREFIX_VAR|. diff --git a/Help/variable/include/IGNORE_SEARCH_SYSTEM.rst b/Help/variable/include/IGNORE_SEARCH_SYSTEM.rst new file mode 100644 index 0000000..78b285d6 --- /dev/null +++ b/Help/variable/include/IGNORE_SEARCH_SYSTEM.rst @@ -0,0 +1,5 @@ +|CMAKE_IGNORE_VAR| is populated by CMake as part of its platform +and toolchain setup. Its purpose is to ignore locations containing +incompatible binaries meant for the host rather than the target platform. +The project or end user should not modify this variable, they should use +|CMAKE_IGNORE_NONSYSTEM_VAR| instead. diff --git a/Help/variable/include/LINKER_FLAGS.rst b/Help/variable/include/LINKER_FLAGS.rst new file mode 100644 index 0000000..78bfc07 --- /dev/null +++ b/Help/variable/include/LINKER_FLAGS.rst @@ -0,0 +1,5 @@ + +.. include:: ../command/include/LINK_LIBRARIES_LINKER.rst + +This support implies to parse and re-quote the content of the variable. See +policy :policy:`CMP0181`. diff --git a/Help/variable/include/LINKER_PREDEFINED_TYPES.rst b/Help/variable/include/LINKER_PREDEFINED_TYPES.rst new file mode 100644 index 0000000..3c1b7b8 --- /dev/null +++ b/Help/variable/include/LINKER_PREDEFINED_TYPES.rst @@ -0,0 +1,69 @@ +.. note:: + It is assumed that the linker specified is fully compatible with the default + one the compiler would normally invoke. CMake will not do any option + translation. + +Linker types are case-sensitive and may only contain letters, numbers and +underscores. Linker types defined in all uppercase are reserved for CMake's own +built-in types. The pre-defined linker types are: + +``DEFAULT`` + This type corresponds to standard linking, essentially equivalent to the + :prop_tgt:`LINKER_TYPE` target property not being set at all. + +``SYSTEM`` + Use the standard linker provided by the platform or toolchain. For example, + this implies the Microsoft linker for all MSVC-compatible compilers. + This type is supported for the following platform-compiler combinations: + + * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, ``NVIDIA``, and ``Swift`` + compilers. + * Apple platforms: ``AppleClang``, ``Clang``, ``GNU``, and ``Swift`` + compilers. + * Windows: ``MSVC``, ``GNU``, ``Clang``, ``NVIDIA``, and ``Swift`` compilers. + +``LLD`` + Use the ``LLVM`` linker. This type is supported for the following + platform-compiler combinations: + + * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, ``NVIDIA``, and ``Swift`` + compilers. + * Apple platforms: ``Clang``, ``AppleClang``, and ``Swift`` compilers. + * Windows: ``GNU``, ``Clang`` with MSVC-like front-end, ``Clang`` with + GNU-like front-end, ``MSVC``, ``NVIDIA`` with MSVC-like front-end, + and ``Swift``. + +``BFD`` + Use the ``GNU`` linker. This type is supported for the following + platform-compiler combinations: + + * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, and ``NVIDIA`` compilers. + * Windows: ``GNU``, ``Clang`` with GNU-like front-end. + +``GOLD`` + Supported on Linux platform with ``GNU``, ``Clang``, ``LLVMFlang``, + ``NVIDIA``, and ``Swift`` compilers. + +``MOLD`` + Use the `mold linker `_. This type is + supported on the following platform-compiler combinations: + + * Linux: ``GNU``, ``Clang``, ``LLVMFlang``, and ``NVIDIA`` compilers. + * Apple platforms: ``Clang`` and ``AppleClang`` compilers (acts as an + alias to the `sold linker`_). + +``SOLD`` + Use the `sold linker`_. This type is only supported on Apple platforms + with ``Clang`` and ``AppleClang`` compilers. + +``APPLE_CLASSIC`` + Use the Apple linker in the classic behavior (i.e. before ``Xcode 15.0``). + This type is only supported on Apple platforms with ``GNU``, ``Clang``, + ``AppleClang``, and ``Swift`` compilers. + +``MSVC`` + Use the Microsoft linker. This type is only supported on the Windows + platform with ``MSVC``, ``Clang`` with MSVC-like front-end, and ``Swift`` + compilers. + +.. _sold linker: https://github.com/bluewhalesystems/sold diff --git a/Help/variable/include/LINK_GROUP_PREDEFINED_FEATURES.rst b/Help/variable/include/LINK_GROUP_PREDEFINED_FEATURES.rst new file mode 100644 index 0000000..557886e --- /dev/null +++ b/Help/variable/include/LINK_GROUP_PREDEFINED_FEATURES.rst @@ -0,0 +1,22 @@ +``RESCAN`` + Some linkers are single-pass only. For such linkers, circular references + between libraries typically result in unresolved symbols. This feature + instructs the linker to search the specified static libraries repeatedly + until no new undefined references are created. + + Normally, a static library is searched only once in the order that it is + specified on the command line. If a symbol in that library is needed to + resolve an undefined symbol referred to by an object in a library that + appears later on the command line, the linker would not be able to resolve + that reference. By grouping the static libraries with the ``RESCAN`` + feature, they will all be searched repeatedly until all possible references + are resolved. This will use linker options like ``--start-group`` and + ``--end-group``, or on SunOS, ``-z rescan-start`` and ``-z rescan-end``. + + Using this feature has a significant performance cost. It is best to use it + only when there are unavoidable circular references between two or more + static libraries. + + This feature is available when using toolchains that target Linux, BSD, and + SunOS. It can also be used when targeting Windows platforms if the GNU + toolchain is used. diff --git a/Help/variable/include/LINK_LIBRARY_PREDEFINED_FEATURES.rst b/Help/variable/include/LINK_LIBRARY_PREDEFINED_FEATURES.rst new file mode 100644 index 0000000..75fe0e6 --- /dev/null +++ b/Help/variable/include/LINK_LIBRARY_PREDEFINED_FEATURES.rst @@ -0,0 +1,111 @@ +``DEFAULT`` + This feature corresponds to standard linking, essentially equivalent to + using no feature at all. It is typically only used with the + :prop_tgt:`LINK_LIBRARY_OVERRIDE` and + :prop_tgt:`LINK_LIBRARY_OVERRIDE_` target properties. + +``WHOLE_ARCHIVE`` + Force inclusion of all members of a static library when linked as a + dependency of consuming :ref:`Executables`, :ref:`Shared Libraries`, + and :ref:`Module Libraries`. This feature is only supported for the + following platforms, with limitations as noted: + + * Linux. + * All BSD variants. + * SunOS. + * All Apple variants. The library must be specified as a CMake target name, + a library file name (such as ``libfoo.a``), or a library file path (such as + ``/path/to/libfoo.a``). Due to a limitation of the Apple linker, it + cannot be specified as a plain library name like ``foo``, where ``foo`` + is not a CMake target. + * Windows. When using a MSVC or MSVC-like toolchain, the MSVC version must + be greater than 1900. + * Cygwin. + * MSYS. + + .. note:: + + Since :ref:`Static Libraries` are archives and not linked binaries, + CMake records their link dependencies for transitive use when linking + consuming binaries. Therefore ``WHOLE_ARCHIVE`` does not cause a + static library's objects to be included in other static libraries. + Use :ref:`Object Libraries` for that. + +``FRAMEWORK`` + This option tells the linker to search for the specified framework using + the ``-framework`` linker option. It can only be used on Apple platforms, + and only with a linker that understands the option used (i.e. the linker + provided with Xcode, or one compatible with it). + + The framework can be specified as a CMake framework target, a bare framework + name, or a file path. If a target is given, that target must have the + :prop_tgt:`FRAMEWORK` target property set to true. For a file path, if it + contains a directory part, that directory will be added as a framework + search path. + + .. code-block:: cmake + + add_library(lib SHARED ...) + target_link_libraries(lib PRIVATE "$") + + # The constructed linker command line will contain: + # -F/path/to -framework my_framework + + File paths must conform to one of the following patterns (``*`` is a + wildcard, and optional parts are shown as ``[...]``): + + * ``[/path/to/]FwName[.framework]`` + * ``[/path/to/]FwName.framework/FwName[suffix]`` + * ``[/path/to/]FwName.framework/Versions/*/FwName[suffix]`` + + Note that CMake recognizes and automatically handles framework targets, + even without using the :genex:`$` expression. + The generator expression can still be used with a CMake target if the + project wants to be explicit about it, but it is not required to do so. + The linker command line may have some differences between using the + generator expression or not, but the final result should be the same. + On the other hand, if a file path is given, CMake will recognize some paths + automatically, but not all cases. The project may want to use + :genex:`$` for file paths so that the expected + behavior is clear. + + .. versionadded:: 3.25 + The :prop_tgt:`FRAMEWORK_MULTI_CONFIG_POSTFIX_` target property as + well as the ``suffix`` of the framework library name are now supported by + the ``FRAMEWORK`` features. + +``NEEDED_FRAMEWORK`` + This is similar to the ``FRAMEWORK`` feature, except it forces the linker + to link with the framework even if no symbols are used from it. It uses + the ``-needed_framework`` option and has the same linker constraints as + ``FRAMEWORK``. + +``REEXPORT_FRAMEWORK`` + This is similar to the ``FRAMEWORK`` feature, except it tells the linker + that the framework should be available to clients linking to the library + being created. It uses the ``-reexport_framework`` option and has the + same linker constraints as ``FRAMEWORK``. + +``WEAK_FRAMEWORK`` + This is similar to the ``FRAMEWORK`` feature, except it forces the linker + to mark the framework and all references to it as weak imports. It uses + the ``-weak_framework`` option and has the same linker constraints as + ``FRAMEWORK``. + +``NEEDED_LIBRARY`` + This is similar to the ``NEEDED_FRAMEWORK`` feature, except it is for use + with non-framework targets or libraries (Apple platforms only). + It uses the ``-needed_library`` or ``-needed-l`` option as appropriate, + and has the same linker constraints as ``NEEDED_FRAMEWORK``. + +``REEXPORT_LIBRARY`` + This is similar to the ``REEXPORT_FRAMEWORK`` feature, except it is for use + with non-framework targets or libraries (Apple platforms only). + It uses the ``-reexport_library`` or ``-reexport-l`` option as appropriate, + and has the same linker constraints as ``REEXPORT_FRAMEWORK``. + +``WEAK_LIBRARY`` + This is similar to the ``WEAK_FRAMEWORK`` feature, except it is for use + with non-framework targets or libraries (Apple platforms only). + It uses the ``-weak_library`` or ``-weak-l`` option as appropriate, + and has the same linker constraints as ``WEAK_FRAMEWORK``. diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake index 4d09a7f..eb1d78b 100644 --- a/Modules/CheckCCompilerFlag.cmake +++ b/Modules/CheckCCompilerFlag.cmake @@ -33,19 +33,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_c_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake index 8b12343..690345e 100644 --- a/Modules/CheckCSourceCompiles.cmake +++ b/Modules/CheckCSourceCompiles.cmake @@ -35,19 +35,19 @@ Check once if C source code can be built. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_c_source_compiles()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckCSourceRuns.cmake b/Modules/CheckCSourceRuns.cmake index 8fcf22b..d7303f1 100644 --- a/Modules/CheckCSourceRuns.cmake +++ b/Modules/CheckCSourceRuns.cmake @@ -28,19 +28,19 @@ subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_c_source_runs()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckCXXCompilerFlag.cmake b/Modules/CheckCXXCompilerFlag.cmake index f1933f3..6338c7c 100644 --- a/Modules/CheckCXXCompilerFlag.cmake +++ b/Modules/CheckCXXCompilerFlag.cmake @@ -33,19 +33,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_cxx_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] include_guard(GLOBAL) diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index c0402e9..567520b 100644 --- a/Modules/CheckCXXSourceCompiles.cmake +++ b/Modules/CheckCXXSourceCompiles.cmake @@ -35,19 +35,19 @@ Check once if C++ source code can be built. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_cxx_source_compiles()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckCXXSourceRuns.cmake b/Modules/CheckCXXSourceRuns.cmake index b131a6f..2ff98f5 100644 --- a/Modules/CheckCXXSourceRuns.cmake +++ b/Modules/CheckCXXSourceRuns.cmake @@ -28,19 +28,19 @@ subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_cxx_source_runs()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckCXXSymbolExists.cmake b/Modules/CheckCXXSymbolExists.cmake index ada708a..0a14809 100644 --- a/Modules/CheckCXXSymbolExists.cmake +++ b/Modules/CheckCXXSymbolExists.cmake @@ -41,19 +41,19 @@ Check if a symbol exists as a function, variable, or macro in ``C++``. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst For example: diff --git a/Modules/CheckCompilerFlag.cmake b/Modules/CheckCompilerFlag.cmake index 2854fa8..f692bbe 100644 --- a/Modules/CheckCompilerFlag.cmake +++ b/Modules/CheckCompilerFlag.cmake @@ -33,19 +33,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckFortranCompilerFlag.cmake b/Modules/CheckFortranCompilerFlag.cmake index c04f26c..6ec3b7e 100644 --- a/Modules/CheckFortranCompilerFlag.cmake +++ b/Modules/CheckFortranCompilerFlag.cmake @@ -35,19 +35,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_fortran_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckFortranFunctionExists.cmake b/Modules/CheckFortranFunctionExists.cmake index 1c73604..ba5f989 100644 --- a/Modules/CheckFortranFunctionExists.cmake +++ b/Modules/CheckFortranFunctionExists.cmake @@ -29,11 +29,11 @@ Check if a Fortran function exists. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst #]=======================================================================] include_guard(GLOBAL) diff --git a/Modules/CheckFortranSourceCompiles.cmake b/Modules/CheckFortranSourceCompiles.cmake index 39176e2..668aaae 100644 --- a/Modules/CheckFortranSourceCompiles.cmake +++ b/Modules/CheckFortranSourceCompiles.cmake @@ -43,19 +43,19 @@ Check once if Fortran source code can be built. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_fortran_source_compiles()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckFortranSourceRuns.cmake b/Modules/CheckFortranSourceRuns.cmake index 62c6ac5..bf4f5f9 100644 --- a/Modules/CheckFortranSourceRuns.cmake +++ b/Modules/CheckFortranSourceRuns.cmake @@ -41,19 +41,19 @@ subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_fortran_source_runs()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake index 4c73ea6..ae30845 100644 --- a/Modules/CheckFunctionExists.cmake +++ b/Modules/CheckFunctionExists.cmake @@ -19,19 +19,19 @@ Check once if a C function can be linked from system libraries. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst .. note:: diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake index a3a2cee..b053e3d 100644 --- a/Modules/CheckIncludeFile.cmake +++ b/Modules/CheckIncludeFile.cmake @@ -21,19 +21,19 @@ Provides a macro to check if a header file can be included in ``C``. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Examples ^^^^^^^^ diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake index 756abf1..ed4e031 100644 --- a/Modules/CheckIncludeFileCXX.cmake +++ b/Modules/CheckIncludeFileCXX.cmake @@ -21,19 +21,19 @@ Provides a macro to check if a header file can be included in ``CXX``. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Examples ^^^^^^^^ diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake index 855d450..954d47a 100644 --- a/Modules/CheckIncludeFiles.cmake +++ b/Modules/CheckIncludeFiles.cmake @@ -27,19 +27,19 @@ be included together. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Examples ^^^^^^^^ diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake index e739955..da242a1 100644 --- a/Modules/CheckLibraryExists.cmake +++ b/Modules/CheckLibraryExists.cmake @@ -25,17 +25,17 @@ a library. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Examples ^^^^^^^^ diff --git a/Modules/CheckOBJCCompilerFlag.cmake b/Modules/CheckOBJCCompilerFlag.cmake index 9d00d04..8d9e78d 100644 --- a/Modules/CheckOBJCCompilerFlag.cmake +++ b/Modules/CheckOBJCCompilerFlag.cmake @@ -35,19 +35,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objc_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckOBJCSourceCompiles.cmake b/Modules/CheckOBJCSourceCompiles.cmake index bea3de9..ce89fc4 100644 --- a/Modules/CheckOBJCSourceCompiles.cmake +++ b/Modules/CheckOBJCSourceCompiles.cmake @@ -37,19 +37,19 @@ Check once if Objective-C source can be built. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objc_source_compiles()`` -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckOBJCSourceRuns.cmake b/Modules/CheckOBJCSourceRuns.cmake index 1c33837..3484c58 100644 --- a/Modules/CheckOBJCSourceRuns.cmake +++ b/Modules/CheckOBJCSourceRuns.cmake @@ -30,19 +30,19 @@ can subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objc_source_runs()`` -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckOBJCXXCompilerFlag.cmake b/Modules/CheckOBJCXXCompilerFlag.cmake index a853475..691f5aa 100644 --- a/Modules/CheckOBJCXXCompilerFlag.cmake +++ b/Modules/CheckOBJCXXCompilerFlag.cmake @@ -35,19 +35,19 @@ The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objcxx_compiler_flag()``. Unknown flags in these variables can case a false negative result. -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckOBJCXXSourceCompiles.cmake b/Modules/CheckOBJCXXSourceCompiles.cmake index dd1a209..4f9f7d4 100644 --- a/Modules/CheckOBJCXXSourceCompiles.cmake +++ b/Modules/CheckOBJCXXSourceCompiles.cmake @@ -37,19 +37,19 @@ Check once if Objective-C++ source can be built. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objcxx_source_compiles()`` -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckOBJCXXSourceRuns.cmake b/Modules/CheckOBJCXXSourceRuns.cmake index 93ac155..acdee34 100644 --- a/Modules/CheckOBJCXXSourceRuns.cmake +++ b/Modules/CheckOBJCXXSourceRuns.cmake @@ -30,19 +30,19 @@ and can subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_objcxx_source_runs()`` -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckPrototypeDefinition.cmake b/Modules/CheckPrototypeDefinition.cmake index 8854613..63daabf 100644 --- a/Modules/CheckPrototypeDefinition.cmake +++ b/Modules/CheckPrototypeDefinition.cmake @@ -44,19 +44,19 @@ Check if a ``C`` function has the expected prototype. The following variables may be set before calling this function to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Examples ^^^^^^^^ diff --git a/Modules/CheckSourceCompiles.cmake b/Modules/CheckSourceCompiles.cmake index 97e3252..734b0d3 100644 --- a/Modules/CheckSourceCompiles.cmake +++ b/Modules/CheckSourceCompiles.cmake @@ -66,19 +66,19 @@ Check once if source code can be built for a given language. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_source_compiles()``: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckSourceRuns.cmake b/Modules/CheckSourceRuns.cmake index 7a18a4a..fcce30d 100644 --- a/Modules/CheckSourceRuns.cmake +++ b/Modules/CheckSourceRuns.cmake @@ -52,19 +52,19 @@ subsequently be run. The compile and link commands can be influenced by setting any of the following variables prior to calling ``check_source_runs()`` -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Modules/CheckStructHasMember.cmake b/Modules/CheckStructHasMember.cmake index f1d39bd..58b519d 100644 --- a/Modules/CheckStructHasMember.cmake +++ b/Modules/CheckStructHasMember.cmake @@ -30,19 +30,19 @@ Check if the given struct or class has the specified member variable The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst Example ^^^^^^^ diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index 6d9301c..72a7e1b 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -31,19 +31,19 @@ If the check needs to be done in C++, consider using The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst For example: diff --git a/Modules/CheckTypeSize.cmake b/Modules/CheckTypeSize.cmake index c733aae..e2db870 100644 --- a/Modules/CheckTypeSize.cmake +++ b/Modules/CheckTypeSize.cmake @@ -68,19 +68,19 @@ member you can do something like this: The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt +.. include:: /module/include/CMAKE_REQUIRED_INCLUDES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_DIRECTORIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst ``CMAKE_EXTRA_INCLUDE_FILES`` list of extra headers to include. diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake index 25d871e..0e4b899 100644 --- a/Modules/CheckVariableExists.cmake +++ b/Modules/CheckVariableExists.cmake @@ -21,15 +21,15 @@ Check if the variable exists. The following variables may be set before calling this macro to modify the way the check is run: -.. include:: /module/CMAKE_REQUIRED_FLAGS.txt +.. include:: /module/include/CMAKE_REQUIRED_FLAGS.rst -.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_DEFINITIONS.rst -.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt +.. include:: /module/include/CMAKE_REQUIRED_LINK_OPTIONS.rst -.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt +.. include:: /module/include/CMAKE_REQUIRED_LIBRARIES.rst -.. include:: /module/CMAKE_REQUIRED_QUIET.txt +.. include:: /module/include/CMAKE_REQUIRED_QUIET.rst #]=======================================================================] diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in index 2c29042..948bb8e 100644 --- a/Utilities/Sphinx/conf.py.in +++ b/Utilities/Sphinx/conf.py.in @@ -22,7 +22,11 @@ primary_domain = 'cmake' highlight_language = 'none' exclude_patterns = [ - 'dev', # ignore developer-only documentation + # Ignore developer-only documentation + 'dev', + # NOTE Ignore shared RST files used in `.. include::` directives + 'include/*.rst', + '**/include/*.rst' ] extensions = ['cmake'] -- cgit v0.12