Fix style issues in man pages and commands help

* Remove 'zfs snap' from zfs help message (OpenZFS sync)
* Update zfs(8) to suggest 'snap' can be used as an alias for 'snapshot'
* Enforce 80 columns limit in help messages
* Remove zfs_disable_dup_eviction from zfs-module-parameters(5)
* Expose zfs_scan_max_ext_gap as a kernel module parameter.

Reviewed-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Reviewed by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Tom Caputi <tcaputi@datto.com>
Signed-off-by: loli10K <ezomori.nozomu@gmail.com>
Closes #7087

diff --git a/cmd/zdb/zdb.c b/cmd/zdb/zdb.c
index 1415be8643ae467e410189f93a481523edd79167..3719d22e14ed4dab0f93af83e0dd4c156eddcdec 100644 (file)
--- a/cmd/zdb/zdb.c
+++ b/cmd/zdb/zdb.c
@@ -131,8 +131,8 @@ usage(void)
            "[-I <inflight I/Os>]\n"
            "\t\t[-o <var>=<value>]... [-t <txg>] [-U <cache>] [-x <dumpdir>]\n"
            "\t\t[<poolname> [<object> ...]]\n"
-           "\t%s [-AdiPv] [-e [-V] [-p <path> ...]] [-U <cache>] <dataset> "
-           "[<object> ...]\n"
+           "\t%s [-AdiPv] [-e [-V] [-p <path> ...]] [-U <cache>] <dataset>\n"
+           "\t\t[<object> ...]\n"
            "\t%s -C [-A] [-U <cache>]\n"
            "\t%s -l [-Aqu] <device>\n"
            "\t%s -m [-AFLPX] [-e [-V] [-p <path> ...]] [-t <txg>] "

diff --git a/cmd/zfs/zfs_main.c b/cmd/zfs/zfs_main.c
index 924a4d4aa6f920f23cc053d46786dbca757b1f54..fa1a5d9fd294c38135f59e6d8b717c30a63117d9 100644 (file)
--- a/cmd/zfs/zfs_main.c
+++ b/cmd/zfs/zfs_main.c
@@ -286,7 +286,7 @@ get_usage(zfs_help_t idx)
        case HELP_SHARE:
                return (gettext("\tshare [-l] <-a [nfs|smb] | filesystem>\n"));
        case HELP_SNAPSHOT:
-               return (gettext("\tsnapshot|snap [-r] [-o property=value] ... "
+               return (gettext("\tsnapshot [-r] [-o property=value] ... "
                    "<filesystem|volume>@<snap> ...\n"));
        case HELP_UNMOUNT:
                return (gettext("\tunmount [-f] "

diff --git a/cmd/zpool/zpool_main.c b/cmd/zpool/zpool_main.c
index 4905927fca3f76765196d065d3bb4c838a81ab1b..f8d3a75bdb82df3cd72fb559ad6070bf6040dc2f 100644 (file)
--- a/cmd/zpool/zpool_main.c
+++ b/cmd/zpool/zpool_main.c
@@ -334,7 +334,8 @@ get_usage(zpool_help_t idx)
                return (gettext("\tlabelclear [-f] <vdev>\n"));
        case HELP_LIST:
                return (gettext("\tlist [-gHLpPv] [-o property[,...]] "
-                   "[-T d|u] [pool] ... [interval [count]]\n"));
+                   "[-T d|u] [pool] ... \n"
+                   "\t    [interval [count]]\n"));
        case HELP_OFFLINE:
                return (gettext("\toffline [-f] [-t] <pool> <device> ...\n"));
        case HELP_ONLINE:
@@ -350,7 +351,8 @@ get_usage(zpool_help_t idx)
                return (gettext("\tscrub [-s | -p] <pool> ...\n"));
        case HELP_STATUS:
                return (gettext("\tstatus [-c [script1,script2,...]] [-gLPvxD]"
-                   "[-T d|u] [pool] ... [interval [count]]\n"));
+                   "[-T d|u] [pool] ... \n"
+                   "\t    [interval [count]]\n"));
        case HELP_UPGRADE:
                return (gettext("\tupgrade\n"
                    "\tupgrade -v\n"

diff --git a/man/man5/zfs-module-parameters.5 b/man/man5/zfs-module-parameters.5
index 039e024bb4e7a78ff3e2b61998d8e3a1f541424d..a5c83b422f7a12590f146a108d0d64a5f86733e9 100644 (file)
--- a/man/man5/zfs-module-parameters.5
+++ b/man/man5/zfs-module-parameters.5
@@ -1253,17 +1253,6 @@ See also \fBzio_dva_throttle_enabled\fR.
 Default value: \fB1000\fR%.
 .RE
 
-.sp
-.ne 2
-.na
-\fBzfs_disable_dup_eviction\fR (int)
-.ad
-.RS 12n
-Disable duplicate buffer eviction
-.sp
-Use \fB1\fR for yes and \fB0\fR for no (default).
-.RE
-
 .sp
 .ne 2
 .na

diff --git a/man/man8/zfs.8 b/man/man8/zfs.8
index 85f510d36f3d8b75d5846c7c958519c8b9cb99ec..4723de45d5afb64f51b5b332c520ae1818cf7a92 100644 (file)
--- a/man/man8/zfs.8
+++ b/man/man8/zfs.8
@@ -2459,7 +2459,7 @@ The given bookmark is destroyed.
 .Nm
 .Cm snapshot
 .Op Fl r
-.Oo Fl o Ar property Ns = Ns value Oc Ns ...
+.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 .Ar filesystem Ns @ Ns Ar snapname Ns | Ns Ar volume Ns @ Ns Ar snapname Ns ...
 .Xc
 Creates snapshots with the given names.
@@ -2467,6 +2467,9 @@ All previous modifications by successful system calls to the file system are
 part of the snapshots.
 Snapshots are taken atomically, so that all snapshots correspond to the same
 moment in time.
+.Nm zfs Cm snap
+can be used as an alias for
+.Nm zfs Cm snapshot.
 See the
 .Sx Snapshots
 section for details.

diff --git a/module/zfs/dsl_scan.c b/module/zfs/dsl_scan.c
index 2231ef1c0ed62243a4d2f5cafe5cdbb38c16a771..4b4f1665c00eabf05417bb26b2402f5aba9b378f 100644 (file)
--- a/module/zfs/dsl_scan.c
+++ b/module/zfs/dsl_scan.c
@@ -147,7 +147,7 @@ unsigned long zfs_scan_vdev_limit = 4 << 20;
 
 int zfs_scan_issue_strategy = 0;
 int zfs_scan_legacy = B_FALSE; /* don't queue & sort zios, go direct */
-uint64_t zfs_scan_max_ext_gap = 2 << 20; /* in bytes */
+unsigned long zfs_scan_max_ext_gap = 2 << 20; /* in bytes */
 
 /*
  * fill_weight is non-tunable at runtime, so we copy it at module init from
@@ -3886,6 +3886,11 @@ module_param(zfs_scan_checkpoint_intval, int, 0644);
 MODULE_PARM_DESC(zfs_scan_checkpoint_intval,
        "Scan progress on-disk checkpointing interval");
 
+/* CSTYLED */
+module_param(zfs_scan_max_ext_gap, ulong, 0644);
+MODULE_PARM_DESC(zfs_scan_max_ext_gap,
+       "Max gap in bytes between sequential scrub / resilver I/Os");
+
 module_param(zfs_scan_mem_lim_soft_fact, int, 0644);
 MODULE_PARM_DESC(zfs_scan_mem_lim_soft_fact,
        "Fraction of hard limit used as soft limit");