amaharaneko/guix-mirrors
1
1
Fork 0
mirror of https://codeberg.org/guix/guix.git synced 2025-10-02 02:15:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Update arguments for gexp procedures.

Browse source 
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 <janneke@gnu.org>
This commit is contained in:
Tomas Volf 2025-01-23 23:57:08 +01:00 • committed by Andreas Enge
parent 423be27d96
commit e72c26d7f0
No known key found for this signature in database
GPG key ID: F7D5C9BF765C61E3
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/guix.texi
View file

@ -12572,7 +12572,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
@ -12583,7 +12584,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}.
@ -12620,8 +12621,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.