[bug#68670,core-updates] doc: Document changes to `copy-recursively'.
Commit Message
* doc/guix.texi: Document new key `select?' in `copy-recursively'.
Change-Id: I4b14ae5a1b40e0939456604f75597b5596b76f83
---
doc/guix.texi | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
---
As requested by Ludo', here is the documentation update that should have
been sent together with issue #68406.
base-commit: bafc6efe481d0f209b490c4e2a1ac1b3f7afa06c
Comments
Hello!
Romain GARBAGE <romain.garbage@inria.fr> writes:
> * doc/guix.texi: Document new key `select?' in `copy-recursively'.
>
> Change-Id: I4b14ae5a1b40e0939456604f75597b5596b76f83
> ---
> doc/guix.texi | 14 ++++++++++----
> 1 file changed, 10 insertions(+), 4 deletions(-)
> ---
> As requested by Ludo', here is the documentation update that should have
> been sent together with issue #68406.
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index df6ce91736..4dbc311468 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -10814,12 +10814,18 @@ Build Utilities
> @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]
Queued for my next core-updates push.
@@ -10814,12 +10814,18 @@ Build Utilities
@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]