Commit Graph

1067 Commits

Author SHA1 Message Date
Brad King
e15cac8ee7 Help: Extend the cmake(1) manual
Extend the description section to cover all capabilities that
the "cmake" tool has.  Extend the buildsystem generation section
to introduce important concepts and describe the basic workflow.

Inspired-by: Joachim Wuttke (l) <j.wuttke@fz-juelich.de>
2018-11-27 21:13:32 +11:00
Joachim Wuttke (l)
8b3a537c29 Help: Improve cmake(1) manual organization
Extend the Synposis, and provide links to manual sections.
Add sections for `cmake --open` and `cmake --help-*`.

Introduce a new section for buildsystem generation to distinguish it
from the other functionality.  Populate it with minimal placeholder text
for now.  It will be extended later.

Co-Author: Brad King <brad.king@kitware.com>
2018-11-27 21:13:32 +11:00
Joachim Wuttke (l)
f9c3f7b164 Help: Emphasize tool names in their manuals
Print the name of the **cmake** executable in boldface, so that it does
not appear less prominent than other shell commands (which are underlaid
with links).  Similarly the other tool manuals.
2018-11-26 10:17:44 -05:00
Craig Scott
ec43aca703 Merge topic 'doc-module-doc-syntax'
8369e3e782 Help/dev: Modernize module example in the CMake Documentation Guide
664d6178d8 Help: Modernize example find module docs in cmake-developer(7)

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2621
2018-11-20 16:48:45 -05:00
Brad King
664d6178d8 Help: Modernize example find module docs in cmake-developer(7) 2018-11-20 21:03:01 +11:00
Kyle Edwards
b5f8113ca7 Genex: Add policy to handle empty list items in $<IN_LIST:...>
The old behavior of $<IN_LIST:...> is inconsistent with that of
if(IN_LIST), in that it does not find an empty search item even if
the list contains empty items. This change adds a new policy to
correctly handle empty items and make the behavior more consistent
with if(IN_LIST).

Fixes: #18556
2018-11-19 17:02:06 -05:00
Brad King
b324743229 Merge topic 'cpack'
a26ac919ef Help: Explain interaction of cpack(1) and CPack.

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2617
2018-11-15 13:49:58 -05:00
Joachim Wuttke (l)
a26ac919ef Help: Explain interaction of cpack(1) and CPack.
In particular, make clear that package/installer generators
are not the makefile generators of the cmake command.

Also insert sections in CPack doc, and capitalize section titles.
2018-11-15 16:50:52 +01:00
Brad King
59fc717c25 Merge topic 'deprecate-findqt'
0f5c1b404b find_package(): Add policy to remove the FindQt module

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: noo mook <noomook2519@gmail.com>
Merge-request: !2554
2018-11-15 10:39:55 -05:00
Kyle Edwards
0f5c1b404b find_package(): Add policy to remove the FindQt module
Removing FindQt.cmake gives Qt upstream a path forward to export its
own QtConfig.cmake files which can be found by find_package()
without having to explicitly specify CONFIG. Projects that still
want to use Qt3/4 can call find_package(Qt[34]), include(FindQt),
or add FindQt.cmake to their CMAKE_MODULE_PATH.
2018-11-14 15:05:06 -05:00
Brad King
a82282a08c Help/dev: Factor out a CMake Documentation Guide for developing the docs
Remove this content from the `cmake-developer(7)` manual because it
is relevant only to developers working on CMake itself.  Move it to
a guide in the developer documentation.
2018-11-14 14:38:13 -05:00
Brad King
bfbc5241e9 Help: Fix policy markup example in cmake-developer(7) 2018-11-14 14:29:13 -05:00
Brad King
3e5a047f1a Help: Drop compile features section from cmake-developer(7) manual
We no longer add granular compile features.  Only language standard
meta features like `cxx_std_##`` need to be added, and these can
be done by following existing patterns.
2018-11-14 14:29:13 -05:00
Joachim Wuttke (l)
df780bcc01 Help: Move deprecated modules to appropriate section.
Move deprecated or obsolete modules to the section
"Deprectated Modules" of cmake-modules(7):

- MacroAddFileDependencies (Text says: Using the macro
  MACRO_ADD_FILE_DEPENDENCIES() is discouraged.)
- UsePkgConfig (Text calls it "obsolete")
- Use_wxWindows (was already listed in deprecation section)
2018-11-13 13:06:30 +01:00
Brad King
db984477e4 Merge topic 'deprecate-ParseArguments'
ff800a768c Help: move CMakeParseArguments to deprecated section

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2595
2018-11-12 16:28:30 -05:00
Craig Scott
ddb967cca1 Merge topic 'pie-link-options'
c4b4d8b3a6 POSITION_INDEPENDENT_CODE: Manage link flags for executables
724a0346f7 POSITION_INDEPENDENT_CODE: Fix erroneous '-fPIE' flag for Sun Studio
023188ffb4 INTERFACE_POSITION_INDEPENDENT_CODE: add generator expressions support

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2465
2018-11-12 15:43:07 -05:00
Joachim Wuttke (h)
ff800a768c Help: move CMakeParseArguments to deprecated section 2018-11-11 23:14:37 +01:00
Marc Chevrier
c4b4d8b3a6 POSITION_INDEPENDENT_CODE: Manage link flags for executables
Fixes: #14983, #16561
2018-11-11 17:34:09 +01:00
Sebastian Holtermann
2ef8fe2222 Autogen: Add documentation for CMAKE_GLOBAL_AUTOGEN/RCC_TARGET 2018-11-11 14:29:38 +01:00
Joachim Wuttke (l)
860338491e Help: Describe $CACHE and $ENV as operators
This resolves issue #18514

Also add a cross-reference to if(DEFINED ENV{var}).
2018-11-08 20:33:13 +01:00
Joachim Wuttke (l)
8ba2a8d4a4 Help: short/long variable reference in if command
Explain that the short form of variable references
in the if command does not apply to ENV and CACHE vars.
2018-11-08 20:27:49 +01:00
Joachim Wuttke (h)
85498fccd8 Help: Provide backreferences.
Short intro to pages cmake-variables.7 and cmake-env-variables.7,
with backlinks to cmake-language.7.
2018-11-08 20:27:49 +01:00
Joachim Wuttke (h)
e24ef96942 Help: New section on Environment Variables in cmake-language.7 2018-11-08 20:27:49 +01:00
Joachim Wuttke (h)
e4554149c4 Help: Remove over-precise clause.
Section "Variables References" said that environment and cache
variables are "evaluated in the same contexts as a normal variable
reference". The reader has to guess what "contexts" means in
this context. Probably "inside a Quoted Argument or an Unquoted
Argument", exactly as for ordinary variable references.
But this is exactly what the reader would tacitly assume anyway.
Therefore I think the removed clause was unnecessary, and possibly
more confusing than helpful.
2018-11-08 20:27:49 +01:00
Brad King
bb8da283ce Merge topic 'genex'
86c07b9165 Help: Say early on that generator expressions can be nested.
ab1d7df757 Help: add section on debugging generator expressions.
e0f0f80f02 Help: Explain conversion rules of $<BOOL:string>.
2b2b41f038 Help: Code example for case-insensitive comparison
e045fb202d Help: Terminate explanations with a dot.
3fa0a03b7e Help: Expand placeholders in string comparisons.
fb423b3c49 Help: sort conditional expressions below string-valued ones.
867c9c9c0d Help: Add deprecation date of $<CONFIGURATION>
...

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Alex Turbov <i.zaufi@gmail.com>
Merge-request: !2564
2018-11-07 07:27:27 -05:00
Brad King
389002de96 Merge topic 'FindSQLite3-module'
fe40570608 FindSQLite3: Add module to find SQLite3

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2557
2018-11-07 07:26:46 -05:00
Chuck Atkins
fe40570608 FindSQLite3: Add module to find SQLite3 2018-11-06 15:05:04 -05:00
Brad King
c46dfb2139 Merge topic 'xref2'
2a98a0af46 Help: Link to cmake.org "Get Involved" page from cmake-developer(7)

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2537
2018-11-06 15:02:08 -05:00
Joachim Wuttke (h)
2a98a0af46 Help: Link to cmake.org "Get Involved" page from cmake-developer(7) 2018-11-06 14:24:43 -05:00
Brad King
7bed050755 Merge topic 'autogen_origin_depends'
47f9c15c60 Autogen: Update <ORIGIN>_autogen target documentation
336893d9eb Autogen: Separate AUTOGEN_TARGET_DEPENDS tests into own tests suite
846043dd35 Autogen: Rename MocDepends test to AutogenOriginDependsOn
b71a9598a4 Autogen: Add test for AUTOGEN_ORIGIN_DEPENDS=OFF
f74c406501 Autogen: Add (CMAKE_)AUTOGEN_ORIGIN_DEPENDS release notes
0669de5d36 Autogen: Add (CMAKE_)AUTOGEN_ORIGIN_DEPENDS documentation
b5e895b5d4 Autogen: Add (CMAKE_)AUTOGEN_ORIGIN_DEPENDS support

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2518
2018-11-06 11:38:23 -05:00
Joachim Wuttke (o)
86c07b9165 Help: Say early on that generator expressions can be nested. 2018-11-06 12:55:25 +01:00
Joachim Wuttke (h)
ab1d7df757 Help: add section on debugging generator expressions.
This resolves #18550.
2018-11-06 12:55:25 +01:00
Joachim Wuttke (h)
e0f0f80f02 Help: Explain conversion rules of $<BOOL:string>.
This resolves #18549.
2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
2b2b41f038 Help: Code example for case-insensitive comparison 2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
e045fb202d Help: Terminate explanations with a dot. 2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
3fa0a03b7e Help: Expand placeholders in string comparisons.
And point out that STREQUAL is case sensitive.
2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
fb423b3c49 Help: sort conditional expressions below string-valued ones.
Makes things yet clearer and simpler.
Also correct remnant of "informational expression".
2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
867c9c9c0d Help: Add deprecation date of $<CONFIGURATION> 2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
a85e5e6f4d Help: Add note on omitted <..> notation in cmake-generator-expressions(7) 2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
ff1db47728 Help: Revise documentation of string-valued generator expressions
* Consolidate examples
* Sort, and insert subsection headers
2018-11-06 12:55:24 +01:00
Joachim Wuttke (h)
fe8acf7c05 Help: 3 subtypes of boolean generator expressions.
Main classification by return type,
subclassification by dependences
2018-11-06 12:55:23 +01:00
Joachim Wuttke (h)
9891adf74b Help: Cross-link conditional and boolean expressions.
Rename Logical -> Boolean Generator Expressions.
It's the return type that helps us to sort the expression zoo.
2018-11-06 12:55:23 +01:00
Joachim Wuttke (h)
20b6561e78 Help: new section on conditional generator expressions
Before, the closely related signatures
  $<condition:true_value>
  $<IF:condition,true_value,false_value>
were explained in two different sections.  The former section
was badly explained, with '0' and '1' in place of the formal
parameter 'condition'.
2018-11-06 12:55:23 +01:00
Joachim Wuttke (h)
873e59c0c4 Help: rm unmotivated "This means that"
That generator expressions enable conditional things
has not been said before.

Amended for nicer source format.
2018-11-06 12:55:23 +01:00
Joachim Wuttke (h)
b2a798fe32 Help: expand "ver", "pol", ...
No need to save a few characters on formal parameters.

Use this occasion to correct $<PLATFORM_ID:comp>:
the parameter is a platform_id, not a compiler_id.
2018-11-06 12:55:23 +01:00
Joachim Wuttke (h)
db749f404c Help: expand "..." and "?" in logical generator expressions
Expand "..." and "?", which could be mistaken as metacharacters
(and in the explanations of AND and OR actually were meant as
metacharacters).
2018-11-06 12:55:23 +01:00
Sebastian Holtermann
47f9c15c60 Autogen: Update <ORIGIN>_autogen target documentation 2018-11-05 14:03:01 +01:00
Craig Scott
aa78b61bbc Merge topic 'cpack-gen-docs-link'
c12eefa8fd Help: Fix generators link in cpack(1) manual

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2562
2018-11-04 20:01:08 -05:00
Craig Scott
c12eefa8fd Help: Fix generators link in cpack(1) manual
Minor rewording around the updated link and extra blank line
added to improve readability and remove a potential
ambiguity around the same area.

Fixes: #18545
2018-11-04 08:50:22 +11:00
Sebastian Holtermann
0669de5d36 Autogen: Add (CMAKE_)AUTOGEN_ORIGIN_DEPENDS documentation 2018-11-03 12:14:40 +01:00