summaryrefslogtreecommitdiffstats
path: root/Help/command/list.rst
diff options
context:
space:
mode:
authorMichael Scott <michael.scott250@gmail.com>2015-06-04 21:51:22 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-08 20:28:31 (GMT)
commitc3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch)
tree4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/list.rst
parentd17aa60659a1a69f9101c61a149eca5842291226 (diff)
downloadCMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more places.
Diffstat (limited to 'Help/command/list.rst')
-rw-r--r--Help/command/list.rst48
1 files changed, 24 insertions, 24 deletions
diff --git a/Help/command/list.rst b/Help/command/list.rst
index aeb1e94..a7a05c7 100644
--- a/Help/command/list.rst
+++ b/Help/command/list.rst
@@ -17,45 +17,45 @@ List operations.
list(REVERSE <list>)
list(SORT <list>)
-LENGTH will return a given list's length.
+``LENGTH`` will return a given list's length.
-GET will return list of elements specified by indices from the list.
+``GET`` will return list of elements specified by indices from the list.
-APPEND will append elements to the list.
+``APPEND`` will append elements to the list.
-FIND will return the index of the element specified in the list or -1
+``FIND`` will return the index of the element specified in the list or -1
if it wasn't found.
-INSERT will insert elements to the list to the specified location.
+``INSERT`` will insert elements to the list to the specified location.
-REMOVE_AT and REMOVE_ITEM will remove items from the list. The
-difference is that REMOVE_ITEM will remove the given items, while
-REMOVE_AT will remove the items at the given indices.
+``REMOVE_AT`` and ``REMOVE_ITEM`` will remove items from the list. The
+difference is that ``REMOVE_ITEM`` will remove the given items, while
+``REMOVE_AT`` will remove the items at the given indices.
-REMOVE_DUPLICATES will remove duplicated items in the list.
+``REMOVE_DUPLICATES`` will remove duplicated items in the list.
-REVERSE reverses the contents of the list in-place.
+``REVERSE`` reverses the contents of the list in-place.
-SORT sorts the list in-place alphabetically.
+``SORT`` sorts the list in-place alphabetically.
-The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM,
-REMOVE_DUPLICATES, REVERSE and SORT may create new values for the list
-within the current CMake variable scope. Similar to the SET command,
-the LIST command creates new variable values in the current scope,
-even if the list itself is actually defined in a parent scope. To
-propagate the results of these operations upwards, use SET with
-PARENT_SCOPE, SET with CACHE INTERNAL, or some other means of value
-propagation.
+The list subcommands ``APPEND``, ``INSERT``, ``REMOVE_AT``, ``REMOVE_ITEM``,
+``REMOVE_DUPLICATES``, ``REVERSE`` and ``SORT`` may create new values for
+the list within the current CMake variable scope. Similar to the
+:command:`set` command, the LIST command creates new variable values in the
+current scope, even if the list itself is actually defined in a parent
+scope. To propagate the results of these operations upwards, use
+:command:`set` with ``PARENT_SCOPE``, :command:`set` with
+``CACHE INTERNAL``, or some other means of value propagation.
-NOTES: A list in cmake is a ; separated group of strings. To create a
-list the set command can be used. For example, set(var a b c d e)
-creates a list with a;b;c;d;e, and set(var "a b c d e") creates a
+NOTES: A list in cmake is a ``;`` separated group of strings. To create a
+list the set command can be used. For example, ``set(var a b c d e)``
+creates a list with ``a;b;c;d;e``, and ``set(var "a b c d e")`` creates a
string or a list with one item in it. (Note macro arguments are not
variables, and therefore cannot be used in LIST commands.)
-When specifying index values, if <element index> is 0 or greater, it
+When specifying index values, if ``<element index>`` is 0 or greater, it
is indexed from the beginning of the list, with 0 representing the
-first list element. If <element index> is -1 or lesser, it is indexed
+first list element. If ``<element index>`` is -1 or lesser, it is indexed
from the end of the list, with -1 representing the last list element.
Be careful when counting with negative indices: they do not start from
0. -0 is equivalent to 0, the first list element.