ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-11-07 15:36:20 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

packages: Recommend against the use of 'package-file'.

Browse source 
* guix/packages.scm (package-file): Recommend against its use in the
docstring.
* doc/guix.texi (The Store Monad): Likewise.
This commit is contained in:
Ludovic Courtès 2020-04-20 23:37:05 +02:00
parent 71977a6c59
commit c8d8f6160e
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/guix.texi
View file

@ -7483,6 +7483,10 @@ value in the absolute file name of @var{file} within the @var{output}
directory of @var{package}. When @var{file} is omitted, return the name
of the @var{output} directory of @var{package}. When @var{target} is
true, use it as a cross-compilation target triplet.
Note that this procedure does @emph{not} build @var{package}. Thus, the
result might or might not designate an existing file. We recommend not
using this procedure unless you know what you are doing.
@end deffn
@deffn {Monadic Procedure} package->derivation @var{package} [@var{system}]

6
guix/packages.scm
View file

@ -1340,7 +1340,11 @@ (define* (package-file package
"Return as a monadic value the absolute file name of FILE within the
OUTPUT directory of PACKAGE. When FILE is omitted, return the name of the
OUTPUT directory of PACKAGE. When TARGET is true, use it as a
cross-compilation target triplet."
cross-compilation target triplet.
Note that this procedure does _not_ build PACKAGE. Thus, the result might or
might not designate an existing file. We recommend not using this procedure
unless you know what you are doing."
(lambda (store)
(define compute-derivation
(if target