Rename hook_status enum.
[dss.git] / snap.h
diff --git a/snap.h b/snap.h
index 063a38e2497f86eba22416679fc4b37137f2d94e..508bbf9312d9f2a343ac2af265799677a372c6a0 100644 (file)
--- a/snap.h
+++ b/snap.h
@@ -4,22 +4,22 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** The state of snapshot creation. */
-enum {
+/** The possible states for snapshot creation/removal. */
+enum hook_status {
        /** We are ready to take the next snapshot. */
-       SCS_READY,
-       /** The pre-creation hook has been started. */
-       SCS_PRE_HOOK_RUNNING,
-       /** The pre-creation hook exited successfully. */
-       SCS_PRE_HOOK_SUCCESS,
-       /** The rsync process is running. */
-       SCS_RSYNC_RUNNING,
-       /** The rsync process exited successfully. */
-       SCS_RSYNC_SUCCESS,
-       /** The rsync process needs to be restarted. */
-       SCS_RSYNC_NEEDS_RESTART,
-       /** The post-create hook has been started. */
-       SCS_POST_HOOK_RUNNING,
+       HS_READY,
+       /** The pre-create/pre-remove hook has been started. */
+       HS_PRE_RUNNING,
+       /** The pre-create/pre-remove hook exited successfully. */
+       HS_PRE_SUCCESS,
+       /** The rsync/rm process is running. */
+       HS_RUNNING,
+       /** The rsync/rm process exited successfully. */
+       HS_SUCCESS,
+       /** The rsync/rm process needs to be restarted. */
+       HS_NEEDS_RESTART,
+       /** The post-create/post-remove hook has been started. */
+       HS_POST_RUNNING,
 };
 
 /**
@@ -40,7 +40,7 @@ enum snapshot_status_flags {
        SS_BEING_DELETED = 2,
 };
 
-/** Desribes one snapshot */
+/** Describes one snapshot. */
 struct snapshot {
        /** The name of the directory, relative to the destination dir. */
        char *name;