summary refs log tree commit diff
diff options
context:
space:
mode:
authorMathieu Othacehe <othacehe@gnu.org>2020-11-23 14:10:34 +0100
committerMathieu Othacehe <othacehe@gnu.org>2020-11-23 14:10:34 +0100
commitd9e57db72479812cfa30ed8e30a6351959f9a2b2 (patch)
treedd5eb324da26aca204249ffae5aea15050bd0ce6
parentf14c6af5dc0d4924a44edb133cee37b42a935bc6 (diff)
downloadguix-d9e57db72479812cfa30ed8e30a6351959f9a2b2.tar.gz
store: Fix ensure-path docstring.
Suggested by Ludovic Courtès.

* guix/store.scm (ensure-path): Fix the docstring.
-rw-r--r--guix/store.scm5
1 files changed, 3 insertions, 2 deletions
diff --git a/guix/store.scm b/guix/store.scm
index 11e2dae579..4da39971b5 100644
--- a/guix/store.scm
+++ b/guix/store.scm
@@ -1399,8 +1399,9 @@ When a handler is installed with 'with-build-handler', it is called any time
                                          (status  1))))))))))))
 
 (define-operation (ensure-path (store-path path))
-  "Make PATH a temporary root for the duration of the current session.
-Return #t."
+  "Ensure that a path is valid.  If it is not valid, it may be made valid by
+running a substitute.  As a GC root is not created by the daemon, you may want
+to call ADD-TEMP-ROOT on that store path."
   boolean)
 
 (define-operation (add-temp-root (store-path path))