summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorJoachim Wuttke (l) <j.wuttke@fz-juelich.de>2018-11-14 08:10:31 (GMT)
committerJoachim Wuttke (l) <j.wuttke@fz-juelich.de>2018-11-14 19:33:12 (GMT)
commitb90ae70a3b3c77109a31dfc275b778205a817d1a (patch)
tree0ad1d37b7fb16a76886ba71012e6842424fd3f19 /Help/command
parent117272412e9dee1a1595718590a48e4c6750df59 (diff)
downloadCMake-b90ae70a3b3c77109a31dfc275b778205a817d1a.zip
CMake-b90ae70a3b3c77109a31dfc275b778205a817d1a.tar.gz
CMake-b90ae70a3b3c77109a31dfc275b778205a817d1a.tar.bz2
Help: in macro vs function example, use lowercase names.
Follow our own advise not to change cases. Omit the leading underscore.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/macro.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Help/command/macro.rst b/Help/command/macro.rst
index e15e206..7450929 100644
--- a/Help/command/macro.rst
+++ b/Help/command/macro.rst
@@ -98,18 +98,18 @@ existing variable instead of the arguments. For example:
.. code-block:: cmake
- macro(_BAR)
+ macro(bar)
foreach(arg IN LISTS ARGN)
<commands>
endforeach()
endmacro()
- function(_FOO)
- _bar(x y z)
+ function(foo)
+ bar(x y z)
endfunction()
- _foo(a b c)
+ foo(a b c)
-Will loop over ``a;b;c`` and not over ``x;y;z`` as one might be expecting.
+Will loop over ``a;b;c`` and not over ``x;y;z`` as one might have expected.
If you want true CMake variables and/or better CMake scope control you
should look at the function command.