diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2016-02-25 12:12:50 +0100 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2016-02-25 12:44:41 +0100 |
| commit | 06b76accebd5c98ae50dc7ec4c3f4dad764a637e (patch) | |
| tree | a5460fa0a11edef9dc0a2f42121a5f9bdc1ada6a /guix/store.scm | |
| parent | 0043558082d619d0dc51ef27acda8ebb299c2f2c (diff) | |
| download | gnu-guix-06b76accebd5c98ae50dc7ec4c3f4dad764a637e.tar gnu-guix-06b76accebd5c98ae50dc7ec4c3f4dad764a637e.tar.gz | |
store: Clarify documentation of 'valid-path?'.
* guix/store.scm (valid-path?): Improve docstring.
* doc/guix.texi (The Store): Update accordingly.
Diffstat (limited to 'guix/store.scm')
| -rw-r--r-- | guix/store.scm | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/guix/store.scm b/guix/store.scm index 8123407816..3d6cff4c21 100644 --- a/guix/store.scm +++ b/guix/store.scm @@ -582,7 +582,12 @@ encoding conversion errors." (operation (name args ...) docstring return ...))) (define-operation (valid-path? (string path)) - "Return #t when PATH is a valid store path." + "Return #t when PATH designates a valid store item and #f otherwise (an +invalid item may exist on disk but still be invalid, for instance because it +is the result of an aborted or failed build.) + +A '&nix-protocol-error' condition is raised if PATH is not prefixed by the +store directory (/gnu/store)." boolean) (define-operation (query-path-hash (store-path path)) |