aboutsummaryrefslogtreecommitdiff
path: root/src/libstore/store-api.hh
diff options
context:
space:
mode:
Diffstat (limited to 'src/libstore/store-api.hh')
-rw-r--r--src/libstore/store-api.hh9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/libstore/store-api.hh b/src/libstore/store-api.hh
index de4dc3f03..186437f43 100644
--- a/src/libstore/store-api.hh
+++ b/src/libstore/store-api.hh
@@ -62,10 +62,18 @@ MakeError(SubstError, Error);
* denotes a permanent build failure
*/
MakeError(BuildError, Error);
+/**
+ * denotes that a path in the store did not exist (but it could, had it
+ * been put there, i.e. it is still legal).
+ */
MakeError(InvalidPath, Error);
MakeError(Unsupported, Error);
MakeError(SubstituteGone, Error);
MakeError(SubstituterDisabled, Error);
+/**
+ * denotes that a path could not possibly be a store path.
+ * e.g. outside of the nix store, illegal characters in the name, etc.
+*/
MakeError(BadStorePath, Error);
MakeError(InvalidStoreURI, Error);
@@ -328,6 +336,7 @@ public:
/**
* Check whether a path is valid.
+ * A path is valid when it exists in the store *now*.
*/
bool isValidPath(const StorePath & path);