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 /doc/guix.texi | |
parent | 0043558082d619d0dc51ef27acda8ebb299c2f2c (diff) | |
download | guix-patches-06b76accebd5c98ae50dc7ec4c3f4dad764a637e.tar guix-patches-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 'doc/guix.texi')
-rw-r--r-- | doc/guix.texi | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index b48f988a0d..2bebeeddf7 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -2913,7 +2913,14 @@ Procedures that make RPCs all take a server object as their first argument. @deffn {Scheme Procedure} valid-path? @var{server} @var{path} -Return @code{#t} when @var{path} is a valid store path. +@cindex invalid store items +Return @code{#t} when @var{path} designates a valid store item and +@code{#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 @code{&nix-protocol-error} condition is raised if @var{path} is not +prefixed by the store directory (@file{/gnu/store}). @end deffn @deffn {Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}] |