packages: Recommend against the use of 'package-file'.
* guix/packages.scm (package-file): Recommend against its use in the docstring. * doc/guix.texi (The Store Monad): Likewise.
This commit is contained in:
parent
71977a6c59
commit
c8d8f6160e
2 changed files with 9 additions and 1 deletions
|
@ -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
|
directory of @var{package}. When @var{file} is omitted, return the name
|
||||||
of the @var{output} directory of @var{package}. When @var{target} is
|
of the @var{output} directory of @var{package}. When @var{target} is
|
||||||
true, use it as a cross-compilation target triplet.
|
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
|
@end deffn
|
||||||
|
|
||||||
@deffn {Monadic Procedure} package->derivation @var{package} [@var{system}]
|
@deffn {Monadic Procedure} package->derivation @var{package} [@var{system}]
|
||||||
|
|
|
@ -1340,7 +1340,11 @@ code of derivations to GUILE, a package object."
|
||||||
"Return as a monadic value the absolute file name of FILE within the
|
"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 FILE is omitted, return the name of the
|
||||||
OUTPUT directory of PACKAGE. When TARGET is true, use it as a
|
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)
|
(lambda (store)
|
||||||
(define compute-derivation
|
(define compute-derivation
|
||||||
(if target
|
(if target
|
||||||
|
|
Reference in a new issue