unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Romain GARBAGE <romain.garbage@inria.fr>
To: 68670@debbugs.gnu.org
Cc: ludo@gnu.org, Romain GARBAGE <romain.garbage@inria.fr>,
	maxim.cournoyer@gmail.com
Subject: [bug#68670] [PATCH core-updates] doc: Document changes to `copy-recursively'.
Date: Tue, 23 Jan 2024 09:42:41 +0100	[thread overview]
Message-ID: <caca9e53cf91f8b5aaa97b06a5b35060cdea3eb3.1705999361.git.romain.garbage@inria.fr> (raw)

* 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]

base-commit: bafc6efe481d0f209b490c4e2a1ac1b3f7afa06c
-- 
2.41.0





             reply	other threads:[~2024-01-23  8:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-23  8:42 Romain GARBAGE [this message]
2024-01-23 14:09 ` bug#68670: [PATCH core-updates] doc: Document changes to `copy-recursively' Maxim Cournoyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=caca9e53cf91f8b5aaa97b06a5b35060cdea3eb3.1705999361.git.romain.garbage@inria.fr \
    --to=romain.garbage@inria.fr \
    --cc=68670@debbugs.gnu.org \
    --cc=ludo@gnu.org \
    --cc=maxim.cournoyer@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).