aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-09-27 16:07:37 +0200
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-09-27 16:07:37 +0200
commitbc8a16a6782d54d697a575d81dfd490022346d9d (patch)
tree1efdc09e1416a2e438d49d78ee3a83f5a31e58cd
parentb01961c0e72ab287520fcd61b47ef8faf141cf3f (diff)
Add missing comments on error enumerator
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
-rw-r--r--include/sqfs/error.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/sqfs/error.h b/include/sqfs/error.h
index 7277a3d..93ea792 100644
--- a/include/sqfs/error.h
+++ b/include/sqfs/error.h
@@ -104,12 +104,29 @@ typedef enum {
*/
SQFS_ERROR_SUPER_BLOCK_SIZE = -11,
+ /**
+ * @brief Expected a directory (inode), found something else instead.
+ *
+ * Generated when trying to resolve a path but a part of the the path
+ * turned out to not be a directory. Also generated when trying to
+ * read directory entries from something that isn't a directory.
+ */
SQFS_ERROR_NOT_DIR = -12,
+ /**
+ * @brief A specified path, or a part of it, does not exist.
+ */
SQFS_ERROR_NO_ENTRY = -13,
+ /**
+ * @brief Detected a hard link loop while walking a filesystem tree.
+ */
SQFS_ERROR_LINK_LOOP = -14,
+ /**
+ * @brief Tried to perform an file operation on something that isn't
+ * a regular file or a regular file inode.
+ */
SQFS_ERROR_NOT_FILE = -15,
} E_SQFS_ERROR;