Move properties, parameters, events, and concepts around manual sections

The pages moved as follows: zpool-features.{5 => 7} spl{-module-parameters.5 => .4} zfs{-module-parameters.5 => .4} zfs-events.5 => into zpool-events.8 zfsconcepts.{8 => 7} zfsprops.{8 => 7} zpoolconcepts.{8 => 7} zpoolprops.{8 => 7} Reviewed-by: Richard Laager <[email protected]> Reviewed-by: Brian Behlendorf <[email protected]> Signed-off-by: Ahelenia Ziemiańska <[email protected]> Co-authored-by: Daniel Ebdrup Jensen <[email protected]> Closes openzfs#12149 Closes openzfs#12212
behlendorf · Jun 10, 2021 · 2e93407 · 2e93407
1 parent beeadb4
commit 2e93407
Show file tree

Hide file tree

Showing 50 changed files with 543 additions and 582 deletions.
diff --git a/cmd/zpool/zpool_main.c b/cmd/zpool/zpool_main.c
@@ -533,7 +533,7 @@ usage(boolean_t requested)
 		(void) fprintf(fp, "YES   disabled | enabled | active\n");
 
 		(void) fprintf(fp, gettext("\nThe feature@ properties must be "
-		    "appended with a feature name.\nSee zpool-features(5).\n"));
+		    "appended with a feature name.\nSee zpool-features(7).\n"));
 	}
 
 	/*
@@ -8269,7 +8269,7 @@ status_callback(zpool_handle_t *zhp, void *data)
 		printf_color(ANSI_YELLOW, gettext("Enable all features using "
 		    "'zpool upgrade'. Once this is done,\n\tthe pool may no "
 		    "longer be accessible by software that does not support\n\t"
-		    "the features. See zpool-features(5) for details.\n"));
+		    "the features. See zpool-features(7) for details.\n"));
 		break;
 
 	case ZPOOL_STATUS_COMPATIBILITY_ERR:
@@ -8972,7 +8972,7 @@ upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg)
 					    "pool may become incompatible with "
 					    "software\nthat does not support "
 					    "the feature. See "
-					    "zpool-features(5) for "
+					    "zpool-features(7) for "
 					    "details.\n\n"
 					    "Note that the pool "
 					    "'compatibility' feature can be "

diff --git a/cmd/zpool_influxdb/dashboards/grafana/ZFS-pool-latency-heatmaps-influxdb.json b/cmd/zpool_influxdb/dashboards/grafana/ZFS-pool-latency-heatmaps-influxdb.json
@@ -1360,7 +1360,7 @@
       "type": "row"
     },
     {
-      "content": "I/O requests that are satisfied by accessing pool devices are managed by the ZIO scheduler.\nThe total latency is measured from the start of the I/O to completion by the disk.\nLatency through each queue is shown prior to its submission to the disk queue.\n\nThis view is useful for observing the effects of tuning the ZIO scheduler min and max values\n(see zfs-module-parameters(5) and [ZFS on Linux Module Parameters](https://openzfs.github.io/openzfs-docs/Performance%20and%20tuning/ZFS%20on%20Linux%20Module%20Parameters.html)):\n+ *zfs_vdev_max_active* controls the ZIO scheduler's disk queue depth (do not confuse with the block device's nr_requests)\n+ *zfs_vdev_sync_read_min_active* and *zfs_vdev_sync_read_max_active* control the synchronous queue for reads: most reads are sync\n+ *zfs_vdev_sync_write_min_active* and *zfs_vdev_sync_write_max_active* control the synchronous queue for writes: \nusually metadata or user data depending on the \"sync\" property setting or I/Os that are requested to be flushed\n+ *zfs_vdev_async_read_min_active* and *zfs_vdev_async_read_max_active* control the asynchronous queue for reads: usually prefetches\n+ *zfs_vdev_async_write_min_active* and *zfs_vdev_async_write_max_active* control the asynchronous queue for writes: \nusually the bulk of all writes at transaction group (txg) commit\n+ *zfs_vdev_scrub_min_active* and *zfs_vdev_scrub_max_active* controls the scan reads: usually scrub or resilver\n\n",
+      "content": "I/O requests that are satisfied by accessing pool devices are managed by the ZIO scheduler.\nThe total latency is measured from the start of the I/O to completion by the disk.\nLatency through each queue is shown prior to its submission to the disk queue.\n\nThis view is useful for observing the effects of tuning the ZIO scheduler min and max values\n(see zfs(4) and [ZFS on Linux Module Parameters](https://openzfs.github.io/openzfs-docs/Performance%20and%20tuning/ZFS%20on%20Linux%20Module%20Parameters.html)):\n+ *zfs_vdev_max_active* controls the ZIO scheduler's disk queue depth (do not confuse with the block device's nr_requests)\n+ *zfs_vdev_sync_read_min_active* and *zfs_vdev_sync_read_max_active* control the synchronous queue for reads: most reads are sync\n+ *zfs_vdev_sync_write_min_active* and *zfs_vdev_sync_write_max_active* control the synchronous queue for writes: \nusually metadata or user data depending on the \"sync\" property setting or I/Os that are requested to be flushed\n+ *zfs_vdev_async_read_min_active* and *zfs_vdev_async_read_max_active* control the asynchronous queue for reads: usually prefetches\n+ *zfs_vdev_async_write_min_active* and *zfs_vdev_async_write_max_active* control the asynchronous queue for writes: \nusually the bulk of all writes at transaction group (txg) commit\n+ *zfs_vdev_scrub_min_active* and *zfs_vdev_scrub_max_active* controls the scan reads: usually scrub or resilver\n\n",
       "datasource": "${DS_MACBOOK-INFLUX}",
       "fieldConfig": {
         "defaults": {
@@ -1664,4 +1664,4 @@
     "list": []
   },
   "version": 2
-}
+}
diff --git a/man/Makefile.am b/man/Makefile.am
@@ -11,18 +11,21 @@ dist_man_MANS = \
 	man1/arcstat.1 \
 	\
 	man5/vdev_id.conf.5 \
-	man5/zpool-features.5 \
-	man5/spl-module-parameters.5 \
-	man5/zfs-module-parameters.5 \
-	man5/zfs-events.5 \
+	\
+	man4/spl.4 \
+	man4/zfs.4 \
+	\
+	man7/zpool-features.7 \
+	man7/zfsconcepts.7 \
+	man7/zfsprops.7 \
+	man7/zpoolconcepts.7 \
+	man7/zpoolprops.7 \
 	\
 	man8/fsck.zfs.8 \
 	man8/mount.zfs.8 \
 	man8/vdev_id.8 \
 	man8/zdb.8 \
 	man8/zfs.8 \
-	man8/zfsconcepts.8 \
-	man8/zfsprops.8 \
 	man8/zfs-allow.8 \
 	man8/zfs-bookmark.8 \
 	man8/zfs-change-key.8 \
@@ -63,8 +66,6 @@ dist_man_MANS = \
 	man8/zgenhostid.8 \
 	man8/zinject.8 \
 	man8/zpool.8 \
-	man8/zpoolconcepts.8 \
-	man8/zpoolprops.8 \
 	man8/zpool-add.8 \
 	man8/zpool-attach.8 \
 	man8/zpool-checkpoint.8 \

diff --git a/man/man1/zhack.1 b/man/man1/zhack.1
@@ -138,5 +138,5 @@ descriptions_obj:
 .
 .Sh SEE ALSO
 .Xr ztest 1 ,
-.Xr zpool-features 5 ,
+.Xr zpool-features 7 ,
 .Xr zfs 8
diff --git a/man/man1/ztest.1 b/man/man1/ztest.1
@@ -230,4 +230,4 @@ By default the stack size is limited to
 .Xr zdb 1 ,
 .Xr zfs 1 ,
 .Xr zpool 1 ,
-.Xr spl-module-parameters 5
+.Xr spl 4
diff --git a/man/man5/spl-module-parameters.5 → man/man4/spl.4 b/man/man5/spl-module-parameters.5 → man/man4/spl.4
@@ -15,11 +15,11 @@
 .\" Copyright 2013 Turbo Fredriksson <[email protected]>. All rights reserved.
 .\"
 .Dd August 24, 2020
-.Dt SPL-MODULE-PARAMETERS 5
+.Dt SPL 4
 .Os
 .
 .Sh NAME
-.Nm spl-module-parameters
+.Nm spl
 .Nd parameters of the SPL kernel module
 .
 .Sh DESCRIPTION
@@ -192,5 +192,4 @@ The proc file will walk the lists with lock held,
 reading it could cause a lock-up if the list grow too large
 without limiting the output.
 "(truncated)" will be shown if the list is larger than the limit.
-.
 .El
diff --git a/man/man5/zfs-module-parameters.5 → man/man4/zfs.4 b/man/man5/zfs-module-parameters.5 → man/man4/zfs.4
@@ -16,14 +16,15 @@
 .\" Portions Copyright [yyyy] [name of copyright owner]
 .\"
 .Dd June 1, 2021
-.Dt ZFS-MODULE-PARAMETERS 5
+.Dt ZFS 4
 .Os
 .
 .Sh NAME
-.Nm zfs-module-parameters
-.Nd parameters of the ZFS kernel module
+.Nm zfs
+.Nd tuning of the ZFS kernel module
 .
 .Sh DESCRIPTION
+The ZFS module supports these parameters:
 .Bl -tag -width Ds
 .It Sy dbuf_cache_max_bytes Ns = Ns Sy ULONG_MAX Ns B Pq ulong
 Maximum size in bytes of the dbuf cache.