summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorRuslan Baratov <ruslan_baratov@yahoo.com>2015-10-20 20:53:37 (GMT)
committerBrad King <brad.king@kitware.com>2015-10-21 12:51:54 (GMT)
commit5a208f834ea6d786611a5dc34dd7ed1d781dd1bc (patch)
tree9a942d77f6553be2908356d7b2cb41e5d8558d10 /Help/command
parent3187de20fd9949ab90df4651f5d1ae0d218a9afd (diff)
downloadCMake-5a208f834ea6d786611a5dc34dd7ed1d781dd1bc.zip
CMake-5a208f834ea6d786611a5dc34dd7ed1d781dd1bc.tar.gz
CMake-5a208f834ea6d786611a5dc34dd7ed1d781dd1bc.tar.bz2
Help: Document that file(GLOB*) order is undefined
Since this command use 'readdir' under the hood the order of list is undefined: * http://stackoverflow.com/questions/8977441/does-readdir-guarantee-an-order
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/file.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index bbddd40..96ac6c7 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -103,7 +103,8 @@ Generate a list of files that match the ``<globbing-expressions>`` and
store it into the ``<variable>``. Globbing expressions are similar to
regular expressions, but much simpler. If ``RELATIVE`` flag is
specified, the results will be returned as relative paths to the given
-path.
+path. No specific order of results is defined. If order is important then
+sort the list explicitly (e.g. using the :command:`list(SORT)` command).
By default ``GLOB`` lists directories - directories are omited in result if
``LIST_DIRECTORIES`` is set to false.