diff options
author | Lang Hames <lhames@gmail.com> | 2017-08-24 05:38:39 +0000 |
---|---|---|
committer | Lang Hames <lhames@gmail.com> | 2017-08-24 05:38:39 +0000 |
commit | 5a19c2915c582884efd66502fff2b0b0ec8d7e04 (patch) | |
tree | 43fdc4130e2efd0d68b6b9f1b7f2d63ffd4b2a6e /docs | |
parent | a69b2ae909f779a5292c1831aa803044bf93e501 (diff) | |
download | llvm-5a19c2915c582884efd66502fff2b0b0ec8d7e04.tar.gz |
[docs] In the CMake primer, correct the description of the ARGV/ARGN variables.
ARGN is the sublist of unnamed arguments, not the count of the arguments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@311632 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CMakePrimer.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/CMakePrimer.rst b/docs/CMakePrimer.rst index 7f9bc727965..72ebffa5bdd 100644 --- a/docs/CMakePrimer.rst +++ b/docs/CMakePrimer.rst @@ -336,15 +336,15 @@ to the ``macro`` block as well. CMake commands can have named arguments that are requried at every call site. In addition, all commands will implicitly accept a variable number of extra arguments (In C parlance, all commands are varargs functions). When a command is -invoked with extra arguments (beyond the named ones) CMake will store the extra -arguments in a list named ``ARGV``, and the count of the extra arguments in -``ARGN``. Below is a trivial example of providing a wrapper function for CMake's -built in function ``add_dependencies``. +invoked with extra arguments (beyond the named ones) CMake will store the full +list of arguments (both named and unnamed) in a list named ``ARGV``, and the +sublist of unnamed arguments in ``ARGN``. Below is a trivial example of +providing a wrapper function for CMake's built in function ``add_dependencies``. .. code-block:: cmake function(add_deps target) - add_dependencies(${target} ${ARGV}) + add_dependencies(${target} ${ARGN}) endfunction() This example defines a new macro named ``add_deps`` which takes a required first |