summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-language.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'doc-improvements'Brad King2022-11-101-11/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * Help: Add some more `:option:` role to `cmake-language(7)` manualAlex Turbov2022-11-051-8/+8
| |
| * Help: Add `ATTENTION` for comments in the `cmake-language(7)` manualAlex Turbov2022-11-051-3/+3
| | | | | | | | | | Some editors (OK, mine, I use `kate`) highlight some capitalized "keywords" (like `TODO`, `NOTE`, &etc) in comments.
* | Help: Fix some redirects reported with sphinx linkcheckAlex Turbov2022-11-071-1/+1
|/ | | | Mostly it's about replace `http:` with `https:` protocol.
* Help: Clarify that variable references may use cache entriesBrad King2022-08-181-6/+8
| | | | | | | | | 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
* Help: Cross-reference ENV operator from cmake-language(7) manualJoachim Wuttke (h)2022-05-051-1/+2
|
* Help: From Environment Variables section, link to cmake -E env etcJoachim Wuttke (h)2022-05-051-0/+7
|
* Help: Add advice for dealing with semicolons in listsBrad King2022-03-151-0/+42
| | | | Issue: #23315
* Help: Document which variable names CMake reserves.Robert Maynard2020-01-291-0/+2
|
* Help: Clarify that bracket comments start with bracket openKyle Edwards2019-05-161-3/+3
| | | | Fixes: #19264
* Help: short/long variable reference in if commandJoachim Wuttke (l)2018-11-081-3/+9
| | | | | Explain that the short form of variable references in the if command does not apply to ENV and CACHE vars.
* Help: Provide backreferences.Joachim Wuttke (h)2018-11-081-2/+3
| | | | | Short intro to pages cmake-variables.7 and cmake-env-variables.7, with backlinks to cmake-language.7.
* Help: New section on Environment Variables in cmake-language.7Joachim Wuttke (h)2018-11-081-1/+28
|
* Help: Remove over-precise clause.Joachim Wuttke (h)2018-11-081-4/+2
| | | | | | | | | | | 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.
* Help: Syntax highlighting for long strings in cmake-language.7Joachim Wuttke (o)2018-10-251-13/+17
|
* Help: Override pygments CMakeLexer to support <..> and [..]Joachim Wuttke (o)2018-10-181-7/+10
| | | | | | | | | | | | | | | | | | | | | | * 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.
* CMP0053: document that `$` is a valid literal variable characterBen Boeckel2018-10-151-2/+3
| | | | | | | | 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
* Help: Document the $CACHE{} syntaxRobert Maynard2018-08-071-0/+7
| | | | Also add a test case for the behavior.
* Help: Minor text clarifications in cmake-language(7) manualBrad King2017-10-101-8/+10
| | | | | | | | | | | | 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>
* Help: Clarify 'make-style' variable references in cmake-language(7)Michael Maltese2017-02-221-0/+6
| | | | Fixes: #16661
* Help: Fix cmake code block warnings produced by Sphinx 1.4Brad King2017-02-101-2/+2
| | | | | | | 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.
* Help: Add link target to cmake-language.7 variables sectionBrad King2015-04-011-0/+2
|
* Help: Add link target to cmake-language.7 lists sectionBrad King2015-03-311-0/+2
|
* Help: Add link target to cmake-language.7 encoding sectionBrad King2015-02-051-0/+2
|
* Encoding: Switch to use UTF-8 internally by default on Windows.Clinton Stimpson2015-01-161-3/+5
| | | | | | | | | | | | 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).
* continue: Add a new CMake language command for loop continuation (#14013)Gregor Jasny2014-12-011-2/+4
| | | | | Inspired-by: Doug Barbieri Signed-off-by: Gregor Jasny <gjasny@googlemail.com>
* Help: Tell latex to use a small font for cmake-language.7 productionsBrad King2014-11-061-0/+72
|
* Help: Drop TOC from latex manualsBrad King2014-11-061-1/+1
| | | | A latex document can have its own TOC.
* Help: Add documentation on escaping changes with CMP0053Ben Boeckel2014-05-081-6/+13
|
* Help: Add more reference targets to cmake-language.7Brad King2014-05-081-0/+4
|
* Help: Add hyperlink targets for argument types in cmake-language(7)Brad King2014-02-071-0/+6
| | | | | Add reStructuredText hyperlink targets for the bracket, quoted, and unquoted argument sections.
* Help: Document $ENV{VAR} syntax in cmake-language.7 manualBrad King2013-11-251-0/+3
|
* Help: Add cmake-language.7 manualBrad King2013-11-081-0/+470