aboutsummaryrefslogtreecommitdiff
path: root/doc/guix.texi
diff options
context:
space:
mode:
authorRomain GARBAGE <romain.garbage@inria.fr>2024-01-23 09:42:41 +0100
committerLudovic Courtès <ludo@gnu.org>2024-08-31 10:44:42 +0200
commitf5d75acd0dd047887ac7e80af17e9d03f3ff571b (patch)
tree6e17e09bfe173d4a3bb293c23ce85229ca7b32a9 /doc/guix.texi
parent3f32305680982eae419931f5ee48925d7c74d1ed (diff)
downloadguix-f5d75acd0dd047887ac7e80af17e9d03f3ff571b.tar
guix-f5d75acd0dd047887ac7e80af17e9d03f3ff571b.tar.gz
doc: Document changes to `copy-recursively'.
* doc/guix.texi: Document new key `select?' in `copy-recursively'. Change-Id: I4b14ae5a1b40e0939456604f75597b5596b76f83 Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 04556630b3..bd85b33fdb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10628,12 +10628,18 @@ Make @var{file} writable for its owner.
@deffn {Procedure} copy-recursively source destination @
[#:log (current-output-port)] [#:follow-symlinks? #f] @
[#:copy-file copy-file] [#:keep-mtime? #f] [#:keep-permissions? #t]
+ [#:select? (const #t)]
Copy @var{source} directory to @var{destination}. Follow symlinks if
@var{follow-symlinks?} is true; otherwise, just preserve them. Call
-@var{copy-file} to copy regular files. When @var{keep-mtime?} is true,
-keep the modification time of the files in @var{source} on those of
-@var{destination}. When @var{keep-permissions?} is true, preserve file
-permissions. Write verbose output to the @var{log} port.
+@var{copy-file} to copy regular files. Call @var{select?}, taking two
+arguments, @var{file} and @var{stat}, for each entry in @var{source},
+where @var{file} is the entry's absolute file name and @var{stat} is the
+result of @code{lstat} (or @code{stat} if @var{follow-symlinks?} is
+true); exclude entries for which @var{select?} does not return true.
+When @var{keep-mtime?} is true, keep the modification time of the files
+in @var{source} on those of @var{destination}.
+When @var{keep-permissions?} is true, preserve file permissions. Write
+verbose output to the @var{log} port.
@end deffn
@deffn {Procedure} delete-file-recursively dir [#:follow-mounts? #f]