mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity
77,393 Commits 2 Branches 414 Tags
master
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Joachim Wuttke (h) 9517ab36e1 cmELF: correct error message from GetDynamicSectionString 
Fixes: #25929
 2024-04-25 10:30:08 -04:00
Joachim Wuttke (h) d2d2ffe1c1 Help: file: document GET_RUNTIME_DEPENDENCIES separately 
Moved documentation of file(GET_RUNTIME_DEPENDENCIES ...) from
the 'Reading' section to a separate section at the bottom of
the page. Because it is a very long text, and because this
signature is quite different from all the others in the
'Reading' section.
 2024-04-24 15:28:39 +02:00
Joachim Wuttke (h) 0aea13d20b Help: for message(FATAL_ERROR), document nonzero exit code 2022-05-05 09:43:39 -04:00
Joachim Wuttke (h) a693da21f3 Help: from command:if, link to environment variables 2022-05-05 09:37:20 -04:00
Joachim Wuttke (h) ab2bdbaf31 Help: Cross-reference ENV operator from cmake-language(7) manual 2022-05-05 09:36:23 -04:00
Joachim Wuttke (h) ee4e728a69 Help: From Environment Variables section, link to cmake -E env etc 2022-05-05 09:35:57 -04:00
Joachim Wuttke (h) cc97725137 Help: document exit code of command cmake(1) 2022-05-04 14:17:01 +02:00
Joachim Wuttke (h) 39c410624a Tutorial: in step 7, disambiguate installed/source archive 2021-11-30 12:32:12 -05:00
Joachim Wuttke (h) 44c527bc63 Tutorial: Package only one source archive 2021-11-30 12:31:55 -05:00
Joachim Wuttke (h) 4f524797dc Tutorial: Order install(TARGETS) EXPORT option consistently with docs 2021-11-30 12:23:56 -05:00
Joachim Wuttke (o) 1ad991a13e Help: correct typo in ExternalData (duplicate "of") 2020-09-07 14:27:01 +02:00
Joachim Wuttke (h) 9a25278f8c Help: advise against CMAKE_INSTALL_PREFIX in install DESTINATION. 
as per my uncontradicted post
 https://discourse.cmake.org/t/local-install-vs-install-for-cpack-absolute-vs-relative-path/623/2?u=jwuttke
 2020-07-08 15:09:19 +02:00
Joachim Wuttke (h) ca9bd43f2d Help: Duplicate essential information on install paths in CPack. 2020-07-08 14:59:01 +02:00
Joachim Wuttke (h) f8b7acaf90 Help: Fix CPack module docs on config file for source package 2020-07-08 08:36:00 -04:00
Joachim Wuttke (h) a468cc431c FindTIFF: add component CXX to include the C++ wrapper libtiffxx 
Fixes: #20860
 2020-06-29 11:55:22 -04:00
Joachim Wuttke (h) 448e2d7a9d Help: Provide cross-references between compiler settings 2020-05-14 22:17:10 +02:00
Joachim Wuttke (h) 1f697b3991 Help: COMPILE_OPTIONS: bundle cross refs, add example 2020-05-14 22:05:30 +02:00
Joachim Wuttke (h) d98064f156 Help: cmake-generator-expressions(7): Target-Dependent Queries 
Explain ``tgt`` at beginning of section.
Then refer to ``tgt`` without redundant reexplanations.
 2020-02-25 10:39:18 -05:00
Joachim Wuttke (o) 1af49def54 Help: CPackIFW generator: offline installer 
Bundle subsections under "Other Settings".
Improve explanation of the Online installer.
 2020-02-20 20:25:34 +01:00
Joachim Wuttke (o) 466b138ea2 Help: string: regex match and replace is a subcase of Search&Replace 2020-02-17 17:42:50 +01:00
Joachim Wuttke (o) 22aac6669b Help: install: use bullet lists to sort out target kinds 2020-02-17 11:29:50 -05:00
Joachim Wuttke (o) b3f4d50348 Help: ifw.rst: Add toc; mv "Hints" section -> subsection of "Variables" 
Also explain `@ApplicationsDir@`, thanks to
https://discourse.cmake.org/t/647/2 for help.
 2020-02-17 11:14:52 -05:00
Joachim Wuttke (o) c671966c20 Help: CPackComponent: Sectioning and rewording 
* Insert section and subsection headers (because this is a very long
    doc page)
* In the Introduction, first say that module is included automatically
* Then start with operational definition of components
* Remove duplications
* Also reword the description of the command cpack_add_component
 2020-02-17 16:12:15 +01:00
Joachim Wuttke (o) 05e56b1897 Help: FetchContent, ExternalProject: Command sections -> subsections 2020-02-17 12:15:57 +01:00
Joachim Wuttke (h) 6a4743b2c3 Help: Correct typos in CPack docs 2020-02-17 08:20:53 +11:00
Joachim Wuttke (o) 0ea52ece71 Help: module CPack: improve summary and Introduction 
* In summary:
  * we configure generators, not the generated installers
  * we generate installers or source packages, not source package installers

* In Introduction:
  * Make paragraph on binary installers more concise
  * Remove example that refered to CMake source tree
  * Add paragraph on source packages
  * omit the parenthesis on graphical installers
 2020-02-14 21:49:47 +11:00
Joachim Wuttke (o) 5c4d730dd4 Help: CPackComponent: improve summary and introduction 
Also:
* provide some hyperlinks
* update parenthesis on graphical installers (no longer restricted
  to Win and macOS)
 2020-02-14 21:49:22 +11:00
Joachim Wuttke (o) 40da958d23 Help: CPack Archive Generator: Clarify source vs binary package 
- Simplify summary
- Revise introduction:
  - Explain how to package source files, provide configuration sample
  - Clarify source vs binary package
- Clarify meaning of variables
   (Mandatory=ON makes no sense if a default is defined)
 2020-02-14 21:47:08 +11:00
Joachim Wuttke (o) fdf50941d2 Help: CPack IFW Generator: not only configures, but also runs QtIFW. 2020-02-13 08:46:04 +01:00
Joachim Wuttke (o) 6bb248c133 Help: More cross references between CPackIFW and CPackIFWGenerator. 
And more concise section "QtIFW Tools".
 2020-02-13 08:14:07 +01:00
Joachim Wuttke (o) 79e1d86d2c Help: command install: absolute paths unsupported by CPack 
Advise against absolute DESTINATIONs as they are not supported
by CPack installer generators.
 2020-02-12 19:40:04 +01:00
Joachim Wuttke (o) 59e9f33d78 Help: module CPack: New section on targets. 
To explain in full detail to what extent the targets package and
package_source are supported by different generators.
 2020-02-12 09:49:26 -05:00
Joachim Wuttke (o) f33708eed9 Help: module CPack: add cross-reference to cpack-generators(7). 2020-02-12 13:37:15 +01:00
Joachim Wuttke (o) 4949e1261a Help: module CPack. Explain usage of the build targets. 
Explain the usage of the two new build targets, package and
package_source.
 2020-02-12 13:23:08 +01:00
Joachim Wuttke (o) 72eaeb41f5 Help: module CPack: correction: 2 config files are generated, not just 1 
Besides CPackConfig.cmake, the module also generates CPackSourceConfig.cmake.
 2020-02-12 13:22:51 +01:00
Joachim Wuttke (o) c35a9ff9c3 Help: CPack module: Correct the summary (configure, not build) 
Including CPack does not "build" installers.
It just *configures* them.
 2020-02-12 12:37:48 +01:00
Joachim Wuttke (o) 1e9328a00d Help: CMakePrintSystemInformation.cmake: Minor corrections. 
Punctuation.
"file" -> "module"
 2020-02-12 12:34:08 +01:00
Joachim Wuttke (o) e240371ab1 Help: CPackIFWGenerator: explain relation to CPackIWF 
* Make overview more focussed
* Explain the relation to CPackIFW
 2020-02-11 10:47:26 -05:00
Joachim Wuttke (o) 78779c6111 Help: Show external link only once per page; explain abbreviation QtIFW. 2020-02-11 10:47:26 -05:00
Joachim Wuttke (l) 0295b153f4 Help: describe the command pipeline of execute_process more explicitly 
When reading the doc page on execute_process, I was mislead by the
words "in parallel". They convinced at once that the processes
are run independently of each other, so that I did not even bother
to read further. The rewording, and not least the insertion of a
paragraph break, should prevent such oversight.
 2019-03-20 18:25:52 +01:00
Joachim Wuttke (l) 33efdfc0b5 Help: improve source formatting 2019-03-20 18:19:10 +01:00
Joachim Wuttke (l) cd524c1c33 Help: describe what happens if command execute_process reaches timeout. 2019-03-20 18:17:29 +01:00
Joachim Wuttke (o) 538e699e5a Help: for command enable_testing, explain relation to module CTest. 2019-03-07 11:58:22 +01:00
Joachim Wuttke (o) 60a8d4c5f4 CPack/IFW: Correct wording in error message 2019-02-07 06:51:15 -05:00
Joachim Wuttke (o) 9d20fe014f Help: moved 7 variables to "internal" section 2019-01-30 16:13:13 +01:00
Joachim Wuttke (o) dfb2d6178e Help: "internal variables" instead of "obsolete", with some explanatory prose 2019-01-30 16:13:10 +01:00
Joachim Wuttke (o) 9c4cdc43f6 Help: declare CMAKE_HOME_DIRECTORY obsolete 2019-01-30 13:04:56 +01:00
Joachim Wuttke (o) bfc3670546 Help: Provide cross-references from and to set_property 2019-01-10 16:13:18 +01:00
Joachim Wuttke (o) 20b7826e14 Help: correct alphabetical sorting of lines 2019-01-10 12:58:59 +01:00
Joachim Wuttke (o) 5a5a1d90f0 Help: FindThreads not needed with modern C++. 2019-01-09 11:03:44 +01:00
Joachim Wuttke (h) 2439d546c8 Help: Revise compile options command docs, and provide example 
For add_compile_options and target_compile_options:
- Insert sections.
- Provide cross-links between the two doc pages
- Alleviate and explain links to the commands
  ...compile_definitions and ...include_directories.
- Alleviate link to COMPILE_OPTIONS, and integrate it into
  the synopsis.
 2018-12-20 10:45:49 +01:00
Joachim Wuttke (h) 0861580a14 Help: Insert link from CONTRIBUTING to build instructions 2018-12-18 17:11:13 +01: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
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
Joachim Wuttke (l) 22cca9b810 Help: describe differences between macro and function. 2018-11-14 21:56:23 +01:00
Joachim Wuttke (l) b90ae70a3b Help: in macro vs function example, use lowercase names. 
Follow our own advise not to change cases.

Omit the leading underscore.
 2018-11-14 20:33:12 +01:00
Joachim Wuttke (o) 254a849864 Help: Spell out MFC 
And shorten text that was hard to understand and redundant.
 2018-11-14 17:50:45 +01:00
Joachim Wuttke (o) b173c641c4 Help: Add links to variables 2018-11-14 17:50:45 +01:00
Joachim Wuttke (l) abb5945bd0 Help: Document that function invocation is case-insensitive 2018-11-13 13:47:26 -05:00
Joachim Wuttke (l) 357cdee3a1 Help: Document that macro invocation is case-insensitive 2018-11-13 13:47:24 -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
Joachim Wuttke (l) dcf11cbcdc Help: Mention endmacro argument as legacy only. 
Same change as previously done for function, if, while, ...
 2018-11-13 12:14:55 +01:00
Joachim Wuttke (l) fe15a1029c Help: Revise documentation of SelectLibraryConfigurations 
List format for chosen variables.

New paragraph before description of special cases.
 2018-11-13 12:12:52 +01:00
Joachim Wuttke (l) 26a70449cc Help: Describe environment variables as such. 
In each environment variable doc page, insert an opening
paragraph (ENV_VAR.txt) to say that this is an environment
variable, and provide a link to the cmake-language section
on environment variables.
 2018-11-13 09:29:36 +01:00
Joachim Wuttke (l) 0470ee96b1 Help: Remove duplication of function name. 2018-11-12 22:33:11 +01:00
Joachim Wuttke (o) 3a7f02197b Help: Downcase function names in DeployQt4 doc. 2018-11-12 19:51:43 +01:00
Joachim Wuttke (o) 96c31fad71 Help: Downcase functions in BundleUtilities 
Presumably, capitalization was left over from very old times
 2018-11-12 15:49:31 +01:00
Joachim Wuttke (o) f05d7ed5ff Help: correct macro -> function in CheckPrototypeDefinition 
Correct in text, and downcase function name in function statement.
 2018-11-12 15:41:09 +01:00
Joachim Wuttke (l) 89b5f4fcc7 Help: Correct macro -> function in FindPackageMessage. 
Correct in the text, and change capitalization accordingly.
 2018-11-12 15:34:41 +01:00
Joachim Wuttke (h) e286627334 Help: Insert section headers in CPack module 
The one extant section header was confusing at least:
Not all the doc page is on Variables.
 2018-11-12 09:18:02 -05:00
Joachim Wuttke (l) 36e9d2d124 Help: remove reference to inexistent file DocumentationVTK.cmake. 2018-11-12 14:27:41 +01:00
Joachim Wuttke (h) 1c94129e98 Help: correct macro -> function in CMakePrintHelpers 
and apply lower case throughout
 2018-11-11 23:18:37 +01:00
Joachim Wuttke (h) ff800a768c Help: move CMakeParseArguments to deprecated section 2018-11-11 23:14:37 +01:00
Joachim Wuttke (h) b93b3b5500 Help: better summary and xrefs for CMakeAddFortranSubdirectory 2018-11-11 22:57:13 +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 (h) e855bd5248 Help: Document if(DEFINED ENV{name}) 2018-11-08 20:30:05 +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
Joachim Wuttke (h) 3de551cc22 Help: Clarify effect of set(ENV{..} ..) and unset(ENV{..}) 
Explain that the commands affect only the current CMake process,
not the process from which CMake was called,
nor the system environment at large,
nor the environment of subsequent build or test processes.
 2018-11-08 20:27:10 +01: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
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
Joachim Wuttke (o) 1610543863 Use_wxWindows: Correct version of deprecation 
The deprecation note was added only recently, but the code
emitted a deprecation message since 2.8.9 or 2.8.10, from
what one can tell from the git history. This is now
documented as ".. deprecated:: 2.8.10".
 2018-10-26 09:18:52 -04:00