janneke pushed a commit to branch core-packages-team
in repository guix.
commit 86346d22371efa63939c319be2e4e14f7d5a312d
Author: Tomas Volf <[email protected]>
AuthorDate: Thu Jan 23 23:57:08 2025 +0100
doc: Update arguments for gexp procedures.
Some keyword arguments were missing, some had wrong default values. This
commit updates the documentation to match the code.
* doc/guix.texi (G-Expressions)[computed-file]: Use @var. Document #:guile.
[gexp->script]: Fix default value for #:target.
[gexp->file]: Document #:system and #:target.
Change-Id: Ie92a57fe1c3b45d1c7a5e8865fcf291c5f590c11
Signed-off-by: Janneke Nieuwenhuizen <[email protected]>
---
doc/guix.texi | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index 3b98f1b4ea..f8d12942f7 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -12477,7 +12477,8 @@ Return an object representing a text file called
@var{name} with the given
This is the declarative counterpart of @code{text-file}.
@end deffn
-@deffn {Procedure} computed-file name gexp [#:local-build? #t] [#:options '()]
+@deffn {Procedure} computed-file @var{name} @var{gexp} @
+ [#:guile] [#:local-build? #t] [#:options '()]
Return an object representing the store item @var{name}, a file or
directory computed by @var{gexp}. When @var{local-build?} is true (the
default), the derivation is built locally. @var{options} is a list of
@@ -12488,7 +12489,7 @@ This is the declarative counterpart of
@code{gexp->derivation}.
@deffn {Monadic Procedure} gexp->script @var{name} @var{exp} @
[#:guile (default-guile)] [#:module-path %load-path] @
- [#:system (%current-system)] [#:target #f]
+ [#:system (%current-system)] [#:target 'current]
Return an executable script @var{name} that runs @var{exp} using
@var{guile}, with @var{exp}'s imported modules in its search path.
Look up @var{exp}'s modules in @var{module-path}.
@@ -12525,8 +12526,8 @@ This is the declarative counterpart of
@code{gexp->script}.
@deffn {Monadic Procedure} gexp->file @var{name} @var{exp} @
[#:set-load-path? #t] [#:module-path %load-path] @
- [#:splice? #f] @
- [#:guile (default-guile)]
+ [#:splice? #f] [#:guile (default-guile)] @
+ [#:system (%current-system)] [#:target 'current]
Return a derivation that builds a file @var{name} containing @var{exp}.
When @var{splice?} is true, @var{exp} is considered to be a list of
expressions that will be spliced in the resulting file.
