diff options
| author | Richard Sent <richard@freakingpenguin.com> | 2024-05-08 08:17:51 -0400 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2024-05-25 16:19:22 +0200 |
| commit | 0efa1daad354216e9ce2adb078eb4d5254792e49 (patch) | |
| tree | 807371af55f11ecf29178b7f0d9fa8efcc8c8eec /doc | |
| parent | be868f69aae8fc0a33edf5d98974e99208268aad (diff) | |
doc: Document ‘assume-valid-file-name’ in ‘local-file’.
* doc/guix.texi (G-Expressions): Document the use of assume-valid-file-name with
local-file.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Change-Id: I132f78e198cbf3ba2e5a677d671563d753de534c
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index b8812cc60a..d0ce8927b4 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -12192,6 +12192,18 @@ When @var{recursive?} is true, call @code{(@var{select?} @var{file} absolute file name and @var{stat} is the result of @code{lstat}; exclude entries for which @var{select?} does not return true. +@var{file} can be wrapped in the @code{assume-valid-file-name} syntactic +keyword. When this is done, there will not be a warning when +@code{local-file} is used with a non-literal path. The path is still +looked up relative to the current working directory at run time. +Wrapping is done like this: + +@lisp +(define alice-key-file-path "alice.pub") +;; ... +(local-file (assume-valid-file-name alice-key-file-path)) +@end lisp + This is the declarative counterpart of the @code{interned-file} monadic procedure (@pxref{The Store Monad, @code{interned-file}}). @end deffn |