Commit Graph

248 Commits

Author SHA1 Message Date
Brad King 6e3151f6cc CTest: Document and test custom output size settings
Add documentation and tests for the existing

 CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
 CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE

CTest variables.
2015-09-18 11:32:05 -04:00
Brad King 3809150a38 Help: Document string(REGEX) input concatentation (#15742)
These commands concatenate all their input before matching.  Document
this behavior.
2015-09-14 10:37:59 -04:00
Brad King 5f2c47c44c Help: Organize string command docs into sections
Add section headers and titles for each command signature.  Group
related commands into sections.
2015-09-14 10:37:40 -04:00
Brad King 05d22864d2 Merge topic 'doc-get_filename_component-typo'
8bfa34b7 Help: Fix typo in get_filename_component docs
2015-09-09 11:30:45 -04:00
Christopher Meng 8bfa34b78e Help: Fix typo in get_filename_component docs
trailing slahes -> trailing slashes
2015-09-08 11:36:06 -04:00
Brad King 8ea7611bc3 find_program: Optionally consider all names in each directory
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 for
it.  Add a NAMES_PER_DIR option to tell this command to consider one
directory at a time and search for all names in it.
2015-09-02 10:17:22 -04:00
James Johnston e89ea3d190 get_filename_component: Teach new BASE_DIR parameter.
In the get_filename_component command, add a new BASE_DIR parameter to
use with the ABSOLUTE and REALPATH options.  This will be used when
finding an absolute path from a relative path.
2015-08-17 23:55:38 -04:00
Chuck Atkins 7f0b83e018 try_compile: Update documentation for other propagated variables 2015-08-14 11:48:54 -04:00
Chuck Atkins fb77c2c54b try_compile: Propogate the CMAKE_LINK_SEARCH_ variables 2015-08-14 11:48:01 -04:00
Brad King 7ac2b1256b Merge topic 'if-test'
14e49ed1 if: Add "TEST <test>" condition
623dcc85 ExternalProject: Avoid if() auto-dereference of a "TEST" variable
2015-08-03 09:25:10 -04:00
Matt McCormick 14e49ed156 if: Add "TEST <test>" condition
if(TEST TestNameThatExists) will return true if a test with the name
TestNameThatExists has been added with add_test.  The syntax is similar
to if(TARGET TargetName).  Since use of "TEST" as an argument to if()
could previously be interpreted as a non-keyword argument, add policy
CMP0064 to treat it as a keyword as NEW behavior.
2015-08-03 09:22:25 -04:00
James Johnston fe2e503ea4 Help: Document string(FIND) return value when no match is found 2015-07-30 13:24:44 -04:00
Brad King b2eff70f6b Merge topic 'doc-apple-framework-creation'
eb8eaaec Help: Document Apple Framework creation with an example (#15651)
2015-07-15 09:05:44 -04:00
Brad King eb8eaaecbe Help: Document Apple Framework creation with an example (#15651) 2015-07-14 14:57:02 -04:00
Brad King 6b9a7938be Help: Link to cmake-properties.7 manual from set_target_properties docs
Drop the partial documentation of properties from the command
documentation and reference the main properties manual instead.
Otherwise readers may not realize there are many more properties.
2015-07-14 14:42:47 -04:00
Brad King fe3c678778 Help: Link to cmake-properties.7 manual from set_property docs 2015-07-14 14:41:31 -04:00
Daniel Pfeifer 2b18cdcaba string: add APPEND subcommand 2015-07-07 09:23:21 -04:00
Betsy McPhail f62d301b92 ctest: Optionally avoid starting tests that may exceed a given CPU load
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>
2015-06-30 10:21:37 -04:00
Zack Galbreath 93904772d7 Help: Fix typo in ctest_test documentation
s/acorss/across/
2015-06-24 11:15:19 -04:00
Brad King ab660b8d22 Merge topic 'doc-policy-OLD-deprecated'
482a3bf3 Help: Document explicitly that policy OLD behavior is deprecated
2015-06-09 10:29:38 -04:00
Brad King 482a3bf3f0 Help: Document explicitly that policy OLD behavior is deprecated
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>
2015-06-09 09:29:41 -04:00
Brad King 1adcec3983 Merge topic 'doc-formatting'
c3f40f4f Help: Improve formatting of command documentation
2015-06-09 09:18:54 -04:00
Michael Scott c3f40f4fd9 Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 16:28:31 -04:00
Brad King 7ab0806fef Help: Document find_* command versioned/unversioned name ordering
Suggest in the NAMES option that unversioned names go first to prefer
local builds over distro-provided files.
2015-06-08 16:13:56 -04:00
Brad King 3de3544fcd Help: Improve documentation formatting of find_* commands
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 15:52:21 -04:00
Brad King 8c64c4783d Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORK
Add dedicated documents for these and link to them instead of
duplicating their documentation in every find command.
2015-06-08 15:45:59 -04:00
Brad King 0e708d17e9 Help: Reference TARGET_FILE genex in add_custom_command docs (#15605)
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.
2015-06-08 09:06:26 -04:00
Brad King 9504d7a99b Help: Explicitly mention lack of 'install' support in add_dependencies
CMake-generated targets are not supported by add_dependencies.  State
this explicitly and use 'install' as an example since this may be
commonly attempted.
2015-06-01 09:13:23 -04:00
Brad King e5f8ead50b Help: Document behavior of cmake_minimum_required in a function
Add a note to the cmake_minimum_required documentation about the
limits of calling it in a function.
2015-05-15 14:48:15 -04:00
Brad King 53bb51fc31 Merge topic 'ctest-no-make-i'
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
2015-05-12 09:12:56 -04:00
Brad King ffd5d09225 Merge topic 'find_package-no-cmake-gui-paths'
1506f9ca find_package: Drop search in recent cmake-gui locations
8d484463 FindFLTK: Drop search in recent cmake-gui locations
2015-05-12 09:12:50 -04:00
Brad King 733ca510a6 Merge topic 'doc-file-COPY-preserves-structure'
f39d26ca Help: Clarify file(COPY) directory semantics (#15561)
2015-05-12 09:12:46 -04:00
Brad King 226df303f9 CTest: Stop telling 'make' to ignore errors with -i
Add policy CMP0061 to maintain compatibility for existing projects.
2015-05-12 09:06:49 -04:00
Brad King 28e7a135e0 Help: Fix build_command alternative signature docs
Do not specify that --config will not be added, because the
command does add it.
2015-05-12 09:06:49 -04:00
Brad King 1506f9ca56 find_package: Drop search in recent cmake-gui locations
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.
2015-05-08 11:27:02 -04:00
Brad King 6831f91a6c Merge topic 'doc-ctest-command-formatting'
695d6f62 Help: Revise ctest_* command documentation (#15559)
f8716c8b Help: Update cmake-generators(7) organization for GHS
2015-05-08 09:41:24 -04:00
Brad King f39d26caa7 Help: Clarify file(COPY) directory semantics (#15561)
State explicitly that directory structure is preserved.
2015-05-08 09:29:05 -04:00
Brad King 695d6f62d3 Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*``
commands.  Modernize the documentation formatting.  Add some missing
options.
2015-05-07 16:10:20 -04:00
Brad King f65bb82f36 execute_process: Improve stdout/stderr merging
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.
2015-05-07 14:40:38 -04:00
Ben Boeckel 5731fb2e5e ctest_build: mention CTEST_BUILD_COMMAND in the docs 2015-05-07 13:05:54 -04:00
Ben Boeckel 753da8c6f1 ctest_build: update the default target documentation 2015-05-07 13:05:54 -04:00
Ben Boeckel 5ab896aede ctest_build: spruce up the documentation a bit
Adds markup and links to other sections.
2015-05-07 13:05:54 -04:00
Brad King 735b7092e8 Merge topic 'if-IN_LIST'
aed6239e if: Implement new IN_LIST operator
2015-04-30 10:32:03 -04:00
Nils Gladitz aed6239e40 if: Implement new IN_LIST operator 2015-04-30 10:21:19 -04:00
Brad King 6ac3712da0 Help: Document that cmake_minimum_required should be called first
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
2015-04-29 08:49:59 -04:00
Brad King 941e3bd2b6 Help: Document in find_library how to search for static libraries
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.
2015-04-22 09:29:55 -04:00
Brad King 1a1bdbfd87 Merge topic 'link-implicit-libs-full-path'
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
2015-04-09 11:32:31 -04:00
Brad King 882f48e5ba Link libraries by full path even in implicit directories
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.
2015-04-09 11:29:18 -04:00
Brad King 977796e307 Merge topic 'emulator-property'
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.
2015-04-08 09:07:03 -04:00
Matt McCormick e942526b3d try_run: Use CMAKE_CROSSCOMPILING_EMULATOR.
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.
2015-04-08 09:06:22 -04:00