diff options
author | Eli Zaretskii <eliz@gnu.org> | 2018-06-01 11:27:29 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2018-06-01 11:27:29 +0300 |
commit | 99f92dab3d64c4ef0a38fa2f0ea5fd48b8bb2e1a (patch) | |
tree | f3e5a8390a993ccf7fb4370fa4b1e65acee7bb65 /src/dired.c | |
parent | df8649ac40be54cc3007241c4c1d5b1cb81c54dd (diff) | |
download | emacs-99f92dab3d64c4ef0a38fa2f0ea5fd48b8bb2e1a.tar.gz |
Improve documentation of 'directory-files-and-attributes'
* doc/lispref/files.texi (Contents of Directories): Fix inaccurate
description of the return value of directory-files-and-attributes.
* src/dired.c (Fdirectory_files_and_attributes): Describe the
function's value in more detail.
Diffstat (limited to 'src/dired.c')
-rw-r--r-- | src/dired.c | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/dired.c b/src/dired.c index c446223a0bc..a753b1930e6 100644 --- a/src/dired.c +++ b/src/dired.c @@ -358,7 +358,14 @@ If NOSORT is non-nil, the list is not sorted--its order is unpredictable. DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes, Sdirectory_files_and_attributes, 1, 5, 0, doc: /* Return a list of names of files and their attributes in DIRECTORY. -There are four optional arguments: +Value is a list of the form: + + ((FILE1 FILE1-ATTRS) (FILE2 FILE2-ATTRS) ...) + +where each FILEn-ATTRS is the attributes of FILEn as returned +by `file-attributes'. + +This function accepts four optional arguments: If FULL is non-nil, return absolute file names. Otherwise return names that are relative to the specified directory. If MATCH is non-nil, mention only file names that match the regexp MATCH. |