summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-04-20 23:37:05 +0200
committerLudovic Courtès <ludo@gnu.org>2020-04-21 00:06:40 +0200
commitc8d8f6160e7b4d3df7b006b35ba0f4e74b9b90fb (patch)
tree110684b2abc323d5cd14071128d861c44eb08a53 /doc
parent71977a6c59460e029c91741c8b11f3a544a70486 (diff)
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index d2cd11576f..a79bbfc4f7 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -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}]