summaryrefslogtreecommitdiffstats
path: root/Help/manual
Commit message (Collapse)AuthorAgeFilesLines
* ctest: Optionally avoid starting tests that may exceed a given CPU loadBetsy McPhail2015-06-302-0/+15
| | | | | | | | | | | | | | 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>
* Merge topic 'doc-cmake-buildsystem-typo'Brad King2015-06-221-1/+1
|\ | | | | | | | | 17c51521 Help: Fix a typo in cmake-buildsystem(7) manual
| * Help: Fix a typo in cmake-buildsystem(7) manualErik Sjölund2015-06-221-1/+1
| | | | | | | | | | Add the property name INTERFACE_INCLUDE_DIRECTORIES that was missing from a set_property command.
* | Merge topic 'compiler-launcher'Brad King2015-06-152-0/+2
|\ \ | | | | | | | | | | | | 698f7597 Add options to launch the compiler through tools like ccache or distcc
| * | Add options to launch the compiler through tools like ccache or distccBill Hoffman2015-06-152-0/+2
| |/ | | | | | | | | | | | | | | | | | | | | | | | | Create a <LANG>_COMPILER_LAUNCHER target property (initialized by a CMAKE_<LANG>_COMPILER_LAUNCHER variable) to specify a compiler launcher tool. This will supersede the CMAKE_<LANG>_COMPILER_ARG1 approach to using such tools. The old approach set CMAKE_<LANG>_COMPILER to the launcher tool while the new approach leaves this variable set to the actual compiler. Implement this property for Makefile and Ninja generators. It cannot be implemented for VS or Xcode generators as the IDE build tools offer no such hooks.
* | Merge topic 'doc-policy-OLD-deprecated'Brad King2015-06-091-5/+5
|\ \ | | | | | | | | | | | | 482a3bf3 Help: Document explicitly that policy OLD behavior is deprecated
| * | Help: Document explicitly that policy OLD behavior is deprecatedBrad King2015-06-091-5/+5
| |/ | | | | | | | | | | | | | | | | | | | | 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-find-command-cleanup'Brad King2015-06-091-0/+4
|\ \ | | | | | | | | | | | | | | | | | | | | | 3de3544f Help: Improve documentation formatting of find_* commands 8c64c478 Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORK 25b4483e Help: Document CMAKE_SYSTEM_APPBUNDLE_PATH variable e2f34986 Help: Document CMAKE_SYSTEM_FRAMEWORK_PATH variable
| * | Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORKBrad King2015-06-081-0/+2
| | | | | | | | | | | | | | | Add dedicated documents for these and link to them instead of duplicating their documentation in every find command.
| * | Help: Document CMAKE_SYSTEM_APPBUNDLE_PATH variableBrad King2015-06-081-0/+1
| | |
| * | Help: Document CMAKE_SYSTEM_FRAMEWORK_PATH variableBrad King2015-06-081-0/+1
| |/
* | Help: Drop incorrect advice from cmake-developer.7 manualBrad King2015-06-081-1/+0
|/ | | | | Drop the comment on the purpose of PATH_SUFFIXES in our Find Module example. It was incorrect.
* Help: Fix typo in cmake-compile-features(7) manual (#15594)Erik Sjölund2015-05-291-1/+1
| | | | | | | target_link_libraries() is being used in the example code but target_include_directories() was probably meant to be used. The sentence that starts with "Consuming code then" indicates that the example is about using the appropriate include directory.
* Honor visibility properties for all target types (#15556)Brad King2015-05-261-0/+1
| | | | | | | | | | | | | | | | The <LANG>_VISIBILITY_PRESET and VISIBILITY_INLINES_HIDDEN were first merged in commit v2.8.12~322 (Merge topic 'VISIBILITY_PRESET-property', 2013-06-05) but worked only for shared libraries and executables with exports. Prior to commit v3.0.0-rc1~581^2 (GenerateExportHeader: Deprecate add_compiler_export_flags function., 2013-09-02) the add_compiler_export_flags function was used to add visibility flags to all targets. The visibility flags are useful for sources in all target types because they may be later linked into shared libraries or executables with exports. Introduce policy CMP0063 to enable them for all target types while preserving compatibility with existing projects that do not expect this.
* Revert "Qbs: Add new 'extra' generator for qbs project files"Brad King2015-05-211-1/+0
| | | | | | | | | | | | | | | | | | | This reverts commit f85db2f32358e6de921aba7d1cb8ecb81da934c0. Discussion by the QtCreator community at https://bugreports.qt.io/browse/QTCREATORBUG-13695 raises concerns about this particular approach to working with CMake projects using QtCreator. Also, the functionality and design of the QBS extra generator was never discussed on the CMake mailing list or with QtCreator developers. There may be better ways to make the two tools work together. In order to avoid committing to long-term support of this generator prior to such discussion taking place, revert it from CMake for now. We may restore this or use an alternative design based on results of such discussion.
* Merge topic 'doc-cache-option-space'Brad King2015-05-212-1/+4
|\ | | | | | | | | b0ea3673 Help: Spell '-D' option consistently across documentation (#15575)
| * Help: Spell '-D' option consistently across documentation (#15575)Brad King2015-05-202-1/+4
| | | | | | | | | | | | Always show the option with its argument separate in summary text. State in the main documentation that the option and its argument can be given together too.
* | Merge topic 'doc-cmake-buildsystem-typo'Brad King2015-05-211-2/+2
|\ \ | | | | | | | | | | | | 7412d100 Help: Fix typo in cmake-buildsystem(7) manual
| * | Help: Fix typo in cmake-buildsystem(7) manualBrad King2015-05-191-2/+2
| |/
* | Add options to run include-what-you-use with the compilerBrad King2015-05-192-0/+2
|/ | | | | | Create a <LANG>_INCLUDE_WHAT_YOU_USE target property (initialized by a CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE variable) to specify an IWYU command line to be run along with the compiler.
* install: Disallow installing export() result.Stephen Kelly2015-05-141-0/+1
|
* CTest: Stop telling 'make' to ignore errors with -iBrad King2015-05-121-0/+1
| | | | Add policy CMP0061 to maintain compatibility for existing projects.
* Help: Update cmake-generators(7) organization for GHSBrad King2015-05-071-3/+3
|
* VS: Add option to put INSTALL target in .sln default buildRobert Goulet2015-05-061-0/+1
| | | | | Add a CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD variable to control this behavior.
* Help: Revise buildsystem artifact file type documentation (#15539)Brad King2015-04-292-2/+72
| | | | | | Add sections to the cmake-buildsystem(7) manual and cross-reference them with relevant variables and target properties. This avoids duplicating the information and allows it to be more detailed.
* ctest: Consolidate documentation of CTEST_USE_LAUNCHERS (#15533)Brad King2015-04-281-2/+5
| | | | | | | | | The documentation of this variable in the CTest module is outdated and has been superseded by the ctest(1) manual. In particular, the latter mentions that it works with the Ninja generator as well as makefile generators. Remove the documentation from the CTest module and replace it with a link to the main variable documentation (which already references the ctest(1) manual).
* Help: Fix formatting of env var refs in ctest.1 manualBrad King2015-04-221-2/+4
|
* Merge topic 'add-GreenHills-MULTI-generator'Brad King2015-04-202-0/+6
|\ | | | | | | | | | | | | 66b641f4 Help: Add notes for topic 'add-GreenHills-MULTI-generator' 48004d9d Add a 'Green Hills MULTI' generator on Windows 051d8be1 cmLocalGenerator: Constify some cmTarget and cmGeneratorTarget arguments
| * Add a 'Green Hills MULTI' generator on WindowsGeoff Viola2015-04-202-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | Green Hills MULTI is an IDE for embedded real-time systems. The IDE's product page can be found here: http://www.ghs.com/products/MULTI_IDE.html It supports cross compiling on ARM, Intel x86, and other architectures with various operating systems. The IDE exists on Linux and Windows host systems, but CMake will currently only generate the project files on Windows host systems.
* | Help: Fix {GIT,P4}UpdateCustom documentation (#15512)Brad King2015-04-131-2/+2
| | | | | | | | | | | | | | | | The GITUpdateCustom and P4UpdateCustom options take only one command line with all arguments as a ;-list, not a ;-list of multiple command lines. Fix the incorrect documentation originally added by commit v3.1.0-rc1~463^2 (Help: Document ctest dashboard client usage, 2014-05-30).
* | cmake: Teach "-E tar" command a "--format=" optionNils Gladitz2015-04-101-0/+4
| | | | | | | | | | | | | | Allows specifying a libarchive defined archive format currently restricted to 7zip, gnutar, pax, paxr and zip. The default is "paxr" (pax restricted).
* | Merge topic 'link-implicit-libs-full-path'Brad King2015-04-092-0/+2
|\ \ | |/ |/| | | | | | | | | 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-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * Help: Add link target for Find Modules section of cmake-developer.7Brad King2015-04-071-0/+1
| |
* | Merge topic 'emulator-property'Brad King2015-04-082-0/+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.
| * | Properties: Add CROSSCOMPILING_EMULATOR target property.Matt McCormick2015-04-072-0/+2
| |/ | | | | | | | | | | | | Add CROSSCOMPILING_EMULATOR target property for executables. This is used by subsequent patches to run exectuables created for the target system when crosscompiling. The property is initialized by the CMAKE_CROSSCOMPILING_EMULATOR variable when defined.
* | Help: Document supported compilers in cmake-compile-features.7Robert Maynard2015-04-072-1/+15
|/ | | | | | | 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-061-1/+15
|\ | | | | | | | | | | | | | | | | 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: Shorten too-long title marker.Stephen Kelly2015-04-041-1/+1
| |
| * Help: Add references to cmake-property sections.Stephen Kelly2015-04-041-0/+14
| |
* | Help: Clarify manual reference for generator namesNils Gladitz2015-04-041-1/+1
|/
* Merge topic 'vs-xaml'Brad King2015-04-031-0/+1
|\ | | | | | | | | 01a9ab0d VS: Add support for XAML source files
| * VS: Add support for XAML source filesGilles Khouzam2015-04-031-0/+1
| | | | | | | | | | | | | | | | XAML files are by default of type Page in the vcxproj and can be overriden by setting the VS_XAML_TYPE property. The .cpp and .h file of the same name are automatically added as depending on the XAML file. New VSXaml test builds a basic XAML WindowsStore 8.1 app with VS2013.
* | Merge topic 'doc-relocatable-usage-requirements'Brad King2015-04-032-70/+113
|\ \ | |/ |/| | | | | | | | | | | | | 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: Update discussion of relocable packages in cmake-packages(7)Brad King2015-04-031-20/+46
| | | | | | | | | | | | | | | | | | | | Explain at the beginning of the section the requirements for a package to be relocatable to justify the rest of the section content. Generalize example to use fictional package names instead of real ones, especially because FindBoost provides no alternative yet. Reword the discussion to represent the preferred approach as "ideal" but also suggest workarounds when find modules do not provide the imported targets.
| * Help: Reorganize and refine discussion of relocatable packagesBrad King2015-04-032-70/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Re-organize the content added to the cmake-packages(7) manual by * commit v3.0.0-rc1~184^2 (Help: Document export(EXPORT) in the cmake-packages manual, 2013-12-23), * commit v3.0.0-rc1~154^2~1 (Help: Add notes about relocatability of config-file packages, 2014-01-07), and * commit v3.2.0-rc1~345^2 (Help: Warn that paths should not be used in INTERFACE_ build properties, 2014-11-22). These commits broke the natural flow of the original manual and made wording after the new content make less sense. Move the content into new subsections to restore the flow of the original manual and to make explicitly the purpose of the new content. Shorten the relocatable usage requirement "warnings". Refer to the new cmake-packages(7) manual subsection to reduce duplication. Also clarify the distinction between paths to library dependencies and paths to their header files.
| * Help: Fix typo in cmake-packages(7) manualBrad King2015-04-031-1/+1
| | | | | | | | relevnt => relevant
| * Help: Fix syntax in non-relocatable usage requirements exampleBrad King2015-04-031-4/+4
| | | | | | | | | | The example in cmake-packages(7) is meant to be incorrect for use of absolute paths, not for its syntax.
* | Help: Split cmake-generators(7) into linkable subsectionsBrad King2015-04-031-1/+25
| | | | | | | | | | | | | | Many places in our documentation refer to "Makefile Generators" or "Visual Studio" generators as a group of generators. Give such places a linkable document section to reference since they cannot cross-reference the individual generators in the groups.
* | Merge topic 'remove-DEFINITIONS-directory-property'Brad King2015-04-021-0/+1
|\ \ | | | | | | | | | | | | 06f61c26 Do not treat DEFINITIONS as a built-in directory property