branch master updated: store: Fix ensure-path docstring.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

mothacehe pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new d9e57db  store: Fix ensure-path docstring.
d9e57db is described below

commit d9e57db72479812cfa30ed8e30a6351959f9a2b2
Author: Mathieu Othacehe <othacehe@gnu.org>
AuthorDate: Mon Nov 23 14:10:34 2020 +0100

    store: Fix ensure-path docstring.
    
    Suggested by Ludovic Courtès.
    
    * guix/store.scm (ensure-path): Fix the docstring.
---
 guix/store.scm | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/guix/store.scm b/guix/store.scm
index 11e2dae..4da3997 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))