summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* ctest: Optionally avoid starting tests that may exceed a given CPU loadBetsy McPhail2015-06-302-0/+9
| | | | | | | | | | | | | | Add a TestLoad setting to CTest that can be set via a new --test-load command-line option, CTEST_TEST_LOAD variable, or TEST_LOAD option to the ctest_test command. Teach cmCTestMultiProcessHandler to measure the CPU load and avoid starting tests that may take more than the spare load currently available. The expression <current_load> + <test_processors> <= <max-load> must be true to start a new test. Co-Author: Zack Galbreath <zack.galbreath@kitware.com>
* Help: Fix typo in ctest_test documentationZack Galbreath2015-06-241-1/+1
| | | | s/acorss/across/
* Merge topic 'doc-policy-OLD-deprecated'Brad King2015-06-091-0/+2
|\ | | | | | | | | 482a3bf3 Help: Document explicitly that policy OLD behavior is deprecated
| * Help: Document explicitly that policy OLD behavior is deprecatedBrad King2015-06-091-0/+2
| | | | | | | | | | | | | | | | | | | | | | The most likely documentation page a project author will read in response to a policy warning is the page for the policy itself. Add to every policy documentation page a note explicitly stating that the OLD behavior is deprecated. Also mention this in the cmake_policy() command documentation that explains how to set a policy to OLD. Suggested-by: Fraser Hutchison <fraser.hutchison@gmail.com>
* | Merge topic 'doc-formatting'Brad King2015-06-0959-345/+352
|\ \ | | | | | | | | | | | | c3f40f4f Help: Improve formatting of command documentation
| * | Help: Improve formatting of command documentationMichael Scott2015-06-0859-345/+352
| | | | | | | | | | | | | | | Use inline reStructuredText markup and add cross-references in more places.
* | | Help: Document find_* command versioned/unversioned name orderingBrad King2015-06-081-0/+5
| | | | | | | | | | | | | | | Suggest in the NAMES option that unversioned names go first to prefer local builds over distro-provided files.
* | | Help: Improve documentation formatting of find_* commandsBrad King2015-06-086-90/+114
| | | | | | | | | | | | | | | Use inline reStructuredText markup and add cross-references in more places.
* | | Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORKBrad King2015-06-083-29/+7
|/ / | | | | | | | | Add dedicated documents for these and link to them instead of duplicating their documentation in every find command.
* | Help: Reference TARGET_FILE genex in add_custom_command docs (#15605)Brad King2015-06-081-0/+3
|/ | | | | | | | | When documenting in the COMMAND option how to reference an executable, we previously only explicitly covered how to do it for argv[0] and left it to the reader to follow the reference to the generator expressions manual. Add explicit mention of the TARGET_FILE genex in this documentation since it will be a commonly used generator expression in this context.
* Help: Explicitly mention lack of 'install' support in add_dependenciesBrad King2015-06-011-1/+2
| | | | | | CMake-generated targets are not supported by add_dependencies. State this explicitly and use 'install' as an example since this may be commonly attempted.
* Help: Document behavior of cmake_minimum_required in a functionBrad King2015-05-151-0/+4
| | | | | Add a note to the cmake_minimum_required documentation about the limits of calling it in a function.
* Merge topic 'ctest-no-make-i'Brad King2015-05-121-2/+3
|\ | | | | | | | | | | | | 226df303 CTest: Stop telling 'make' to ignore errors with -i 28e7a135 Help: Fix build_command alternative signature docs 231601b6 build_command: Choose configuration consistently across signatures
| * CTest: Stop telling 'make' to ignore errors with -iBrad King2015-05-121-1/+2
| | | | | | | | Add policy CMP0061 to maintain compatibility for existing projects.
| * Help: Fix build_command alternative signature docsBrad King2015-05-121-1/+1
| | | | | | | | | | Do not specify that --config will not be added, because the command does add it.
* | Merge topic 'find_package-no-cmake-gui-paths'Brad King2015-05-121-11/+5
|\ \ | | | | | | | | | | | | | | | 1506f9ca find_package: Drop search in recent cmake-gui locations 8d484463 FindFLTK: Drop search in recent cmake-gui locations
| * | find_package: Drop search in recent cmake-gui locationsBrad King2015-05-081-11/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The find_package command, on Windows, has always searched build trees recently visited by cmake-gui (or CMakeSetup at one time). This was done when the command was created with the intention of simplifying workflows involving building multiple dependent projects. However, this behavior depends on recent developer interaction and therefore can create different find results based on transient system states. It can lead to surprising results and user confusion. Since this behavior was first added CMake has gained many more search options, better error messages when a package is not found, and a package registry. The latter in particular allows projects to make their build trees available for dependent projects to find without user intervention. Therefore the originally intended workflow can be achieved in other, more stable ways. After the above evoluion of find_package we have now decided that the magic search-where-cmake-gui-was behavior does more harm than good. Drop it. We do not need a policy for this behavior change because it only affects interactive use.
* | | Merge topic 'doc-file-COPY-preserves-structure'Brad King2015-05-121-1/+5
|\ \ \ | |_|/ |/| | | | | | | | f39d26ca Help: Clarify file(COPY) directory semantics (#15561)
| * | Help: Clarify file(COPY) directory semantics (#15561)Brad King2015-05-081-1/+5
| |/ | | | | | | State explicitly that directory structure is preserved.
* | Merge topic 'doc-ctest-command-formatting'Brad King2015-05-088-159/+282
|\ \ | | | | | | | | | | | | | | | 695d6f62 Help: Revise ctest_* command documentation (#15559) f8716c8b Help: Update cmake-generators(7) organization for GHS
| * | Help: Revise ctest_* command documentation (#15559)Brad King2015-05-078-159/+282
| |/ | | | | | | | | | | Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
* | execute_process: Improve stdout/stderr mergingBrad King2015-05-071-1/+2
|/ | | | | | | Use the KWSys Process "MergeOutput" option to give the child process the same pipe (or file) for both stdout and stderr. This allows natural merging of stdout and stderr together instead of merging on arbitrary buffered read boundaries as before.
* ctest_build: mention CTEST_BUILD_COMMAND in the docsBen Boeckel2015-05-071-4/+5
|
* ctest_build: update the default target documentationBen Boeckel2015-05-071-1/+2
|
* ctest_build: spruce up the documentation a bitBen Boeckel2015-05-071-12/+12
| | | | Adds markup and links to other sections.
* Merge topic 'if-IN_LIST'Brad King2015-04-301-0/+3
|\ | | | | | | | | aed6239e if: Implement new IN_LIST operator
| * if: Implement new IN_LIST operatorNils Gladitz2015-04-301-0/+3
| |
* | Help: Document that cmake_minimum_required should be called firstBrad King2015-04-292-0/+14
|/ | | | | | | | | Many projects put their project() call first, but the actions taken by this command can be influenced by policies and other information set by a call to cmake_minimum_required. Document in each of these two commands that cmake_minimum_required should be called first. Suggested-by: Alan W. Irwin
* Help: Document in find_library how to search for static librariesBrad King2015-04-221-0/+6
| | | | | This has been implemented since commit v2.6.0~295 (Make find_library test for the library file as named, 2008-02-06). Add the docs.
* Merge topic 'link-implicit-libs-full-path'Brad King2015-04-091-5/+11
|\ | | | | | | | | | | | | 882f48e5 Link libraries by full path even in implicit directories 318cd370 Help: Add link target for Find Modules section of cmake-developer.7 1535dcd8 Tests: Teach RunCMake to optionally merge command output to stdout
| * Link libraries by full path even in implicit directoriesBrad King2015-04-091-5/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When CMP0003 was first introduced we wanted to link all libraries by full path. However, some projects had problems on platforms where find_library would find /usr/lib/libfoo.so when the project really wanted to link to /usr/lib/<arch>/libfoo.so and had been working by accident because pre-CMP0003 behavior used -lfoo to link. We first tried to address that in commit v2.6.0~440 (Teach find_library to avoid returning library paths in system directories, 2008-01-23) by returning just "foo" for libraries in implicit link directories. This caused problems for projects expecting find_library to always return a full path. We ended up using the solution in commit v2.6.0~366 (... switch library paths found in implicit link directories to use -l, 2008-01-31). However, the special case for libraries in implicit link directories has also proven problematic and confusing. Introduce policy CMP0060 to switch to linking all libraries by full path even if they are in implicit link directories. Explain in the policy documentation the factors that led to the original approach and now to this approach.
* | Merge topic 'emulator-property'Brad King2015-04-081-1/+2
|\ \ | | | | | | | | | | | | | | | | | | | | | 1975d53a Help: Add notes for topic 'emulator-property' 9160d6c2 TestGenerator: Add CROSSCOMPILING_EMULATOR support. e942526b try_run: Use CMAKE_CROSSCOMPILING_EMULATOR. 579c4bec Properties: Add CROSSCOMPILING_EMULATOR target property.
| * | try_run: Use CMAKE_CROSSCOMPILING_EMULATOR.Matt McCormick2015-04-081-1/+2
| |/ | | | | | | | | | | | | If the CMAKE_CROSSCOMPILING_EMULATOR variable is defined, and CMAKE_CROSSCOMPILING is TRUE, then use CMAKE_CROSSCOMPILING_EMULATOR to run the try_run executables. This prevents the need to populate TryRunResults.cmake when cross compiling.
* | Help: Document supported compilers in cmake-compile-features.7Robert Maynard2015-04-071-1/+1
|/ | | | | | | Extend sentences in other documentation linking to this manual to say that it has a list of supported compilers. Co-Author: Brad King <brad.king@kitware.com>
* Merge topic 'improve-properties-help'Brad King2015-04-063-35/+10
|\ | | | | | | | | | | | | | | | | 6f82b5e8 Help: Link to properties in set_tests_properties. 66f5af29 Help: Link to properties in set_directory_properties docs. f7dd3f7c Help: Add link in set_source_files_properties command docs. 3b256173 Help: Shorten too-long title marker. 8fc3a2fb Help: Add references to cmake-property sections.
| * Help: Link to properties in set_tests_properties.Stephen Kelly2015-04-041-26/+4
| | | | | | | | Remove help for specific properties to their own help pages.
| * Help: Link to properties in set_directory_properties docs.Stephen Kelly2015-04-041-6/+3
| | | | | | | | Remove claim that CMake will report an error for unknown properties.
| * Help: Add link in set_source_files_properties command docs.Stephen Kelly2015-04-041-3/+3
| | | | | | | | | | Remove claim about unrecognized properties being ignored. Such properties can be retrieved later by the user.
* | Merge topic 'doc-target_link_libraries'Brad King2015-04-061-84/+124
|\ \ | |/ |/| | | | | 659896d3 Help: Revise target_link_libraries command documentation
| * Help: Revise target_link_libraries command documentationBrad King2015-04-031-84/+124
| | | | | | | | | | | | Organize the documentation into subsections to separate the signatures. Refactor the discussion of allowed link items into bullet points and expand into more detail on each.
* | Merge topic 'doc-relocatable-usage-requirements'Brad King2015-04-032-3/+9
|\ \ | |/ | | | | | | | | | | | | | | 3af13782 Help: Update discussion of relocable packages in cmake-packages(7) 227992c3 Help: Reorganize and refine discussion of relocatable packages 031d894f Help: Place relocatable package notes in their own subsections 6e331ce9 Help: Fix typo in cmake-packages(7) manual ba9b9d79 Help: Fix syntax in non-relocatable usage requirements example
| * Help: Place relocatable package notes in their own subsectionsBrad King2015-04-032-3/+9
| | | | | | | | | | | | | | These notes apply only for the use case of creating a package for redistribution on machines other than that where it is built. Clarify this to readers by placing the discussion in dedicated sections titled accordingly.
* | Help: Document conversion of PATH/FILEPATH cache values to absolute pathsBrad King2015-04-011-0/+9
| | | | | | | | Suggested-by: Roger Leigh <rleigh@codelibre.net>
* | Help: Rewrite 'set` command documentationBrad King2015-04-011-95/+59
|/ | | | | | | Much of the information in the old set() command documentation is now covered in the cmake-language(7) manual. Rewrite the documentation with this in mind. Split up the signatures for each kind of variable into different subsections.
* Help: Fix xref typos in target_compile_options docsBrad King2015-03-311-2/+2
| | | | Fix links to the COMPILE_OPTIONS directory and target properties.
* Allow add_dependencies() on INTERFACE libraries (#15414)Brad King2015-03-271-2/+2
| | | | | | | | | | Revert commit v3.0.0-rc1~175^2~20 (add_dependencies: Disallow use with INTERFACE_LIBRARY, 2013-12-25). Teach our dependency analysis to transitively follow INTERFACE target utility dependencies as was done or IMPORTED targets in commit v2.8.6~127^2~1 (Allow add_dependencies() on imported targets, 2010-11-19). Extend the InterfaceLibrary test with a case to cover header generation for a header-only INTERFACE library via a custom target.
* Help: Format add_dependencies documentationBrad King2015-03-271-9/+12
| | | | Add reStructuredText markup.
* file: Teach GLOB to list directories optionallyDomen Vrankar2015-03-201-3/+14
| | | | | | GLOB lists directories by default and GLOB_RECURSE does not. LIST_DIRECTORIES enables user to control the behavior explicitly for consistently for both GLOB and GLOB_RECURSE.
* Help: Clarify that ARGV# beyond ARGC will have an undefined behavior (#15380)Daniele E. Domenichelli2015-02-262-2/+15
|
* Help: Refine the .rst formatting of macro and function documentationDaniele E. Domenichelli2015-02-262-34/+35
|
generated by cgit v0.12 at 2025-01-06 08:33:19 (GMT)