Commit Graph

13 Commits

Author SHA1 Message Date
Craig Scott 8086badba4 Help: Fix wrong return values for unset inherited properties
Since ff6234509e (Help: Clarify behavior of INHERITED properties, 2018-03-21),
the docs for some get_..._property() commands incorrectly describe
the behavior for inherited properties. When a property is not set, even
in a parent scope, the returned result from the get_..._property()
command is the same whether the property is inherited or not.
The docs incorrectly stated that an empty string would be returned
for inherited properties in such cases.
2024-01-05 17:40:16 +11:00
Craig Scott 34379f005b Help: Use <variable> consistently in property getter commands
Property-related commands used a mix of <VAR>, <var>, or
<variable> to specify the variable to store the result in. The <VAR>
form is particularly confusing, since being uppercase it looks more
like a keyword. Use <variable> consistently across all the commands
so that the behavior is clear.
2024-01-05 15:37:39 +11:00
Craig Scott 29ccc9a4cd Help: Use <xxx> for non-keyword arguments in property command signatures 2024-01-05 15:31:39 +11:00
Alex Turbov 65457e4fae Help: Add _See Also_ sections to related CMake commands 2022-11-09 23:52:30 +04:00
Christopher Tetreault f4b911a2c9 Help: Update docs for failure result of get_target_property
If `get_target_property` fails to find a value for a non-inherited
property, it appends `-NOTFOUND` to the var name and sets that as the
result, rather than setting the value of the var to `NOTFOUND`.
2020-06-23 08:17:59 -04:00
Bartosz Kosiorek 456e0fb64f Help: Improve documentation formating 2019-04-04 15:13:58 +02:00
Tobias Hunger 34b7003d2a Documentation: Reference list of target properties in get_target_property 2018-12-13 11:05:04 +01:00
Joachim Wuttke (o) adbaadf0ee Help: Apply syntax highlighting to project commands
* Replace most "::" by ".. code-block:: cmake"
  * Header sentence in imperative voice,
    detailed command description in present tense.
2018-10-25 13:47:31 +02:00
Yee Fan 20d90a9482 Help: Some spelling corrections for commands. 2018-04-21 00:37:09 +08:00
Craig Scott ff6234509e Help: Clarify behavior of INHERITED properties
Fixes: #17839
2018-03-21 21:39:54 +11:00
Bartosz Kosiorek 88968265e2 Help: Improve markup in get_target_property documentation 2016-01-28 10:12:50 -05:00
Michael Scott c3f40f4fd9 Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 16:28:31 -04:00
Kitware Robot f051814ed0 Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.
2013-10-15 14:12:03 -04:00