Commit Graph

176 Commits

Author SHA1 Message Date
Brad King 907e422bc8 Help: Explain build/install-tree include dirs in more places (#14946)
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.
2014-06-02 10:49:28 -04:00
Stephen Kelly 6fbd9a8f3d Help: Add code example for INSTALL_INTERFACE to cmake-buildsystem. 2014-06-02 10:28:23 -04:00
Brad King 478356e6d9 Restore --help-full option to output all help manuals
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.
2014-04-25 08:41:31 -04:00
Brad King 97243c22b2 Merge branch 'revise-compiler-id-policies' into release 2014-04-02 14:54:17 -04:00
Brad King a41c0a9dcb Do not warn by default when policy CMP0025 or CMP0047 is not set
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.
2014-04-02 14:43:54 -04:00
Stephen Kelly dcfbbe87eb Help: Fix typo in cmake-qt manual.
Do -> To.
2014-03-26 17:50:08 +01:00
Brad King 29d4f6b03b Merge branch 'doc-osx-path-variables' into release 2014-03-10 10:24:16 -04:00
Brad King 764e977ad7 Help: Document variables CMAKE_APPBUNDLE_PATH and CMAKE_FRAMEWORK_PATH 2014-03-10 10:23:42 -04:00
Stephen Kelly ad75afbfb4 Help: List the whitelist of properties for INTERFACE libraries. 2014-02-26 10:40:49 +01:00
Brad King a7c956b867 Merge topic 'doc-usage-requirements'
0c54b775 Help: Document the purpose of usage requirements clearly.
2014-02-19 08:34:29 -05:00
Brad King 5a607c4a6f Merge topic 'doc-package-registry'
bf012e0c Help: Format find_package() command documentation
bd6887e4 Help: Document the package registry in cmake-packages.7
2014-02-19 08:34:22 -05:00
Stephen Kelly 0c54b775a4 Help: Document the purpose of usage requirements clearly.
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.
2014-02-18 16:08:44 +01:00
Brad King bd6887e4d6 Help: Document the package registry in cmake-packages.7
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.
2014-02-17 15:34:48 -05:00
Stephen Kelly a74d125a7c Help: Fix typo
binary_find -> binary_search.
2014-02-17 11:07:59 +01:00
Stephen Kelly f2eee72fac add_custom_command: Disallow use of SOURCE signatures.
Add CMP0050 to control this behavior.
2014-02-12 11:19:27 -05:00
Stephen Kelly c248a437c4 Add policy CMP0049 to avoid variable expansion in source lists 2014-02-12 11:17:38 -05:00
Brad King 89d49eccc5 Merge topic 'extend-docs'
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
2014-02-10 11:25:10 -05:00
Stephen Kelly 0b3e98d913 Help: Don't list debuggable properties in cmake-buildsystem manual. 2014-02-10 09:03:53 +01:00
Stephen Kelly 39d08b929e Help: Add additional hyperlink targets 2014-02-09 12:11:09 +01:00
Stephen Kelly ef17e29389 Help: Document SYSTEM treatment of IMPORTED target INTERFACE_INCLUDE_DIRS
Document how the behavior can be controlled.
2014-02-09 12:11:09 +01:00
Brad King 4b7f2f5213 Help: Add hyperlink targets for argument types in cmake-language(7)
Add reStructuredText hyperlink targets for the bracket, quoted, and
unquoted argument sections.
2014-02-07 13:35:50 -05:00
Stephen Kelly a683262a72 Help: Note that the compatible interface properties must not intersect. 2014-02-06 16:15:53 -05:00
Stephen Kelly fbe01bedbe Help: Specify how to order and modify transitively set property values. 2014-02-06 16:15:53 -05:00
Stephen Kelly 645500b413 Help: Add hyperlink targets to some manual sections.
These can be refered to from the command documentation and other
relevant locations.
2014-02-06 16:15:53 -05:00
Stephen Kelly a0fa025377 Help: Mark up references to NEW and OLD policy settings properly. 2014-02-06 16:15:52 -05:00
Stephen Kelly 6c02e7f427 Help: Add a style guide. 2014-02-06 16:15:50 -05:00
Stephen Kelly 91fbff8820 Help: Fix typos
Psuedo -> Pseudo

 behaviour -> behavior

CMake uses American spelling.
2014-02-06 16:14:13 -05:00
Brad King 2e2552af65 Merge topic 'cmake-qt-manual'
4271a4ed Help: Add information about INTERFACE_AUTOUIC_OPTIONS.
7935f4de Help: Note that AUTOMOC consumes the defines and includes from targets.
2739a6f9 Help: Move Qt tool invocation information to a generic cmake-qt manual.
2014-02-03 11:11:14 -05:00
Stephen Kelly 4271a4ed35 Help: Add information about INTERFACE_AUTOUIC_OPTIONS. 2014-02-02 11:50:16 +01:00
Stephen Kelly 7935f4dec8 Help: Note that AUTOMOC consumes the defines and includes from targets. 2014-02-02 11:34:04 +01:00
Stephen Kelly 2739a6f97e Help: Move Qt tool invocation information to a generic cmake-qt manual.
Add an introduction about the use of different package types, and the
ability to use Qt 4 and 5 versions together in a single buildsystem.

Add a section about automatic linking of the qtmain.lib library and
how to disable it.
2014-02-02 11:28:12 +01:00
Brad King 7e142c5ac2 project: Manage VERSION variables
Teach the project() command to set variables

  {PROJECT,<PROJECT-NAME>}_VERSION{,_MAJOR,_MINOR,_PATCH,_TWEAK}

holding the project version number and its components.  Add project()
command option "VERSION" to specify the version explicitly, and default
to the empty string when it is not given.

Since this clears variables when no VERSION is given, this may change
behavior for existing projects that set the version variables themselves
prior to calling project().  Add policy CMP0048 for compatibility.

Suggested-by: Alex Neundorf <neundorf@kde.org>
2014-01-29 09:45:18 -05:00
Brad King 00007dcc36 Help: Format project command and variable documentation
Also add document for CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE variable.
2014-01-29 09:15:20 -05:00
Stephen Kelly ed632736e3 Help: Note that std::string::clear may not be used.
As found in commit 519c0a5d (Can't use std::string::clear() in
cmake., 2012-09-15).
2014-01-27 13:02:59 -05:00
Stephen Kelly cc04bb6c16 Help: Document non-use of std::set::insert.
As found in commit 8e7c207e (Use a manual loop to insert into
set::set., 2012-09-15).
2014-01-27 13:02:59 -05:00
Brad King 0bd4157886 Merge topic 'cmake-rerun-depends'
82d43175 Allow projects to specify extra inputs to CMake
1ef444d6 Add test case to verify CMake does not re-run on first build
2014-01-22 08:47:59 -05:00
Brad King d8d3e9241e Merge topic 'cmake-E-sleep'
94389f63 cmake: Add '-E sleep' command
2014-01-22 08:47:57 -05:00
Stephen Kelly e00db59d6c QNX: Introduce QCC compiler id for that QNX platform compiler.
Introduce policy CMP0047 to control resetting the id for
compatibility.

De-duplicate content in the QNX platform file by including the GNU
one. QNX is a form of GNU platform.

Do not clear CMAKE_SHARED_LIBRARY_${lang}_FLAGS variables.  They
are populated again later by the Compiler/GNU.cmake file anyway.

Modify the CMAKE_CXX_COMPILE_OBJECT variable only when the QCC
compiler id is in use, and the language is CXX.  Use the QNX
recommended flag for QCC instead of the gcc compatible -x flag.

Populate new module files to handle system includes and depfiles
when using the QCC compiler.

Remove code which unsets the system include and depfiles related
variables.  When a GNU driver is used instead of the QCC one, the
appropriate flags will be used.  These variables were previously
cleared for lowest-common-denominator compatibility with both
drivers.
2014-01-22 08:47:32 -05:00
Brad King 82d4317503 Allow projects to specify extra inputs to CMake
Define a new 'CMAKE_CONFIGURE_DEPENDS' directory property that projects
can use to specify input files to the CMake configuration process.
Extend the RunCMake.Configure test to verify that the build system
re-runs CMake when this input changes.
2014-01-21 14:14:49 -05:00
Brad King 94389f6388 cmake: Add '-E sleep' command
Add a cmake command-line interface to provide a cross-platform 'sleep'.
2014-01-21 13:50:49 -05:00
Brad King 25d414625a Merge topic 'update-qt4-docs'
f81e67c6 Help: Update Qt4 documentation.
2014-01-20 10:59:19 -05:00
Brad King 45056264bb Help: Document CMAKE_OSX_* variables
Add documentation entries for variables

 CMAKE_OSX_ARCHITECTURES
 CMAKE_OSX_DEPLOYMENT_TARGET
 CMAKE_OSX_SYSROOT

Explain what each does and when/how they should be set.
2014-01-16 10:21:47 -05:00
Stephen Kelly f81e67c616 Help: Update Qt4 documentation.
Remove independent doc listing for Qt4ConfigurationSettings, Qt4Macros
and UseQt4. These are implementation details.

Recommend the use of IMPORTED targets.

Remove references to the UseQt4 file, which is obsolete in light of
the IMPORTED targets.

Add documentation for automatic tool invocation and options.

Remove reference to variables which should not be needed in modern
implementations.
2014-01-15 16:23:51 +01:00
Rolf Eike Beer 3a0d164bb2 allow to mark a test as "Not Run" with a specific return code (#8466) 2014-01-14 23:57:40 +01:00
Brad King 071005add1 Merge topic 'support-codelite-ide-generator'
0c4e8c70 Add support for codelite IDE project fles
2014-01-13 10:28:37 -05:00
Nils Gladitz 0bf6f13b1d AddDependencies: new policy requires dependencies to exist
Added new policy CMP0046 which requires dependencies added by
add_dependencies() to actually exist.
2014-01-12 12:58:04 +01:00
Eran Ifrah 0c4e8c70a0 Add support for codelite IDE project fles 2014-01-10 09:20:11 +02:00
Brad King 98bdd78afc Merge topic 'extend-docs'
2f15a07 Help: Link to CMAKE_POLICY_DEFAULT_CMP<NNNN> in policies manual.
bb8bde3 Help: Add notes about relocatability of config-file packages.
2014-01-09 16:26:30 -05:00
Brad King e56530f612 Merge topic 'minor-cleanups'
531e40b cmTarget: Make GetSourceFiles populate an out-vector parameter.
38de54c cmGeneratorTarget: Add methods to access source file groups.
f579fe0 Help: Fix link to MAP_IMPORTED_CONFIG_<CONFIG>
590d238 cmTarget: Handle NO_SYSTEM_FROM_IMPORTED.
2014-01-09 13:54:23 -05:00
Stephen Kelly 2f15a07727 Help: Link to CMAKE_POLICY_DEFAULT_CMP<NNNN> in policies manual. 2014-01-09 19:45:08 +01:00