diff options
| author | Romain GARBAGE <romain.garbage@inria.fr> | 2024-01-23 09:42:41 +0100 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2024-06-17 22:55:43 +0200 |
| commit | a51f826d3f90bb350e00f128046f75a405c74e70 (patch) | |
| tree | 023063403515e6378b73fd7e8da3544cabe900cd /doc/guix.texi | |
| parent | c8c974be2784d625d7dfc82694f04e7a15ea2728 (diff) | |
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.texi | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 9a0e96b4a2..6caecd3888 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -10619,12 +10619,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] |