summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* Help: Restructure the find_package() docsCraig Scott2021-09-231-176/+231
| | | | | | | | | | | | | | | | | | | | | | The explanation of the basic and full signatures was interwoven tightly with that of the Module and Config search modes. Config mode is supported by both signatures, which made the structure of the command documentation a bit confusing. Add a section at the start which unambiguously describes the two modes, including the fallback functionality between them. Move the text about this out of the basic signature section, leaving just a description of the basic syntax with a note that it is supported by both search modes. This makes the basic signature section more focused. Drop the Module and Config mode parts of the titles for the basic and full signature sections. Those are now more precisely covered by the new opening section, so the Basic Signature and Full Signature sections are now clearer in what they cover. Swap the order of the Search Procedure and Version Selection sections to improve the logical flow. Also add "Config Mode" to their titles to make it clearer what they apply to. Add a note at the start of both sections to highlight their relationship to the basic and full signatures.
* Merge topic 'document_find_package_version_restrictions'Craig Scott2021-09-111-5/+6
|\ | | | | | | | | | | | | 563139e5e9 Help: find_package document version only supports numeric components Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6510
| * Help: find_package document version only supports numeric componentsRobert Maynard2021-09-091-5/+6
| |
* | Merge topic 'ctest-memcheck-generate-test.xml'Brad King2021-09-101-1/+2
|\ \ | |/ |/| | | | | | | | | | | ce44c2cec3 ctest_memcheck: generate `DynamicAnalysis-Test.xml` as well Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !6491
| * ctest_memcheck: generate `DynamicAnalysis-Test.xml` as wellBen Boeckel2021-09-091-1/+2
| | | | | | | | | | | | | | This is useful so that memcheck results also show up as test results on CDash. It will be submitted with the other `MemCheck` parts. Fixes: #22190
* | Help: Fix terminology for regular expression in if(MATCHES)Johel Ernesto Guerrero Peña2021-08-281-1/+1
|/ | | | | This was wrongly changed in commit ba90611225 (Help: Make synopsis of if command more compact; add section headers, 2018-10-05).
* Merge topic 'find-package-note'Brad King2021-08-251-1/+1
|\ | | | | | | | | | | | | d7e521bcd3 Help: find_package: Tweak change description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6477
| * Help: find_package: Tweak change descriptionFeRD (Frank Dana)2021-08-241-1/+1
| |
* | Merge topic 'host-distro-info'Brad King2021-08-241-39/+229
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | b9698f89df cmake_host_system_information: Make it available for all systems 5469c71a82 Refactor: Simplify `GetValue()` function calls 6c92f80f2e cmake_host_system_information: Also set `USED_FALLBACK_SCRIPT` efe139d1b8 cmake_host_system_information: Can run fallback scripts 1e65e4a6e5 cmake_host_system_information: Can read `/etc/os-release` file e808cbb1dd Testing: Convert `cmake_host_system_information` tests into `RunCMake` 9e831284e5 Documentation: Use definition list instead of tables 346f3de005 Refactor: Deduplicate code for `VS_nn_DIR` keys processing ... Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !6410
| * | cmake_host_system_information: Make it available for all systemsAlex Turbov2021-08-201-4/+2
| | | | | | | | | | | | Before it was Linux only.
| * | cmake_host_system_information: Can run fallback scriptsAlex Turbov2021-08-201-0/+67
| | |
| * | cmake_host_system_information: Can read `/etc/os-release` fileAlex Turbov2021-08-201-0/+45
| | |
| * | Documentation: Use definition list instead of tablesAlex Turbov2021-07-301-39/+119
| | | | | | | | | | | | | | | Transform tables into definition list for `cmake_host_system_information` command manual.
* | | Help: get/set_property: Fix SOURCE grammarsFeRD (Frank Dana)2021-08-232-3/+3
| |/ |/|
* | Merge topic 'symlinks-rebase-master'Brad King2021-08-102-0/+9
|\ \ | | | | | | | | | | | | | | | | | | | | | 58d10cf6f1 Alternative symlink-creating mode for file(INSTALL ...) Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !6396
| * | Alternative symlink-creating mode for file(INSTALL ...)Felix Lelchuk2021-08-022-0/+9
| |/ | | | | | | | | | | | | | | | | | | | | An new environment variable 'CMAKE_INSTALL_MODE' is introduced, which can be used to ask CMake to create symbolic links instead of copying files during a file(INSTALL ...). The operation is at the file level only, directory trees are still created using actual directories, not links. Signed-off-by: Felix Lelchuk <felix.lelchuk@gmx.de>
* | Merge topic 'doc-find_package-components'Craig Scott2021-08-091-5/+20
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | b7d4567769 Help: Clarify find_package() component handling Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Brad King <brad.king@kitware.com> Acked-by: Michael Hirsch <michael@scivision.dev> Acked-by: Alex <leha-bot@yandex.ru> Merge-request: !6436
| * | Help: Clarify find_package() component handlingCraig Scott2021-08-081-5/+20
| | | | | | | | | Fixes: #22513
* | | Merge topic 'help_cmake_path'Brad King2021-08-091-2/+2
|\ \ \ | |/ / |/| | | | | | | | | | | | | | bb19af546b Help: cmake_path: add missing parameter Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6431
| * | Help: cmake_path: add missing parameterMichael Hirsch2021-08-061-2/+2
| | | | | | | | | | | | for cmake_path(`CONVERT` ... [NORMALIZE]) was missing in top summary
* | | Merge topic 'string-TIMESTAMP-specifier-V'Brad King2021-08-031-28/+63
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | aafa392c12 string(TIMESTAMP): Add %V specifier for ISO 8601 week number a915f691ad Help: Format string(TIMESTAMP) format specifiers as a definition list Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6374
| * | | string(TIMESTAMP): Add %V specifier for ISO 8601 week numberAntons Jeļkins2021-08-021-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | In ISO 8601 weeks begin with Monday. The first week of the year is the week which contains the first Thursday of the year.
| * | | Help: Format string(TIMESTAMP) format specifiers as a definition listBrad King2021-07-231-28/+58
| | | | | | | | | | | | | | | | Also fix the version that added `%A` and `%B`.
* | | | Merge topic 'help-get_filename_path-fix-version-changed'Brad King2021-08-031-1/+1
|\ \ \ \ | | |/ / | |/| / | |_|/ |/| | | | | | | | 8b28fe5670 Help: get_filename_component: fix version info for cmake_path Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6423
| * | Help: get_filename_component: fix version info for cmake_pathMarc Chevrier2021-08-021-1/+1
| | | | | | | | | | | | Fixes: #22505
| * | Merge topic 'doc-custom-command-depfiles' into release-3.21Brad King2021-07-261-18/+23
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | f6e5743d0e Help: Clarify and correct wording around DEPFILE option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6387
* | \ \ 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-261-3/+3
|\ \ \ \ | | |/ / | |/| / | |_|/ |/| | | | | | | | | | | 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: Improve wording and cross-referencing for ctest JUnit outputCraig Scott2021-07-251-3/+3
| |/
| * Merge topic 'doc-cleanups-3.21' into release-3.21Craig Scott2021-07-202-29/+45
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 'doc-cleanups-3.21'Craig Scott2021-07-202-29/+45
|\ \ \ | | |/ | |/| | | | | | | | | | | | | | | | | | | | | | 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: 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.
* | find_package: Add variable to make package REQUIREDEugene Shalygin2021-07-081-2/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 '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.
| * Help: Add missing versionadded 3.21 for file(RENAME) optionsCraig Scott2021-07-031-0/+4
| |
* | help: update ctest attached file exampleZack Galbreath2021-07-011-2/+4
| | | | | | | | Clarify that multiple files can be attached to a given test at runtime
* | ctest: support <CTestMeasurement> for runtime measurementsZack Galbreath2021-07-011-13/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Teach CTest to parse output for <CTestMeasurement> in addition to <DartMeasurement> for measurements defined at runtime. Use a new class (cmCTestTestMeasurementXMLParser) derived from cmXMLParser to parse the data and attributes these XML elements. This is an improvement over our previous approach of using a series of regular expressions. As part of this commit we also rename some member variables and methods to make their purpose more clear. DartStuff -> AllTestMeasurementsRegex DartStuff1 -> SingleTestMeasurementRegex DartString -> TestMeasurementsOutput GenerateDartOutput() -> GenerateCTestXML() GenerateRegressionImages() -> RecordCustomTestMeasurements() cmCTestRunTest::DartProcessing() -> ParseOutputForMeasurements()
* | Help: Clarify condition of tree command from source_group.Heiko Thiel2021-06-231-1/+2
| |
* | Merge topic 'doc-source_group-scope'Brad King2021-06-211-0/+3
|\ \ | |/ | | | | | | | | | | 2abce79409 Help: Clarify the usage scope of source_group Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6246
| * Help: Clarify the usage scope of source_groupHeiko Thiel2021-06-181-0/+3
| | | | | | | | Fixes: #18856
* | ctest: allow test output to add labelsZack Galbreath2021-06-171-0/+15
|/ | | | | Parse test output for <CTestLabel>...</CTestLabel>. If found, add this value to the list of labels associated with this test.
* Help: cmake_path: fix erroneous example for IS_PREFIXMarc Chevrier2021-06-121-3/+4
| | | | Fixes: #22302
generated by cgit v0.12 at 2025-02-10 14:46:19 (GMT)