mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-15 09:47:20 +00:00
Code Issues Releases Activity

* doc/lispref/files.texi: (files-equal-p, file-subdir-of-p): Add documentation.

Browse Source
This commit is contained in:
thierry volpiatto 2012-02-25 16:31:07 +01:00
parent 5d8522565e
commit 2345325552
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/lispref/ChangeLog
View File

@ -1,3 +1,8 @@
2012-02-25 Thierry Volpiatto <thierry.volpiatto@gmail.com>
* files.texi (files-equal-p, file-subdir-of-p): New,
add initial documentation.
2012-02-25 Chong Yidong <cyd@gnu.org>
* files.texi (File Attributes): Document file-selinux-context.

17
doc/lispref/files.texi
View File

@ -1018,6 +1018,23 @@ a regular file (not a directory, named pipe, terminal, or
other I/O device).
@end defun
@defun files-equal-p file1 file2
This function return @code{t} if the files @var{file1} and @var{file2} name
the same file.
Comparison is made with the @code{file-attributes} of both files.
@end defun
@defun file-subdir-of-p dir1 dir2
This function return @code{t} if directory @var{dir1} is a subdirectory
of @var{dir2} or if @var{dir1} and @var{dir2} are the same directory.
Arguments @var{dir1} and @var{dir2} must be existing directories,
otherwise, return nil.
Check is done by building a directory name based on equality of differents
components of both directory names, if this resulting directory name
is equal to @var{dir2}, we assume directory @var{dir1}
is a subdirectory of @var{dir2}.
@end defun
@node Truenames
@subsection Truenames
@cindex truename (of file)