Revamp com_prune().

[dss.git] / dss.suite

diff --git a/dss.suite b/dss.suite
index 03e147414d475cc10f1176f434acd98d1dea3e57..2719827700a33809b8bf2714f58518b550c4a104 100644 (file)
--- a/dss.suite
+++ b/dss.suite
@@ -62,13 +62,15 @@ caption = Subcommands
                typestr = dirname
                arg_info = required_arg
                arg_type = string
                typestr = dirname
                arg_info = required_arg
                arg_type = string

+               flag multiple

                [help]
                        The directory on the remote host from which snapshots are taken.
                        Of course, the user specified as --remote-user must have read access
                        to this directory.
 
                [help]
                        The directory on the remote host from which snapshots are taken.
                        Of course, the user specified as --remote-user must have read access
                        to this directory.
 

-                       This option is mandatory for the create and run subcommands: It must
-                       be given at the command line or in the config file.
+                       This option is mandatory for the create and run subcommands: It may
+                       be given multiple times to specify more than one source directory.
+                       However, all source directories must reside on the same server.

                [/help]
        [option dest-dir]
                summary = where snapshots are stored
                [/help]
        [option dest-dir]
                summary = where snapshots are stored


@@ -80,6 +82,7 @@ caption = Subcommands
                        written. This must be writable by the user who runs dss.
 
                        This option is mandatory for all subcommands except kill.
                        written. This must be writable by the user who runs dss.
 
                        This option is mandatory for all subcommands except kill.

+                       Unlike --source-dir, this option may only be given once.

                [/help]
        [option mountpoint]
                summary = abort if destination directory is not a mountpoint
                [/help]
        [option mountpoint]
                summary = abort if destination directory is not a mountpoint


@@ -447,18 +450,21 @@ caption = Subcommands
                snapshots.
        [/description]
 [subcommand prune]
                snapshots.
        [/description]
 [subcommand prune]

-       purpose = remove redundant and outdated snapshots
+       purpose = remove snapshots

        [description]
        [description]

-               A snapshot is considered outdated if its interval number is greater or
-               equal than the specified number of unit intervals. See --unit-interval
-               and --num-intervals above.
-
-               A snapshot is said to be redundant if the interval it belongs to
-               contains more than the configured number of snapshots.
-
-               The prune command gets rid of both outdated and redundant snapshots. At
-               most one snapshot is removed per invocation. If --dry-run is given, the
-               subcommand only prints the snapshot that would be removed.
+               A snapshot is said to be (a) outdated if its interval number is greater
+               or equal than the specified number of unit intervals, (b) redundant if
+               the interval it belongs to contains more than the configured number of
+               snapshots, and (c) orphaned if it is incomplete and not being created
+               or deleted. All other snapshots are called regular.
+
+               Unless --dry-run is given, which just prints the snapshot that would be
+               removed, this subcommand gets rid of non-regular snapshots.  At most
+               one snapshot is removed per invocation. If no such snapshot exists
+               and disk space is low, the subcommand also removes regular snapshots,
+               always picking the oldest one.
+
+               The subcommand fails if there is another dss "run" process.

        [/description]
 [subcommand ls]
        purpose = print the list of all snapshots
        [/description]
 [subcommand ls]
        purpose = print the list of all snapshots