hammer: minor doc update
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 14 Nov 2009 14:43:51 +0000 (15:43 +0100)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 14 Nov 2009 16:14:20 +0000 (17:14 +0100)
 * SYNOPSIS for -f changed to just '-f blkdevs'

 * sync SYNOPSIS & usage()

 * s/filesystem/file system/ (was already used in most places)

 * add description for show-undo

 * fix a few minor typos

sbin/hammer/cmd_cleanup.c
sbin/hammer/cmd_rebalance.c
sbin/hammer/cmd_reblock.c
sbin/hammer/cmd_version.c
sbin/hammer/hammer.8
sbin/hammer/hammer.c

index 0e0162d..5030320 100644 (file)
@@ -36,7 +36,7 @@
 /*
  * Clean up specific HAMMER filesystems or all HAMMER filesystems.
  *
- * If no filesystems are specified any HAMMER or null-mounted hammer PFS's
+ * If no filesystems are specified any HAMMER- or null-mounted hammer PFS's
  * are cleaned.
  *
  * Each HAMMER filesystem may contain a configuration file.  If no
@@ -47,7 +47,7 @@
  *     prune     1d 5m
  *     rebalance 1d 5m
  *     reblock   1d 5m
- *     recopy    30d 5m
+ *     recopy    30d 10m
  *
  * All hammer commands create and maintain cycle files in the snapshots
  * directory.
@@ -530,8 +530,7 @@ config_init(const char *path, struct hammer_ioc_config *config)
                "prune     1d 5m\n"
                "rebalance 1d 5m\n"
                "reblock   1d 5m\n"
-               "recopy    30d 10m\n"
-               "rebalance 1d 5m\n");
+               "recopy    30d 10m\n");
 }
 
 /*
index 5d0f294..0c183e6 100644 (file)
@@ -112,8 +112,7 @@ void
 rebalance_usage(int exit_code)
 {
        fprintf(stderr,
-               "hammer rebalance <filesystem> "
-               "[saturation-percentage 50-100]\n"
-               "By default 75%% is used.\n");
+               "hammer rebalance <filesystem> [saturation_percentage]\n"
+               "saturation_percentage is 50%%-100%%, default is 75%%.\n");
        exit(exit_code);
 }
index 21caa6c..8c9c1f2 100644 (file)
@@ -39,7 +39,7 @@
 static void reblock_usage(int exit_code);
 
 /*
- * reblock <filesystem> [compaction_precentage] (default 100%)
+ * reblock <filesystem> [fill_percentage] (default 100%)
  */
 void
 hammer_cmd_reblock(char **av, int ac, int flags)
@@ -135,11 +135,11 @@ static
 void
 reblock_usage(int exit_code)
 {
-       fprintf(stderr, "hammer reblock <filesystem> [percentage]\n");
-       fprintf(stderr, "hammer reblock-btree <filesystem> [percentage]\n");
-       fprintf(stderr, "hammer reblock-inodes <filesystem> [percentage]\n");
-       fprintf(stderr, "hammer reblock-dirs <filesystem> [percentage]\n");
-       fprintf(stderr, "hammer reblock-data <filesystem> [percentage]\n");
+       fprintf(stderr, "hammer reblock <filesystem> [fill_percentage]\n");
+       fprintf(stderr, "hammer reblock-btree <filesystem> [fill_percentage]\n");
+       fprintf(stderr, "hammer reblock-inodes <filesystem> [fill_percentage]\n");
+       fprintf(stderr, "hammer reblock-dirs <filesystem> [fill_percentage]\n");
+       fprintf(stderr, "hammer reblock-data <filesystem> [fill_percentage]\n");
        fprintf(stderr, "By default 100%% is used.\n");
        exit(exit_code);
 }
index ff9a11e..956e0f5 100644 (file)
@@ -93,7 +93,7 @@ hammer_cmd_get_version(char **av, int ac)
 }
 
 /*
- * version-upgrade <filesystem> version [force]
+ * version-upgrade <filesystem> <version> [force]
  */
 void
 hammer_cmd_set_version(char **av, int ac)
@@ -105,13 +105,13 @@ hammer_cmd_set_version(char **av, int ac)
 
        if (ac < 2 || ac > 3 || (ac == 3 && strcmp(av[2], "force") != 0)) {
                fprintf(stderr,
-                       "hammer upgrade: expected <fs> vers# [force]\n");
+                       "hammer version-upgrade: expected <fs> vers# [force]\n");
                exit(1);
        }
 
         fd = open(av[0], O_RDONLY);
        if (fd < 0) {
-               fprintf(stderr, "hammer upgrade: unable to access %s: %s\n",
+               fprintf(stderr, "hammer version-upgrade: unable to access %s: %s\n",
                        av[0], strerror(errno));
                exit(1);
        }
@@ -148,10 +148,10 @@ hammer_cmd_set_version(char **av, int ac)
        }
        printf("hammer version-upgrade: succeeded\n");
        if (overs < 3 && nvers >= 3) {
-               printf("NOTE!  Please run hammer cleanup to convert the\n"
-                      "<fs>/snapshots directory to the new meta-data\n"
+               printf("NOTE!  Please run 'hammer cleanup' to convert the\n"
+                      "<pfs>/snapshots directories to the new meta-data\n"
                       "format.  Once converted configuration data will\n"
-                      "no longer resides in <fs>/snapshots and you can\n"
+                      "no longer resides in <pfs>/snapshots and you can\n"
                       "even rm -rf it entirely if you want.\n");
        }
 
index d2069d1..3e436ab 100644 (file)
@@ -32,7 +32,7 @@
 .\"
 .\" $DragonFly: src/sbin/hammer/hammer.8,v 1.58 2008/11/13 02:04:27 dillon Exp $
 .\"
-.Dd November 5, 2009
+.Dd November 14, 2009
 .Dt HAMMER 8
 .Os
 .Sh NAME
@@ -46,7 +46,7 @@
 .Op Fl b Ar bandwidth
 .Op Fl C Ar cachesize Ns Op Ns Cm \&: Ns Ar readahead
 .Op Fl c Ar cyclefile
-.Op Fl f Ar blkdev Ns Oo Ns Cm \&: Ns Ar blkdev Oc Ns *
+.Op Fl f Ar blkdevs
 .\" .Op Fl s Ar linkpath
 .Op Fl i Ar delay
 .Op Fl t Ar seconds
@@ -123,10 +123,14 @@ If
 .Nm
 runs to completion it will delete
 .Ar cyclefile .
-.It Fl f Ar blkdev Ns Oo Ns Cm \&: Ns Ar blkdev Oc Ns *
+.It Fl f Ar blkdevs
 Specify the volumes making up a
 .Nm HAMMER
 file system.
+.Ar Blkdevs
+is a colon-separated list of devices, each specifying a
+.Nm HAMMER
+volume.
 .It Fl i Ar delay
 When maintaining a streaming mirroring this option specifies the
 minimum delay after a batch ends before the next batch is allowed
@@ -247,7 +251,9 @@ Any errors will show up with a
 in column 1 along with various
 other error flags.
 .Pp
-If you specify a localization and object id field the dump will
+If you specify a localization and object id field,
+.Ar lo Ns Cm \&: Ns Ar objid ,
+the dump will
 search for the key printing nodes as it recurses down, and then
 will iterate forwards.
 .Pp
@@ -269,6 +275,15 @@ B-tree CRCs and linkages are still checked.
 This command needs the
 .Fl f
 flag.
+.\" ==== show-undo ====
+.It Cm show-undo
+.Nm ( HAMMER
+VERSION 4+)
+Dump the UNDO map.
+.Pp
+This command needs the
+.Fl f
+flag.
 .\" .It Ar blockmap
 .\" Dump the B-tree, record, large-data, and small-data blockmaps, showing
 .\" physical block assignments and free space percentages.
@@ -328,7 +343,9 @@ The configuration file is
 in the snapshots directory which defaults to
 .Pa <pfs>/snapshots .
 .It Nm HAMMER No version 3+
-The configuration file is saved in filesystem meta-data.
+The configuration file is saved in file system meta-data, see
+.Nm
+.Cm config .
 The snapshots directory defaults to
 .Pa /var/hammer/<pfs>
 .Pa ( /var/hammer/root
@@ -442,20 +459,20 @@ VERSION 3+)
 If zero or one arguments are specified this function dumps the current
 configuration file to stdout.
 Zero arguments specifies the PFS containing the current directory.
-This configuration file is stored in filesystem meta-data.
+This configuration file is stored in file system meta-data.
 If two arguments are specified this function installs a new config file.
 .Pp
 In
 .Nm HAMMER
 versions less than 3 the configuration file is by default stored in
 .Pa <pfs>/snapshots/config ,
-but in all later versions the configuration file is stored in filesystem
+but in all later versions the configuration file is stored in file system
 meta-data.
 .\" ==== viconfig ====
 .It Cm viconfig Op Ar filesystem
 .Nm ( HAMMER
 VERSION 3+)
-Edit the configuration file and reinstall into filesystem meta-data when done.
+Edit the configuration file and reinstall into file system meta-data when done.
 Zero arguments specifies the PFS containing the current directory.
 .\" ==== expand ====
 .It Cm expand Ar filesystem Ar device
@@ -472,14 +489,17 @@ If
 .Ar device
 contains a valid
 .Nm HAMMER
-filesystem, formatting will be denied.
+file system, formatting will be denied.
 You can overcome this sanity check
 by using
 .Xr dd 1
 to erase the beginning sectors of the device.
 Also remember that you have to specify
 .Ar device ,
-together with any other device that make the filesystem, colon-separated to
+together with any other device that make up the file system,
+colon-separated to
+.Pa /etc/fstab
+and
 .Xr mount_hammer 8 .
 .\" ==== snapshot ====
 .It Cm snapshot Oo Ar filesystem Oc Ar snapshot-dir
@@ -538,7 +558,7 @@ Would create symlinks similar to:
 .Pp
 When run on a
 .Nm HAMMER
-version 3+ filesystem the snapshot is also recorded in meta-data
+version 3+ file system the snapshot is also recorded in file system meta-data
 along with the optional
 .Ar note .
 See the
@@ -575,13 +595,13 @@ An absolute or relative path may be specified.
 The path will be used as-is as a prefix in the path output to stdout.
 As with the other
 snap and snapshot directives the snapshot transaction id will be registered
-in the filesystem meta-data.
+in the file system meta-data.
 .It Cm snaprm Bro Ar path | transid Brc Ar ...
 .Nm ( HAMMER
 VERSION 3+)
 Remove a snapshot given its softlink or transaction id.
 If specifying a transaction id
-the snapshot is removed from filesystem meta-data but you are responsible
+the snapshot is removed from file system meta-data but you are responsible
 for removing any related softlinks.
 .It Cm snapls Op Ar path ...
 .Nm ( HAMMER
@@ -591,7 +611,7 @@ Dump the snapshot meta-data for PFSs containing each
 listing all available snapshots and their notes.
 If no arguments are specified snapshots for the PFS containing the
 current directory are listed.
-This is the definitive list of snapshots for the filesystem.
+This is the definitive list of snapshots for the file system.
 .\" ==== prune ====
 .It Cm prune Ar softlink-dir
 Prune the file system based on previously created snapshot softlinks.
@@ -673,24 +693,26 @@ history for modifications pertaining to that snapshot would be destroyed.
 .Pp
 In
 .Nm HAMMER
-filesystem versions 3+ this command also scans the snapshots stored
-in the filesystem meta-data and includes them in the prune.
+file system versions 3+ this command also scans the snapshots stored
+in the file system meta-data and includes them in the prune.
 .\" ==== prune-everything ====
 .It Cm prune-everything Ar filesystem
 This command will remove all historical records from the file system.
 This directive is not normally used on a production system.
 .Pp
 This command does not remove snapshot softlinks but will delete all
-snapshots recorded in filesystem meta-data (for filesystem version 3+).
+snapshots recorded in file system meta-data (for file system version 3+).
 The user is responsible for deleting any softlinks.
 .\" ==== rebalance ====
-.It Cm rebalance Ar filesystem Op Ar saturation_level
+.It Cm rebalance Ar filesystem Op Ar saturation_percentage
 This command will rebalance the B-tree, nodes with small number of
 elements will be combined and element counts will be smoothed out
 between nodes.
 .Pp
-The saturation level is a percentage between 50 and 100.
-The default is 75 percent.
+The saturation percentage is between 50% and 100%.
+The default is 75% (the
+.Sq %
+suffix is not needed).
 .\" ==== reblock* ====
 .It Cm reblock Ar filesystem Op Ar fill_percentage
 .It Cm reblock-btree Ar filesystem Op Ar fill_percentage
@@ -961,8 +983,8 @@ to dump an ASCII representation of the mirroring stream.
 .\" ==== mirror-copy ====
 .\".It Cm mirror-copy Ar [[user@]host:]filesystem [[user@]host:]filesystem
 .It Cm mirror-copy \
-Oo Oo Ar user Oc Ns Cm @ Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
-Oo Oo Ar user Oc Ns Cm @ Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
+Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
+Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
 This is a shortcut which pipes a
 .Cm mirror-read
 command to a
@@ -991,8 +1013,8 @@ you want to create a compatible PFS slave for the target or not.
 .\" ==== mirror-stream ====
 .\".It Cm mirror-stream Ar [[user@]host:]filesystem [[user@]host:]filesystem
 .It Cm mirror-stream \
-Oo Oo Ar user Oc Ns Cm @ Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
-Oo Oo Ar user Oc Ns Cm @ Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
+Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
+Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
 This command works similarly to
 .Cm mirror-copy
 but does not exit after the initial mirroring completes.
@@ -1043,7 +1065,7 @@ work-in-progress version number you must specify the
 .Cm force
 directive.
 Use of WIP versions should be relegated to testing and may require wiping
-the filesystem as development progresses, even though the WIP version might
+the file system as development progresses, even though the WIP version might
 not change.
 .Pp
 .Em NOTE!
@@ -1058,12 +1080,13 @@ default version, first
 .Nm HAMMER
 release.
 .It 2
-.Dx 2.3
-default version, new directory entry layout.
+.Dx 2.3 .
+New directory entry layout.
 This version is using a new directory hash key.
 .It 3
-.Dx 2.5 .
-New snapshot management, using filesystem meta-data for saving
+.Dx 2.5
+default version.
+New snapshot management, using file system meta-data for saving
 configuration file and snapshots (transaction ids etc.).
 Also default snapshots directory has changed.
 .It 4
@@ -1107,7 +1130,7 @@ directive requires that the target be configured as a slave and that the
 field of the mirroring source and target match.
 .Sh UPGRADE INSTRUCTIONS HAMMER V1 TO V2
 This upgrade changes the way directory entries are stored.
-It is possible to upgrade a V1 filesystem to V2 in place, but
+It is possible to upgrade a V1 file system to V2 in place, but
 directories created prior to the upgrade will continue to use
 the old layout.
 .Pp
@@ -1122,7 +1145,7 @@ slave created prior to the upgrade.
 Any directories created after upgrading will use a new layout.
 .Sh UPGRADE INSTRUCTIONS HAMMER V2 TO V3
 This upgrade adds meta-data elements to the B-Tree.
-It is possible to upgrade a V2 filesystem to V3 in place.
+It is possible to upgrade a V2 file system to V3 in place.
 After issuing the upgrade be sure to run a
 .Nm
 .Cm cleanup
@@ -1152,7 +1175,7 @@ snapshot directory configuration in the slave PFS.
 The new snapshots hierarchy is designed to work with
 both master and slave PFSs equally well.
 .Pp
-In addition, the old config file will be moved to meta-data,
+In addition, the old config file will be moved to file system meta-data,
 editable via the new
 .Nm
 .Cm viconfig
@@ -1160,7 +1183,7 @@ directive.
 The old config file will be deleted.
 Migration occurs only once.
 .Pp
-The V3 filesystem has new
+The V3 file system has new
 .Cm snap*
 directives for creating snapshots.
 All snapshot directives, including the original, will create
@@ -1169,13 +1192,13 @@ automatically incorporate these entries into its list and
 expire them the same way it expires softlinks.
 If you by accident blow away your snapshot softlinks you can use the
 .Cm snapls
-directive to get a definitive list from the meta-data and
+directive to get a definitive list from the file system meta-data and
 regenerate them from that list.
 .Pp
 .Em WARNING!
 If you are using
 .Nm
-to backup filesystems your scripts may be using the
+to backup file systems your scripts may be using the
 .Cm synctid
 directive to generate transaction ids.
 This directive does not create a snapshot.
@@ -1188,7 +1211,7 @@ directives.
 The older
 .Cm snapshot
 directive will continue to work as expected and in V3 it will also
-record the snapshot transaction id in meta-data.
+record the snapshot transaction id in file system meta-data.
 You may also want to make use of the new
 .Ar note
 tag for the meta-data.
index 5e1159b..07764c6 100644 (file)
@@ -445,7 +445,7 @@ hammer_parsedevs(const char *blkdevs)
        char *volname;
 
        if (blkdevs == NULL) {
-               errx(1, "A -f blkdev[:blkdev]* specification is required "
+               errx(1, "A -f blkdevs specification is required "
                        "for this command");
        }
 
@@ -485,13 +485,13 @@ usage(int exit_code)
        fprintf(stderr, 
                "hammer -h\n"
                "hammer [-2Bqrvy] [-b bandwidth] [-C cachesize[:readahead]] [-c cyclefile]\n"
-               "       [-f blkdev[:blkdev]*] [-i delay] [-t seconds] command [argument ...]\n"
+               "       [-f blkdevs] [-i delay] [-t seconds] command [argument ...]\n"
                "hammer synctid <filesystem> [quick]\n"
-               "hammer -f blkdev[:blkdev]* blockmap\n"
+               "hammer -f blkdevs blockmap\n"
                "hammer bstats [interval]\n"
                "hammer iostats [interval]\n"
                "hammer history[@offset[,len]] <file> ...\n"
-               "hammer -f blkdev[:blkdev]* [-r] [-vvv] show [lo:objid]\n"
+               "hammer -f blkdevs [-qqq] show [lo:objid]\n"
                "hammer namekey1 <path>\n"
                "hammer namekey2 <path>\n"
                "hammer namekey32 <path>\n"
@@ -524,18 +524,22 @@ usage(int exit_code)
                "hammer expand <filesystem> <device>\n"
        );
 
-       fprintf(stderr, "\nHAMMER utility version 3+ commands:\n\n");
+       fprintf(stderr, "\nHAMMER utility version 3+ commands:\n");
 
        fprintf(stderr,
                "hammer config [<filesystem> [<configfile>]]\n"
                "hammer viconfig [<filesystem>]\n"
-               "hammer snap <path> [<note>]\t\tas 'hammer snapshot' above but\n"
-               "                  \t\t\tpoints to base of PFS\n"
-               "hammer snaplo <path> [<note>]\t\tcreate in dir or softlink to create\n"
-               "                  \t\t\tpoints to target directory\n"
-               "hammer snapq <dir> [<note>]\t\tsnapshot path is output to stdout\n"
-               "hammer snaprm {<path> | <transid>} ...\tpath to softlink or transaction id\n"
-               "hammer snapls [<path> ...]\t\tlist all hard snapshots in PFS\n"
+               "hammer snap <path> [<note>]\n"
+               "hammer snaplo <path> [<note>]\n"
+               "hammer snapq <dir> [<note>]\n"
+               "hammer snaprm {<path> | <transid>} ...\n"
+               "hammer snapls [<path> ...]\n"
+       );
+
+       fprintf(stderr, "\nHAMMER utility version 4+ commands:\n");
+
+       fprintf(stderr,
+               "hammer -f blkdevs show-undo\n"
        );
 
        exit(exit_code);