store: Fix ensure-path docstring.

Suggested by Ludovic Courtès.

* guix/store.scm (ensure-path): Fix the docstring.
This commit is contained in:
Mathieu Othacehe 2020-11-23 14:10:34 +01:00
parent f14c6af5dc
commit d9e57db724
No known key found for this signature in database
GPG Key ID: 8354763531769CA6

View File

@ -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))