diff options
| author | Joachim Wuttke (l) <j.wuttke@fz-juelich.de> | 2018-10-16 19:50:48 (GMT) |
|---|---|---|
| committer | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2018-10-23 13:12:10 (GMT) |
| commit | c2efb3efcd083523a73a2a9721b7101fbfc0fe0f (patch) | |
| tree | 51feae595367cd8b91ab27c34000129c9a8c38b6 /Help/command/endwhile.rst | |
| parent | 7053dd301c694bbc5e13b7e32febd34596b22d4e (diff) | |
| download | CMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.zip CMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.tar.gz CMake-c2efb3efcd083523a73a2a9721b7101fbfc0fe0f.tar.bz2 | |
Help: Revise docs on Scripting Commands
Revise docs for all "Scripting Commands", except four find_XXX
that use a macro suite of their own.
* Take full advantage of the improved syntax highlighting.
* Make consequential use of <..> placeholders.
* Clarify things here and there in the text.
Specific improvements to some command docs:
* "math": Correct description of novel hexadecimal capability.
* "if", "foreach", "while": Provide link to "endif" etc
* "foreach", "while": Mention "break" and "continue".
* "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures;
advise against negative arguments or reverse ranges (compare issue #18461)
* "endif", "endfunction" etc: Explain that the argument is optional and
maintained for compatibility only
Diffstat (limited to 'Help/command/endwhile.rst')
| -rw-r--r-- | Help/command/endwhile.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Help/command/endwhile.rst b/Help/command/endwhile.rst index 798c20e..5ef585b 100644 --- a/Help/command/endwhile.rst +++ b/Help/command/endwhile.rst @@ -3,8 +3,12 @@ endwhile Ends a list of commands in a while block. -:: +.. code-block:: cmake - endwhile(expression) + endwhile([<condition>]) See the :command:`while` command. + +The optional ``<condition>`` argument is supported for backward compatibility +only. If used it must be a verbatim repeat of the argument of the opening +``while`` clause. |