README, INSTALL improvements.

[dss.git] / snap.h

diff --git a/snap.h b/snap.h
index 1e9fc2b87423ae520ef6f3b6a2b2d7e3d0b52e89..52f060b8a8dd790194925ac481e44af32a808973 100644 (file)
--- a/snap.h
+++ b/snap.h
@@ -1,3 +1,10 @@
+/*
+ * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** The state of snapshot creation. */
 enum {
        /** We are ready to take the next snapshot. */
        SCS_READY,
@@ -9,15 +16,20 @@ enum {
        SCS_RSYNC_RUNNING,
        /** The rsync process exited successfully. */
        SCS_RSYNC_SUCCESS,
-       /** The post-create hook has been started- */
+       /** The post-create hook has been started. */
        SCS_POST_HOOK_RUNNING,
 };
 
-/*
- * complete, not being deleted: 1204565370-1204565371.Sun_Mar_02_2008_14_33-Sun_Mar_02_2008_14_43
- * complete, being deleted: 1204565370-1204565371.being_deleted
- * incomplete, not being deleted: 1204565370-incomplete
- * incomplete, being deleted: 1204565370-incomplete.being_deleted
+/**
+ * The status of a snapshot.
+ *
+ * The snapshot directories come in four different flavours, depending
+ * on how the two staus flags are set. Examples:
+ *
+ * Complete, not being deleted: 1204565370-1204565371.Sun_Mar_02_2008_14_33-Sun_Mar_02_2008_14_43.
+ * Complete, being deleted: 1204565370-1204565371.being_deleted.
+ * Incomplete, not being deleted: 1204565370-incomplete.
+ * incomplete, being deleted: 1204565370-incomplete.being_deleted.
  */
 enum snapshot_status_flags {
        /** The rsync process terminated successfully. */
@@ -26,11 +38,20 @@ enum snapshot_status_flags {
        SS_BEING_DELETED = 2,
 };
 
+/** Desribes one snapshot */
 struct snapshot {
+       /** The name of the directory, relative to the destination dir. */
        char *name;
+       /** Seconds after the epoch when this snapshot was created. */
        int64_t creation_time;
+       /**
+        * Seconds after the epoch when creation of this snapshot completed.
+        * Only meaningful if the SS_COMPLTE bit is set.
+        */
        int64_t completion_time;
+       /** See \ref snapshot_status_flags. */
        enum snapshot_status_flags flags;
+       /** The interval this snapshot belongs to. */
        unsigned interval;
 };
 
@@ -48,9 +69,11 @@ struct snapshot_list {
        unsigned *interval_count;
 };
 
+/** Iterate over all snapshots in a snapshot list. */
 #define FOR_EACH_SNAPSHOT(s, i, sl) \
        for ((i) = 0; (i) < (sl)->num_snapshots && ((s) = (sl)->snapshots[(i)]); (i)++)
 
+/** Iterate backwards over all snapshots in a snapshot list. */
 #define FOR_EACH_SNAPSHOT_REVERSE(s, i, sl) \
        for ((i) = (sl)->num_snapshots; (i) > 0 && ((s) = (sl)->snapshots[(i - 1)]); (i)--)
 
@@ -64,7 +87,10 @@ __malloc char *being_deleted_name(struct snapshot *s);
 int complete_name(int64_t start, int64_t end, char **result);
 __malloc char *name_of_newest_complete_snapshot(struct snapshot_list *sl);
 
-static inline struct snapshot *get_oldest_snapshot(struct snapshot_list *sl)
+/**
+ * Get the oldest snapshot in a snapshot list.
+ */
+_static_inline_ struct snapshot *get_oldest_snapshot(struct snapshot_list *sl)
 {
        if (!sl->num_snapshots)
                return NULL;