[Emacs-diffs] /srv/bzr/emacs/trunk r107428: * doc/lispref/files.texi: (files-equal-p, file-subdir-of-p): Add documentation.

[thierry volpiatto]

------------------------------------------------------------
revno: 107428
committer: thierry volpiatto <address@hidden
branch nick: trunk
timestamp: Sat 2012-02-25 16:31:07 +0100
message:
  * doc/lispref/files.texi: (files-equal-p, file-subdir-of-p): Add 
documentation.
modified:
  doc/lispref/ChangeLog
  doc/lispref/files.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-02-25 09:32:33 +0000
+++ b/doc/lispref/ChangeLog     2012-02-25 15:31:07 +0000
@@ -1,3 +1,8 @@
+2012-02-25  Thierry Volpiatto  <address@hidden>
+
+       * files.texi (files-equal-p, file-subdir-of-p): New,
+       add initial documentation.
+
 2012-02-25  Chong Yidong  <address@hidden>
 
        * files.texi (File Attributes): Document file-selinux-context.

=== modified file 'doc/lispref/files.texi'
--- a/doc/lispref/files.texi    2012-02-25 09:07:23 +0000
+++ b/doc/lispref/files.texi    2012-02-25 15:31:07 +0000
@@ -1018,6 +1018,23 @@
 other I/O device).
 @end defun
 
address@hidden 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. 
address@hidden defun
+
address@hidden 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}.
address@hidden defun
+
 @node Truenames
 @subsection Truenames
 @cindex truename (of file)