summaryrefslogtreecommitdiffstats
path: root/Help
Commit message (Collapse)AuthorAgeFilesLines
* Help: Explain build/install-tree include dirs in more places (#14946)Brad King2014-06-023-3/+35
| | | | | | | | | | | Explain how to use $<BUILD_INTERFACE> and $<INSTALL_INTERFACE> directly in the documentation of the target_include_directories command and INTERFACE_INCLUDE_DIRECTORIES target property. Otherwise readers need to notice the link to the cmake-buildsystem(7) manual and find the example in that to understand the need for these expressions. Also fix the explanation in cmake-buildsystem(7) to not claim that relative paths may be used inside a BUILD_INTERFACE expression.
* Help: Add code example for INSTALL_INTERFACE to cmake-buildsystem.Stephen Kelly2014-06-021-1/+11
|
* Restore --help-full option to output all help manualsBrad King2014-04-251-0/+6
| | | | | | This option was removed during conversion to the reStructuredText documentation. Restore it. Process documentation starting at Help/index.rst so that all manuals are included in the output.
* Merge branch 'revise-compiler-id-policies' into releaseBrad King2014-04-024-24/+60
|\
| * Do not warn by default when policy CMP0025 or CMP0047 is not setBrad King2014-04-024-7/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These policies are triggered by the use of a particular compiler rather than outdated CMake code in a project. Avoid warning in every project that enables a language by not displaying the policy warning by default. Add variable CMAKE_POLICY_WARNING_CMP<NNNN> to control the warning explicitly; otherwise enable the warning with --debug-output or --trace. This breaks with strict policy convention because it does not provide developers with any warning about the behavior change by default. Existing projects will continue to build without a warning or change in behavior. When a developer changes the minimum required version of CMake in a project to a sufficiently high value (3.0), the project will suddenly get the new compiler id and may break, but at least the breakage comes with a change to the project rather than the version of CMake used to build it. Breaking strict policy convention is worthwhile in this case because very few projects will be affected by the behavior change but every project would have to see the warning if it were enabled by default.
| * Help: Revise and format policy CMP0025 and CMP0047 docsBrad King2014-04-022-20/+31
| | | | | | | | | | | | Add inline reST markup as appropriate. Word CMP0047 docs more like those of CMP0025. State explicitly that the policies must be set before the project or enable_language command calls.
* | Help: Fix typo in cmake-qt manual.Stephen Kelly2014-03-261-1/+1
|/ | | | Do -> To.
* cmTarget: Restore <CONFIG>_LOCATION to CMP0026 OLD behavior (#14808)Stephen Kelly2014-03-171-3/+4
| | | | | | | Restore support for the undocumented <CONFIG>_LOCATION target property removed by commit v3.0.0-rc1~175^2 (cmTarget: Remove support for <CONFIG>_LOCATION property, 2013-12-30) as part of the CMP0026 OLD behavior.
* Merge branch 'doc-osx-path-variables' into releaseBrad King2014-03-103-0/+13
|\
| * Help: Document variables CMAKE_APPBUNDLE_PATH and CMAKE_FRAMEWORK_PATHBrad King2014-03-103-0/+13
| |
* | Merge branch 'doc-find_package-build-paths' into releaseBrad King2014-03-031-0/+1
|\ \
| * | Help: Mention in find_package that cmake-gui step is Windows-only (#14781)Brad King2014-03-031-0/+1
| |/ | | | | | | | | | | | | Recently used cmake-gui locations are searched only on Windows because the Windows registry is used to record the values. This behavior is historical and may be removed by a policy in the future so rather than implementing it on other platforms simply document the current behavior.
* | Merge branch 'CMP0043-dir-prop' into releaseBrad King2014-03-031-1/+7
|\ \
| * | CMP0043: Document old and new interfaces for setting directory property.Stephen Kelly2014-03-031-1/+7
| |/
* | Merge branch 'add_definitions-no-genex' into releaseBrad King2014-03-031-4/+2
|\ \
| * | add_definitions: Don't document genex support.Stephen Kelly2014-03-031-4/+2
| |/ | | | | | | | | | | This command does not support generator expressions. The documentation was mistakenly extended to claim it in commit v3.0.0-rc1~60^2~3 (Help: Mark up the buildsystem commands documentation, 2014-02-03).
* | Merge branch 'FindRuby-2' into releaseBrad King2014-02-281-0/+2
|\ \
| * | Help: Consolidate FindRuby-2 release notes for 3.0.0Brad King2014-02-282-4/+2
| | |
| * | Help: Add FindRuby-2 topic release notesBrad King2014-02-281-0/+4
| | |
* | | Help: List the whitelist of properties for INTERFACE libraries.Stephen Kelly2014-02-261-0/+10
| | |
* | | Merge branch 'install-FILES-genex' into releaseBrad King2014-02-242-161/+172
|\ \ \
| * | | install: Support generator expressions in FILES and PROGRAMS modeBrad King2014-02-212-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Teach the install(FILES) and install(PROGRAMS) commands to evaluate generator expressions in the list of files. Extend the ExportImport test to cover installation cases involving generator expressions.
| * | | Help: Format install() command documentationBrad King2014-02-211-161/+162
| | | | | | | | | | | | | | | | Add inline markup and explicit markup blocks as appropriate.
* | | | Merge branch 'doc-add_test-cleanup' into releaseBrad King2014-02-201-48/+38
|\ \ \ \
| * | | | Help: Revise and format add_test() command documentationBrad King2014-02-201-48/+38
| |/ / / | | | | | | | | | | | | | | | | Favor the add_test(NAME) signature and document the limitations of the plain signature.
* | | | Change version scheme to use only two components for feature levelsBrad King2014-02-193-9/+25
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Historically CMake used three version components for the feature level. We released new features while incrementing only the third version component. Since commit v2.8.2~105^2~4 (New version scheme to support branchy workflow, 2010-04-23) we used the fourth version component for bug-fix releases and the development date: <major>.<minor>.<patch>[.<tweak>][-rc<n>] = Release <major>.<minor>.<patch>.<date>[-<id>] = Development This solidified use of three components for the feature level, and was necessary to continue releasing 2.x versions because: * Some existing projects performed floating-point comparisons of ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} to 2.x numbers so ``x`` could never be higher than 9. * Version 2.9.<date> was used briefly in post-2.8.0 development in CVS prior to the transition to Git, so using it in releases may have caused confusion. Now that we are moving to 3.x versions, these two restrictions go away. Therefore we now change to use only two components for the feature level and use the scheme: <major>.<minor>.<patch>[-rc<n>] = Release <major>.<minor>.<date>[-<id>] = Development
* | | Help: Drop development topic notes to prepare releaseBrad King2014-02-192-9/+0
|/ / | | | | | | | | Release versions do not have the development topic section of the CMake Release Notes index page.
* | Help: Rename 3.0 release notes to 3.0.0Brad King2014-02-192-4/+4
| | | | | | | | | | Bug-fix releases 3.0.x may have their own notes so this will look more consistent.
* | Help: Consolidate remaining 3.0 release notesBrad King2014-02-192-5/+3
|/
* Merge topic 'doc-usage-requirements'Brad King2014-02-191-0/+6
|\ | | | | | | | | 0c54b775 Help: Document the purpose of usage requirements clearly.
| * Help: Document the purpose of usage requirements clearly.Stephen Kelly2014-02-181-0/+6
| | | | | | | | | | | | | | | | | | | | People will be tempted to put things there for convenience, thereby causing conflicts similar to http://thread.gmane.org/gmane.comp.compilers.clang.devel/35162/focus=35169 where it is conceivable that the LLVM developers could put a flag on a target for convenience, which would cause conflicts for some downstreams.
* | Merge topic 'FindBoost-namespace'Brad King2014-02-191-0/+5
|\ \ | | | | | | | | | | | | 17485e37 FindBoost: Add suport for custom namespaces
| * | FindBoost: Add suport for custom namespacesChuck Atkins2014-02-171-0/+5
| |/ | | | | | | | | | | | | | | | | | | When building boost with an alternate namespace the libraries generated will have a different naming convention. This is often done to ensure no symbol conflicts with external libraries built against a different version of boost. If the namespace used is "myprivateboost::" instead of "boost::" then the libraries built will be named myprivateboost_foo instead of boost_foo. Add an option to specify a custom namespace used to alter the library names that get searched for.
* | Merge topic 'doc-package-registry'Brad King2014-02-192-189/+300
|\ \ | | | | | | | | | | | | | | | bf012e0c Help: Format find_package() command documentation bd6887e4 Help: Document the package registry in cmake-packages.7
| * | Help: Format find_package() command documentationBrad King2014-02-171-189/+171
| | | | | | | | | | | | | | | Add inline markup and explicit markup block syntax as needed. Add cross-references to other documentation as appropriate.
| * | Help: Document the package registry in cmake-packages.7Brad King2014-02-171-0/+129
| |/ | | | | | | | | | | | | | | Port documentation from the CMake Wiki page at: http://www.cmake.org/Wiki/CMake/Tutorials/Package_Registry as of 2014-02-17 into our main documentation.
* | Help: Fix typoStephen Kelly2014-02-171-2/+2
|/ | | | binary_find -> binary_search.
* add_custom_command: Disallow use of SOURCE signatures.Stephen Kelly2014-02-123-0/+22
| | | | Add CMP0050 to control this behavior.
* Add policy CMP0049 to avoid variable expansion in source listsStephen Kelly2014-02-123-0/+29
|
* Help: Add CMake 3.0 Release NotesBrad King2014-02-112-0/+453
| | | | | | | Manually read through version control history since the 2.8.12.2 release and write release notes for important user-facing changes. Co-Author: Stephen Kelly <steveire@gmail.com>
* Merge topic 'doc-policy-version-3.0'Brad King2014-02-1025-29/+29
|\ | | | | | | | | aab11bca Help: Change version 3.0.0 -> 3.0 in policy docs
| * Help: Change version 3.0.0 -> 3.0 in policy docsBrad King2014-02-1025-29/+29
| | | | | | | | | | | | Starting with 3.0 we will use only two components for the feature level, and policies are only ever introduced with a bump to the feature level version.
* | Merge topic 'extend-docs'Brad King2014-02-103-4/+17
|\ \ | | | | | | | | | | | | | | | | | | 0b3e98d9 Help: Don't list debuggable properties in cmake-buildsystem manual. 39d08b92 Help: Add additional hyperlink targets ef17e293 Help: Document SYSTEM treatment of IMPORTED target INTERFACE_INCLUDE_DIRS
| * | Help: Don't list debuggable properties in cmake-buildsystem manual.Stephen Kelly2014-02-101-4/+2
| | |
| * | Help: Add additional hyperlink targetsStephen Kelly2014-02-093-0/+7
| | |
| * | Help: Document SYSTEM treatment of IMPORTED target INTERFACE_INCLUDE_DIRSStephen Kelly2014-02-091-0/+8
| |/ | | | | | | Document how the behavior can be controlled.
* | Merge topic 'release-notes-prep'Brad King2014-02-101-0/+6
|\ \ | | | | | | | | | | | | | | | | | | | | | 4b7f2f52 Help: Add hyperlink targets for argument types in cmake-language(7) 113df227 Remove ChangeLog.manual 79f55909 Remove ChangeLog.txt d25dbc90 Tests/BundleTest: Drop use of ChangeLog.txt
| * | Help: Add hyperlink targets for argument types in cmake-language(7)Brad King2014-02-071-0/+6
| |/ | | | | | | | | Add reStructuredText hyperlink targets for the bracket, quoted, and unquoted argument sections.
* | Help: Fix typo.Stephen Kelly2014-02-071-1/+1
|/ | | | 'to not to' -> 'not to'
* Help: Adjust the QtAutogen properties to the common style.Stephen Kelly2014-02-067-38/+59
| | | | Link to the cmake-qt manual.