summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* Help: Add Synopsis section to install, list, and string docsBrad King2018-05-073-99/+132
| | | | | | | | | Summarize the command signatures in one block at the top of the documentation as is typical in Unix command-line tool manuals. Make the mode keywords links to the corresponding full signature and documentation. Issue: #17948
* Help: Improve list command signature group name for read operationsBrad King2018-05-071-2/+2
| | | | | The LENGTH, GET, JOIN, and SUBLIST operations all read the list without modifying it. Name their section appropriately.
* Help: Re-order file command docsBrad King2018-05-071-125/+125
| | | | Prepare for the addition of section headers for grouping commands.
* Merge topic 'feature/cpack-default-package-version'Craig Scott2018-05-031-2/+3
|\ | | | | | | | | | | | | | | af1c48871c CPack: Use project version as default for `CPACK_PACKAGE_VERSION` Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Harry Mallon <hjmallon@gmail.com> Merge-request: !2020
| * CPack: Use project version as default for `CPACK_PACKAGE_VERSION`Alex Turbov2018-05-021-2/+3
| | | | | | | | | | | | | | | | | | | | * Introduce `CMAKE_PROJECT_VERSION` and the corresponsing components: `CMAKE_PROJECT_VERSION_MAJOR`, `CMAKE_PROJECT_VERSION_MINOR`, `CMAKE_PROJECT_VERSION_PATCH` and `CMAKE_PROJECT_VERSION_TWEAK`. * `CPack` module use `CMAKE_PROJECT_VERSION_MAJOR`, `CMAKE_PROJECT_VERSION_MINOR` and `CMAKE_PROJECT_VERSION_PATCH` to initialize corresponsing CPack variables.
* | Merge topic 'namelink-component'Brad King2018-05-031-67/+175
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 7e8046e20b Help: add release notes for NAMELINK_COMPONENT c02eeb0853 Help: clarify "undefined behavior" in install(EXPORT) command edcb545a24 install: add test for new NAMELINK_COMPONENT parameter 0212d7c762 install: add NAMELINK_COMPONENT argument cbb609072f Help: clean up install(TARGETS) documentation b81280ba1f Help: add list of command signatures to top of INSTALL page Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Alex Turbov <i.zaufi@gmail.com> Merge-request: !1982
| * | Help: clarify "undefined behavior" in install(EXPORT) commandKyle Edwards2018-05-031-5/+18
| | | | | | | | | | | | | | | | | | | | | The "undefined behavior" that the install(EXPORT) command warned about was simply the possibility of build errors (or other errors) if the referenced targets aren't installed. As long as the referenced targets are installed, this won't be an issue.
| * | install: add NAMELINK_COMPONENT argumentKyle Edwards2018-05-031-8/+51
| | | | | | | | | | | | | | | | | | | | | For shared libraries, this allows you to specify separate components for the shared library and for the namelink. Suggested in https://cmake.org/pipermail/cmake-developers/2014-December/024032.html.
| * | Help: clean up install(TARGETS) documentationKyle Edwards2018-04-301-62/+96
| | | | | | | | | | | | | | | | | | The documentation for install(TARGETS) has been rearranged so that the options are presented as a list, for better readability and maintenance.
| * | Help: add list of command signatures to top of INSTALL pageKyle Edwards2018-04-301-0/+18
| |/
* | Help: Clarify add_custom_command build event execution orderBrad King2018-05-021-4/+3
|/ | | | Fixes: #17949
* Merge topic 'doc-help-spelling'Brad King2018-04-239-17/+17
|\ | | | | | | | | | | | | 20d90a9482 Help: Some spelling corrections for commands. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1994
| * Help: Some spelling corrections for commands.Yee Fan2018-04-209-17/+17
| |
* | Merge topic 'cmake-install-doc'Brad King2018-04-231-0/+23
|\ \ | | | | | | | | | | | | | | | | | | | | | a4f71b4ba8 Help: Document existence of cmake_install.cmake fcf64866da Help: move DESTDIR into a separate page Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1979
| * | Help: Document existence of cmake_install.cmakeKyle Edwards2018-04-201-0/+23
| |/ | | | | | | | | | | This file, which is currently undocumented, is useful for external packaging programs that wish to install only a single component at a time. This change adds documentation for the file.
* | add_compile_definitions: add new commandMarc Chevrier2018-04-204-5/+36
|/ | | | | | | This command manages preprocessor definitions at directory level and supports generator expressions. Fixes: #15374
* typo: incerment -> incrementRolf Eike Beer2018-04-171-1/+1
|
* list: Add TRANSFORM sub-commandMarc Chevrier2018-04-161-0/+73
| | | | Issue: #17823
* Help: Fix install(EXPORT_ANDROID_MK) mode documentationBrad King2018-04-091-4/+5
| | | | | | | | | | `install(EXPORT_ANDROID_MK)` is its own mode, not an option to the normal `install(EXPORT)` mode. While at it, also fix the prose in our documented example to match the code. Fixes: #17891
* Merge topic 'glob_configure_depends'Brad King2018-04-061-2/+11
|\ | | | | | | | | | | | | | | | | | | | | 6c4f8b4596 Adjust help documentation for file(GLOB), add topic notes 20612978c8 Add tests for `file(GLOB)` CONFIGURE_DEPENDS flag 3f4b81f540 Add glob verify support to XCode, VS, Ninja, and Makefile generators ca0befc2e1 Add `CONFIGURE_DEPENDS` flag support to cmFileCommand::HandleGlobCommand 599c93e22d Add cmGlobVerificationManager class, integrate with cmake and cmState Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1767
| * Adjust help documentation for file(GLOB), add topic notesShane Parris2018-04-021-2/+11
| |
* | Drop Visual Studio 8 2005 generatorBrad King2018-04-021-1/+1
|/ | | | This generator has been deprecated since CMake 3.9. Remove it.
* Merge topic 'pr.find_package.prefixes'Craig Scott2018-03-231-9/+21
|\ | | | | | | | | | | | | 4eb5d851d5 Help: Add 'lib32|libx32|lib64' paths to find_package prefixes Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1878
| * Help: Add 'lib32|libx32|lib64' paths to find_package prefixesRuslan Baratov2018-03-211-9/+21
| | | | | | | | | | Document the conditions when 'lib32|libx32|lib64' variants will be added to the list of possible installation prefixes.
* | Merge topic 'list-sublist'Craig Scott2018-03-221-0/+12
|\ \ | | | | | | | | | | | | | | | | | | 768225837d list: Add SUBLIST sub-command Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1874
| * | list: Add SUBLIST sub-commandMarc Chevrier2018-03-211-0/+12
| |/ | | | | | | Issue: #17823
* | Merge topic 'policy-version-range'Craig Scott2018-03-222-22/+33
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | 45408b5ea1 cmake_minimum_required: Optionally set policies with version range 6a41aa2abd cmPolicies: Split parsing and impl of ApplyPolicyVersion 1d00ed7cf7 cmPolicies: Drop unnecessary check from ApplyPolicyVersion 0df559832b cmPolicies: Pass policy version as std::string Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1864
| * | cmake_minimum_required: Optionally set policies with version rangeBrad King2018-03-212-22/+33
| | | | | | | | | | | | | | | | | | | | | | | | Teach `cmake_minimum_required` and `cmake_policy(VERSION)` to support a version range of the form `<min>[...<max>]`. Define this to mean that version `<min>` is required, but known policies up to those introduced by `<max>` will be set to `NEW`. This will allow projects to easily specify a range of versions for which they have been updated.
* | | Merge topic 'clarify_inherited_properties'Brad King2018-03-227-24/+71
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | ff6234509e Help: Clarify behavior of INHERITED properties 9cc97ab4dc Tests: Add tests for INHERITED property chaining Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1879
| * | | Help: Clarify behavior of INHERITED propertiesCraig Scott2018-03-217-24/+71
| | | | | | | | | | | | Fixes: #17839
* | | | Merge topic 'pr.target_compile_definitions'Brad King2018-03-211-0/+10
|\ \ \ \ | |_|_|/ |/| | | | | | | | | | | | | | | | | | | 3af1daa186 Help: Document target_compile_definitions handling of -D Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1873
| * | | Help: Document target_compile_definitions handling of -DRuslan Baratov2018-03-201-0/+10
| |/ / | | | | | | | | | | | | Add an example of using the `target_compile_definitions` command and a note about usage of ``-D`` in items.
* | | Merge topic 'list-join'Brad King2018-03-202-0/+15
|\ \ \ | |/ / |/| | | | | | | | | | | | | | a58158727b list(): add `JOIN` sub-command Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1846
| * | list(): add `JOIN` sub-commandMarc Chevrier2018-03-202-0/+15
| | |
* | | Merge topic 'doc-set_target_properties-clarify'Brad King2018-03-191-2/+4
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | 89ee7ce3ea Help: Reference set_property from set_target_properties c27e3e0f2b Help: Clarify that set_target_properties supports multiple targets Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1866
| * | Help: Reference set_property from set_target_propertiesBrad King2018-03-191-0/+2
| | |
| * | Help: Clarify that set_target_properties supports multiple targetsBrad King2018-03-191-2/+2
| | | | | | | | | | | | Reported-by: Alan W. Irwin <irwin@beluga.phys.uvic.ca>
* | | Merge topic 'find-package_root-restore'Brad King2018-03-196-14/+50
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | eb35d8884b find_package: Use PackageName_ROOT variables as search prefixes Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1858
| * | | find_package: Use PackageName_ROOT variables as search prefixesBrad King2018-03-166-14/+50
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This feature was originally added by commit v3.9.0-rc1~71^2~2 (find_*: Add a new PackageRoot search path group, 2017-05-03) and documented by commit v3.9.0-rc1~71^2 (find_*: Add docs for PackageRoot search path group, 2017-05-03). However, we had to disable the feature and remove the documentation in commit v3.9.1~2^2 (find_*: Disable the PACKAGE_ROOT search path group for CMake 3.9, 2017-08-08) due to breaking projects that used `PackageName_ROOT` variables themselves. Add policy `CMP0074` to restore the `PackageName_ROOT` variable behavior in a compatible way. Also revise the stack of root paths to store the paths themselves rather than the package names. This way the policy can be considered at the `find_package` call site instead of individual `find_` calls inside a find module. Co-Author: Chuck Atkins <chuck.atkins@kitware.com> Issue: #17144
* | | Merge topic 'doc-list-command'Brad King2018-03-191-43/+126
|\ \ \ | |_|/ |/| | | | | | | | | | | | | | 81226c73a4 Help: refresh list() command documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1860
| * | Help: refresh list() command documentationMarc Chevrier2018-03-161-43/+126
| |/ | | | | | | | | Reformat `list` command documentation be consistent with the `string` command.
* | Merge topic 'project-homepage-url'Craig Scott2018-03-171-6/+17
|\ \ | |/ |/| | | | | | | | | | | | | | | 73f9b2974c project: Add HOMEPAGE_URL named parameter fd28c382b4 project: Add <PROJECT-NAME>_DESCRIPTION 9b57cb62ea Help: Fix minor typo in docs for CMAKE_PROJECT_DESCRIPTION c89993d529 Tests: Avoid enabling languages unnecessarily in RunCMake.project Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1816
| * project: Add HOMEPAGE_URL named parameterAlex Turbov2018-03-161-3/+13
| | | | | | | | | | | | | | | | | | This sets variables like PROJECT_HOMEPAGE_URL, which can be used as default values for various things (packaging modules, doxygen defaults, etc.). Some packaging modules have been updated to do this as part of this commit. Co-Author: Craig Scott <craig.scott@crascit.com>
| * project: Add <PROJECT-NAME>_DESCRIPTIONCraig Scott2018-03-161-3/+4
| | | | | | | | For consistency with the VERSION keyword, also define the <PROJECT-NAME>_DESCRIPTION variable.
* | Merge topic 'compile-options-shell'Brad King2018-03-153-0/+13
|\ \ | |/ |/| | | | | | | | | ce0b983216 target_compile_options: Add syntax to specify shell strings Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1841
| * target_compile_options: Add syntax to specify shell stringsBrad King2018-03-143-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Options specified via `COMPILE_OPTIONS` and `INTERFACE_COMPILE_OPTIONS` are deduplicated, but individual options can legitimately be duplicated when grouped with other options, e.g. -D A -D B After deduplication that becomes `-D A B`. Therefore we need a way to treat groups of options as units during deduplication. A simple approach is to specify each group as one option, e.g. "-D A" "-D B" However, that conflicts with options that legitimately have spaces. To break this ambiguity, add a `SHELL:` prefix syntax to specify that an option should be parsed like shell command line arguments after deduplication, e.g. "SHELL:-D A" "SHELL:-D B" These will survive deduplication intact, and then be parsed to produce `-D A -D B` on the final command line. Fixes: #15826
* | Help: Fix incorrect CMAKE_PROJECT_xxx docsCraig Scott2018-03-131-2/+5
|/ | | | | | | | | The docs for CMAKE_PROJECT_NAME and CMAKE_PROJECT_DESCRIPTION were erroneously documenting the behavior of PROJECT_NAME and PROJECT_DESCRIPTION respectively. Fix these and update the project() docs to also mention CMAKE_PROJECT_NAME and CMAKE_PROJECT_DESCRIPTION. Fixes: #17815
* Help: Document linking behavior of OBJECT librariesBrad King2018-03-014-5/+73
| | | | | Inspired-by: Deniz Bahadir <dbahadir@benocs.com> Issue: #14778
* Merge topic 'object-library-export-as-interface'Brad King2018-03-012-0/+12
|\ | | | | | | | | | | | | ea0ce73a19 install,export: Maybe transform OBJECT libraries to INTERFACE libraries Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1811
| * install,export: Maybe transform OBJECT libraries to INTERFACE librariesBrad King2018-02-282-0/+12
| | | | | | | | | | | | | | | | | | | | | | Teach the `install` and `export` commands to support installing and exporting `OBJECT` libraries without their object files. Transform them to `INTERFACE` libraries in such cases. For `install(TARGETS)`, activate this when no destination for the object files is specified. For `export`, activate this only under Xcode with multiple architectures when we have no well-defined object file locations to give to clients.