summaryrefslogtreecommitdiffstats
path: root/Help
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'doc-custom-command-depfiles'Brad King2021-07-261-18/+23
|\ | | | | | | | | | | | | f6e5743d0e Help: Clarify and correct wording around DEPFILE option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6387
| * Help: Clarify and correct wording around DEPFILE optionCraig Scott2021-07-241-18/+23
| | | | | | | | | | | | | | The previous wording contradicted itself regarding whether Visual Studio generators were supported, and about when generator expressions could be used. Restructure the paragraphs and max it clearer what support was added in which CMake versions.
* | Merge topic 'doc-ctest-output'Craig Scott2021-07-264-5/+13
|\ \ | | | | | | | | | | | | | | | | | | | | | ba6d1947b6 Help: Add cross-references between test output size ctest variables cdde9e5a10 Help: Improve wording and cross-referencing for ctest JUnit output Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6389
| * | Help: Add cross-references between test output size ctest variablesCraig Scott2021-07-262-0/+6
| | |
| * | Help: Improve wording and cross-referencing for ctest JUnit outputCraig Scott2021-07-252-5/+7
| |/
* | Merge topic 'iar-exe-suffix'Brad King2021-07-203-1/+10
|\ \ | |/ | | | | | | | | | | | | 09bc0785ee Help: Document CMAKE_EXECUTABLE_SUFFIX_<LANG> explicitly 05a3bafe65 Compiler/IAR: Avoid clobbering CMAKE_EXECUTABLE_SUFFIX Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6357
| * Help: Document CMAKE_EXECUTABLE_SUFFIX_<LANG> explicitlyLorenzo Cappelletti2021-07-203-1/+10
| | | | | | | | | | Documentation for `CMAKE_EXECUTABLE_SUFFIX_<LANG>`, useful when cross-compiling, is buried in section `CMAKE_EXECUTABLE_SUFFIX`.
| * Merge topic 'doc-policies-3.21' into release-3.21Brad King2021-07-204-26/+54
| |\ | | | | | | | | | | | | | | | | | | | | | | | | 7b5fa0f7b4 Help: Make policy CMP0126 wording more accurate c4bc250f8c Help: Explain policy CMP0125 in more detail 6d5f74fcd7 Help: Clarify wording of CMP0124 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6360
| * \ Merge topic 'doc-cleanups-3.21' into release-3.21Craig Scott2021-07-203-30/+47
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 8d1944c675 Help: Expand details for file(COPY_FILE) c8ea886123 Help: Re-order file() sub-commands in Filesystem section b5a96716eb Help: Clarify which project() call PROJECT_IS_TOP_LEVEL is for 8be7694d97 Help: Fix trivial typo Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6361
| * \ \ Merge topic 'Help-ctest_memcheck-shared-args' into release-3.21Brad King2021-07-192-0/+9
| |\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 85e740312f Help/ctest_test: add a comment to also update `ctest_memcheck` 731cfd45fd Help/ctest_memcheck: mention `ctest_test` arguments Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6351
* | \ \ \ Merge topic 'doc-policies-3.21'Brad King2021-07-204-26/+54
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 7b5fa0f7b4 Help: Make policy CMP0126 wording more accurate c4bc250f8c Help: Explain policy CMP0125 in more detail 6d5f74fcd7 Help: Clarify wording of CMP0124 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6360
| * | | | Help: Make policy CMP0126 wording more accurate Craig Scott2021-07-172-7/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The OLD behavior only removes a non-cache variable of the same name in specific circumstances. The previous wording implied that it would always occur. Also add a note about the behavior compared to the analogous CMP0077 policy, which affects the option() command in a similar but subtly different way.
| * | | | Help: Explain policy CMP0125 in more detailCraig Scott2021-07-171-12/+29
| | | | |
| * | | | Help: Clarify wording of CMP0124Craig Scott2021-07-171-7/+5
| | | | |
* | | | | Merge topic 'doc-cleanups-3.21'Craig Scott2021-07-203-30/+47
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 8d1944c675 Help: Expand details for file(COPY_FILE) c8ea886123 Help: Re-order file() sub-commands in Filesystem section b5a96716eb Help: Clarify which project() call PROJECT_IS_TOP_LEVEL is for 8be7694d97 Help: Fix trivial typo Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6361
| * | | | Help: Expand details for file(COPY_FILE)Craig Scott2021-07-191-2/+18
| | | | |
| * | | | Help: Re-order file() sub-commands in Filesystem sectionCraig Scott2021-07-191-28/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The file(COPY_FILE) sub-command is closely related to the file(COPY) sub-command. Move the former to just before the latter for improved continuity. The file(RENAME) sub-command is also somewhat related to file(COPY_FILE), so it was also moved to keep it just before file(COPY_FILE). The file(MAKE_DIRECTORY) sub-command was also moved to just before the file(REMOVE) and file(REMOVE_RECURSE) sub-commands to keep them together and improve logical flow of operations.
| * | | | Help: Clarify which project() call PROJECT_IS_TOP_LEVEL is forCraig Scott2021-07-181-1/+2
| | | | |
| * | | | Help: Fix trivial typoCraig Scott2021-07-181-1/+1
| |/ / /
* | | | Merge topic 'Help-ctest_memcheck-shared-args'Brad King2021-07-192-0/+9
|\ \ \ \ | | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | 85e740312f Help/ctest_test: add a comment to also update `ctest_memcheck` 731cfd45fd Help/ctest_memcheck: mention `ctest_test` arguments Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6351
| * | | Help/ctest_test: add a comment to also update `ctest_memcheck`Ben Boeckel2021-07-191-0/+4
| | | | | | | | | | | | | | | | | | | | Since these commands share a common argument parser, the documentation should be kept synchronized.
| * | | Help/ctest_memcheck: mention `ctest_test` argumentsBen Boeckel2021-07-141-0/+5
| |/ / | | | | | | | | | | | | These are handled internally by inheriting `ctest_test`'s argument bindings. Synchronize the documentation.
* | | Merge topic 'vs2022'Brad King2021-07-193-5/+14
|\ \ \ | | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 0c7f918fb1 VS: Update Visual Studio 17 2022 generator for Preview 2 1ac1436b25 VS: Fix `/sourceDependencies` flag table entries for v143 919fc7fd5f VS: Remove broken EnableASAN entry from flag table for v143 3f19847b28 VS: Remove empty ExternalWarningLevel entry from flag table for v143 ccb6083cbe VS: Remove empty LanguageStandard entries from flag table for v143 c167de7e70 VS: Remove empty ConformanceMode entry from flag table for v143 993d706a17 VS: Populate `/JMC-` flag table entry for v143 a070d87e08 VS: Populate `-Qspectre-` flag table entry for v143 ... Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Egor Pugin <egor.pugin@gmail.com> Merge-request: !6350
| * | VS: Update Visual Studio 17 2022 generator for Preview 2Brad King2021-07-153-5/+14
| |/ | | | | | | | | | | In particular, update to toolset `v143`. Fixes: #22339
* | Merge topic 'doc-cmake-build-signature'Brad King2021-07-141-1/+2
|\ \ | |/ | | | | | | | | | | 161f1f42d6 Help: Clarify 'cmake --build' signature alternatives Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6343
| * Help: Clarify 'cmake --build' signature alternativesBrad King2021-07-131-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Documentation added by * commit 4f4f2028b8 (Help: Add documentation for buildPresets and testPresets, 2021-01-13, v3.20.0-rc1~51^2~7) * commit 676ecf0d37 (cmake-presets: Add build and test presets, 2020-12-14, v3.20.0-rc1~51^2~6) used square brackets in the `cmake --build` signature to indicate non-optional alternatives, which is not a typical convention. A common convention is to use parentheses instead, but in this case it is probably clearer to list the two signatures separately. Fixes: #22413
* | Merge topic 'ctest-environment-modifications'Brad King2021-07-134-2/+43
|\ \ | | | | | | | | | | | | | | | | | | | | | de4f1f26b0 CTest: add an ENVIRONMENT_MODIFICATION property 4c757fa3c8 Help/prop_test/ENVIRONMENT: clarify the scope of the changes Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6299
| * | CTest: add an ENVIRONMENT_MODIFICATION propertyBen Boeckel2021-07-093-0/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This property allows projects to modify environment variables at test time rather than trying to guess what the state should be based on what is present at configure time. Of particular interest is the ability to use a `PATH` present at test time while adding entries known to be necessary for the test itself. There are multiple operations provided to modify variables, including: - setting and unsetting - appending and prepending as: - strings - path lists - CMake lists Additionally, a `reset` action is provided to cancel any prior modifications to that particular variable in the case of incremental additions to the test property.
| * | Help/prop_test/ENVIRONMENT: clarify the scope of the changesBen Boeckel2021-07-081-2/+2
| | | | | | | | | | | | | | | | | | | | | The "restored" bit is an implementation detail as it could also be implemented by passing a crafted environment to `execve` or `CreateProcess` arguments. Instead, state that the environment changes only affects the test with the property set.
* | | Merge topic 'UseSWIG-dependencies-VS-generators'Brad King2021-07-131-0/+6
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | d1bece92d5 UseSWIG: Use swig generated dependencies for Visual Studio Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6327
| * | | UseSWIG: Use swig generated dependencies for Visual StudioMarc Chevrier2021-07-091-0/+6
| | | |
* | | | Merge topic 'doc-preset-example-v3'Brad King2021-07-131-1/+1
|\ \ \ \ | | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | 2114d717a0 Help: Fix preset example cmakeMinimumRequired Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Kyle Edwards <kyle.edwards@kitware.com> Merge-request: !6333
| * | | Help: Fix preset example cmakeMinimumRequiredSérgio Martins2021-07-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since commit 8bc5c8961e (CMakePresets.json: Add the ability to conditionally disable presets, 2021-03-10, v3.21.0-rc1~464^2) the example requires presets version 3 support, which is not available until CMake 3.21. CMake 3.20.0 can't open v3 presets. Make cmakeMinimumRequired compatible with the example's version.
| * | | Merge topic 'help_toplevel' into release-3.21Brad King2021-07-082-0/+20
| |\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 2df4badc5f Help: Note PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProject Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6307
* | \ \ \ Merge topic 'LWYU-externalization'Brad King2021-07-126-10/+42
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 14e57e9637 LINK_WHAT_YOU_USE feature: externalize configuration 9c5132a586 PGI: Fix "LINKER:" prefix generated separator 8a93de080c cmGeneratorTarget: Add method for LINKER: prefix translation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6306
| * | | | | LINK_WHAT_YOU_USE feature: externalize configurationMarc Chevrier2021-07-096-10/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, this feature is only supported on ELF platforms. So, the property LINK_WHAT_YOU_USE will be ignored for other plateforms. Moreover, flags and commands are now controled by CMake variables. Fixes: #20174
* | | | | | Merge topic 'cpack-rpm-requires-exclude-from'Brad King2021-07-122-0/+17
|\ \ \ \ \ \ | |_|_|_|/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | bb5fc38209 CPack/RPM: Add option to set %global __requires_exclude_from Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6324
| * | | | | CPack/RPM: Add option to set %global __requires_exclude_fromLisa Welsch2021-07-092-0/+17
| | | | | |
* | | | | | Merge topic 'help_toplevel'Brad King2021-07-082-0/+20
|\ \ \ \ \ \ | | |_|_|/ / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | 2df4badc5f Help: Note PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProject Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6307
| * | | | | Help: Note PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProjectMichael Hirsch2021-07-082-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Extend the documentation added by commit 96a7040107 (project: Define variables indicating whether project is top level, 2021-03-24, v3.21.0-rc1~443^2) to give some examples of how the variables are set in each context.
* | | | | | Merge topic 'doc-lang-std'Brad King2021-07-083-3/+54
|\ \ \ \ \ \ | |_|/ / / / |/| | | / / | | |_|/ / | |/| | | | | | | | | | | | | | | | | | | | | | | d69b46bf01 Help: Document when CUDA_STANDARD values were added bdb59839b9 Help: Document when OBJCXX_STANDARD values were added 627aca946b Help: Document when OBJC_STANDARD values as definition list Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6321
| * | | | Help: Document when CUDA_STANDARD values were addedBrad King2021-07-081-1/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Note that some CUDA C++ language standard levels were added before any compilers actually supported them. In such cases, the value of `CUDA_STANDARD` gracefully degrades to the highest supported by the compiler (unless `CUDA_STANDARD_REQUIRED` is enabled). Therefore we can document support for each value based on when CMake learned of it.
| * | | | Help: Document when OBJCXX_STANDARD values were addedBrad King2021-07-081-1/+21
| | | | |
| * | | | Help: Document when OBJC_STANDARD values as definition listBrad King2021-07-081-1/+10
| |/ / /
* | | | find_package: Add variable to make package REQUIREDEugene Shalygin2021-07-086-3/+34
| |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a `CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>` variable is complement to `CMAKE_DISABLE_FIND_PACKAGE_<PackageName>` with just the opposite behaviour: it turns non-required find_package call into the required one. While optional package dependencies usually result in simple and clean build logic, sometimes people want to be sure those optional dependencies will be found and used. Examples are reproducible builds and build instructions for 3rd parties. People choose to make find_package calls REQUIRED and put them behind an option(). Such workarounds blend build logic with build environment management and do not look elegant.
* | | Merge topic 'help_cxxstd'Brad King2021-07-071-1/+25
|\ \ \ | |/ / | | | | | | | | | | | | | | | 5650bebc2f Help: Note CXX_STANDARD values added vs. CMake version Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6305
| * | Help: Note CXX_STANDARD values added vs. CMake versionMichael Hirsch2021-07-061-1/+25
| | |
* | | Merge topic 'doc-3.21-release'Craig Scott2021-07-062-61/+75
|\ \ \ | |/ / | | / | |/ |/| | | | | | | | | 24b76eaa93 Help: Improve readability and accuracy of runtime deps-related content 308e5b30c9 Help: Tighten install(SCRIPT) wording for ALL_COMPONENTS option 52dec01729 Help: Add missing versionadded 3.21 for file(RENAME) options Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6302
| * Help: Improve readability and accuracy of runtime deps-related contentCraig Scott2021-07-042-55/+64
| | | | | | | | | | | | Duplicated textual patterns are factored out to make the text more readable. The POST_INCLUDE_FILES and POST_EXCLUDE_FILES were also previously missing from the main syntax block for install(RUNTIME_DEPENDENCY_SET).
| * Help: Tighten install(SCRIPT) wording for ALL_COMPONENTS optionCraig Scott2021-07-031-6/+7
| | | | | | | | | | In particular, mention the mutually exclusive nature with the COMPONENT option. Fix the inconsistent way the versionadded details were added for that text too.
generated by cgit v0.12 at 2025-01-31 10:12:38 (GMT)