Commit Graph

34 Commits

Author SHA1 Message Date
scivision
2931f078dc Help:cmake-language: note new block() command scope 2023-03-02 10:34:56 -05:00
Brad King
e159b5b2ae Merge topic 'doc-improvements'
d4d1f85297 Help: Move a note about arguments and genexes into include file
968224484f Help: Drop unused `PROPERTY_GENEX` replace from `prop_tgt/INTERFACE_*` files
65457e4fae Help: Add _See Also_ sections to related CMake commands
c86ec79d07 Help: Use direct refs to genexes instead of ``$<GENEX-NAME>``
8c6274326d Help: Use CMake highlighting for command synopsis
c356a94512 Help: Use monospaced font for a genex name in a section title
f98c8707f4 Help: Use `code-block:: cmake` instead of `::` for sub-commands descriptions
2ba351ca4f Help: ``CMake`` → CMake
...

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7873
2022-11-10 10:11:22 -05:00
Alex Turbov
435b0c573c Help: Fix some redirects reported with sphinx linkcheck
Mostly it's about replace `http:` with `https:` protocol.
2022-11-07 10:07:36 -05:00
Alex Turbov
295062ef4b
Help: Add some more :option: role to cmake-language(7) manual 2022-11-06 03:43:30 +04:00
Alex Turbov
8a3e732b9b
Help: Add ATTENTION for comments in the cmake-language(7) manual
Some editors (OK, mine, I use `kate`) highlight some capitalized
"keywords" (like `TODO`, `NOTE`, &etc)  in comments.
2022-11-06 03:41:07 +04:00
Brad King
159acea394 Help: Clarify that variable references may use cache entries
Clarify in `cmake-language(7)` that a variable lookup may use a cache
entry if the variable is not set.  Fix misleading text in added by
commit 8ba2a8d4a4 (Help: short/long variable reference in if command,
2018-11-01, v3.14.0-rc1~408^2~2).

Fixes: #23863
2022-08-18 09:04:08 -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
Brad King
02cf404ace Help: Add advice for dealing with semicolons in lists
Issue: #23315
2022-03-15 15:49:13 -04:00
Robert Maynard
2158ef3e44 Help: Document which variable names CMake reserves. 2020-01-29 10:50:36 -05:00
Kyle Edwards
124564504a Help: Clarify that bracket comments start with bracket open
Fixes: #19264
2019-05-16 17:55:38 -04: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 (o)
14edbe7e7b Help: Syntax highlighting for long strings in cmake-language.7 2018-10-25 14:00:34 +02:00
Joachim Wuttke (o)
fc7ee1ca45 Help: Override pygments CMakeLexer to support <..> and [..]
* The code snippets in the docs consist of CMake code mixed
  with syntax definition punctuation like < > [ ] ... Therefore
  a pure CMake lexer is inadequate. Here it is replaced by a
  CMake syntax definition parser.
* Fixed syntax definition snippets in FindPkgConfig.cmake to
  make best use of syntax highlighting. This source file is the
  hardest to support because it contains comparison operators
  <= = >=, which need special attention to avoid confusion
  with the placeholder indicators <...>.
* Fixed syntax in execute_process.rst (there were unbalanced
  brackets).
* Disabled syntax highlighting for long string examples in
  cmake-language.7.rst.
* No highlighting of removed syntax in CMP0049
* To inspect the outcome of this patch, see e.g. the pages
  * manual/cmake-buildsystem.7.html
  * module/ExternalProject.html
  * module/FindPkgConfig.html
  which are particularly rich in complex code snippets.
2018-10-19 07:25:34 +11:00
Ben Boeckel
82a4822610 CMP0053: document that $ is a valid literal variable character
This was overlooked in the initial implementation of CMP0053. However,
an additional policy to reject it again is not worth it. Instead, add
tests and document the behavior.

Fixes: #17883
2018-10-15 13:59:39 -04:00
Robert Maynard
4d384d290e Help: Document the $CACHE{} syntax
Also add a test case for the behavior.
2018-08-07 13:13:27 -04:00
Brad King
1ed11f1c0d Help: Minor text clarifications in cmake-language(7) manual
Clarify definitions of `bracket_open` and `bracket_close` productions.

In note about unquoted arguments containing unescaped double quotes,
provide examples of how they can be written as quoted arguments.

Also clarify location of nested calls supported by variable function
scope.

Suggested-by: Дилян Палаузов <dilyan.palauzov@aegee.org>
2017-10-10 11:26:00 -04:00
Michael Maltese
1dc1301925 Help: Clarify 'make-style' variable references in cmake-language(7)
Fixes: #16661
2017-02-22 13:39:09 -08:00
Brad King
30abf145fd Help: Fix cmake code block warnings produced by Sphinx 1.4
Some of our "cmake" code blocks do not use fully valid CMake syntax
because they have placeholders for human reference.  Sphinx has
never been able to properly lex and highlight these, but now warns.
Fix each block's syntax or change to a non-cmake block as appropriate.
2017-02-10 10:43:30 -05:00
Brad King
c6593511bb Help: Add link target to cmake-language.7 variables section 2015-04-01 16:24:24 -04:00
Brad King
845c83756e Help: Add link target to cmake-language.7 lists section 2015-03-31 08:51:03 -04:00
Brad King
3a4381b660 Help: Add link target to cmake-language.7 encoding section 2015-02-05 08:43:21 -05:00
Clinton Stimpson
cdc29c3608 Encoding: Switch to use UTF-8 internally by default on Windows.
This fixes several reported bugs about CMake not handling
non-ascii paths on Windows.

Practically, the use of some unicode characters may still
be limited by the build or compiler tools.

For example, a user may be limited by the build tools to
using characters within the Windows ANSI code page (which can
include non-ascii characters in the current system language).
2015-01-16 09:39:32 -05:00
Gregor Jasny
0de867dde2 continue: Add a new CMake language command for loop continuation (#14013)
Inspired-by: Doug Barbieri
Signed-off-by: Gregor Jasny <gjasny@googlemail.com>
2014-12-01 09:50:49 -05:00
Brad King
79349ed8fc Help: Tell latex to use a small font for cmake-language.7 productions 2014-11-06 14:52:27 -05:00
Brad King
a9dcf4773c Help: Drop TOC from latex manuals
A latex document can have its own TOC.
2014-11-06 14:46:18 -05:00
Ben Boeckel
6804cd042e Help: Add documentation on escaping changes with CMP0053 2014-05-08 13:24:50 -04:00
Brad King
c179b2898e Help: Add more reference targets to cmake-language.7 2014-05-08 13:24:22 -04: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
Brad King
45a03aa654 Help: Document $ENV{VAR} syntax in cmake-language.7 manual 2013-11-25 08:55:28 -05:00
Brad King
a931ee4414 Help: Add cmake-language.7 manual 2013-11-08 08:41:46 -05:00