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
This commit is contained in:
Ruslan Baratov 2015-10-21 02:53:37 +06:00 committed by Brad King
parent 3187de20fd
commit 5a208f834e
1 changed files with 2 additions and 1 deletions

View File

@ -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.