Move properties, parameters, events, and concepts to section 7

Signed-off-by: Ahelenia Ziemiańska <[email protected]> Co-authored-by: Daniel Ebdrup Jensen <[email protected]> Closes openzfs#12149
nabijaczleweli · Jun 4, 2021 · 50197f9 · 50197f9
1 parent a1c1028
commit 50197f9
Show file tree

Hide file tree

Showing 50 changed files with 130 additions and 128 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"));
 	}
 
 	/*
@@ -8248,7 +8248,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:
@@ -8951,7 +8951,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-module-parameters(7) 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 \
+	\
+	man7/zpool-features.7 \
+	man7/spl-module-parameters.7 \
+	man7/zfs-module-parameters.7 \
+	man7/zfs-events.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-module-parameters 7
diff --git a/man/man5/spl-module-parameters.5 → man/man7/spl-module-parameters.7 b/man/man5/spl-module-parameters.5 → man/man7/spl-module-parameters.7
@@ -15,7 +15,7 @@
 .\" Copyright 2013 Turbo Fredriksson <[email protected]>. All rights reserved.
 .\"
 .Dd August 24, 2020
-.Dt SPL-MODULE-PARAMETERS 5
+.Dt SPL-MODULE-PARAMETERS 7
 .Os
 .
 .Sh NAME

diff --git a/man/man5/zfs-events.5 → man/man7/zfs-events.7 b/man/man5/zfs-events.5 → man/man7/zfs-events.7
@@ -15,7 +15,7 @@
 .\" Portions Copyright [yyyy] [name of copyright owner]
 .\"
 .Dd May 26, 2021
-.Dt ZFS-EVENTS 5
+.Dt ZFS-EVENTS 7
 .Os
 .
 .Sh NAME
@@ -57,7 +57,7 @@ by lost completion events due to flaky hardware or drivers.
 See
 .Sy zfs_deadman_failmode
 in
-.Xr zfs-module-parameters 5
+.Xr zfs-module-parameters 7
 for additional information regarding "hung" I/O detection and configuration.
 .It Sy delay
 Issued when a completed I/O request exceeds the maximum allowed time
@@ -166,7 +166,7 @@ or
 See the
 .Sy failmode
 property in
-.Xr zpoolprops 8
+.Xr zpoolprops 7
 for more information.
 .It Sy pool_guid
 The GUID of the pool.
@@ -186,7 +186,7 @@ etc.
 See the
 .Sy Virtual Devices
 section of
-.Xr zpoolconcepts 8
+.Xr zpoolconcepts 7
 for more information on possible values.
 .It Sy vdev_path
 Full path of the vdev, including any
@@ -280,7 +280,7 @@ The actual checksum value for an errant block.
 .It Sy cksum_algorithm
 Checksum algorithm used.
 See
-.Xr zfsprops 8
+.Xr zfsprops 7
 for more information on the available checksum algorithms.
 .It Sy cksum_byteswap
 Whether or not the data is byteswapped.

diff --git a/man/man5/zfs-module-parameters.5 → man/man7/zfs-module-parameters.7 b/man/man5/zfs-module-parameters.5 → man/man7/zfs-module-parameters.7
@@ -16,7 +16,7 @@
 .\" Portions Copyright [yyyy] [name of copyright owner]
 .\"
 .Dd June 1, 2021
-.Dt ZFS-MODULE-PARAMETERS 5
+.Dt ZFS-MODULE-PARAMETERS 7
 .Os
 .
 .Sh NAME

diff --git a/man/man8/zfsconcepts.8 → man/man7/zfsconcepts.7 b/man/man8/zfsconcepts.8 → man/man7/zfsconcepts.7
@@ -30,7 +30,7 @@
 .\" Copyright 2019 Joyent, Inc.
 .\"
 .Dd June 30, 2019
-.Dt ZFSCONCEPTS 8
+.Dt ZFSCONCEPTS 7
 .Os
 .
 .Sh NAME

diff --git a/man/man8/zfsprops.8 → man/man7/zfsprops.7 b/man/man8/zfsprops.8 → man/man7/zfsprops.7
@@ -38,7 +38,7 @@
 .\" Copyright (c) 2019, Kjeld Schouten-Lebbing
 .\"
 .Dd May 24, 2021
-.Dt ZFSPROPS 8
+.Dt ZFSPROPS 7
 .Os
 .
 .Sh NAME
@@ -304,7 +304,7 @@ The used space of a snapshot
 .Po see the
 .Sx Snapshots
 section of
-.Xr zfsconcepts 8
+.Xr zfsconcepts 7
 .Pc
 is space that is referenced exclusively by this snapshot.
 If this snapshot is destroyed, the amount of
@@ -777,7 +777,7 @@ does not support the
 algorithm.
 .Pp
 Please see
-.Xr zpool-features 5
+.Xr zpool-features 7
 for more information on these algorithms.
 .Pp
 Changing this property affects only newly-written data.
@@ -818,7 +818,7 @@ but can only be used on pools with the
 feature set to
 .Sy enabled .
 See
-.Xr zpool-features 5
+.Xr zpool-features 7
 for details on ZFS feature flags and the
 .Sy lz4_compress
 feature.
@@ -1019,7 +1019,7 @@ be enabled on a system.
 See the
 .Sx Deduplication
 section of
-.Xr zfsconcepts 8 .
+.Xr zfsconcepts 7 .
 .It Xo
 .Sy dnodesize Ns = Ns Sy legacy Ns | Ns Sy auto Ns | Ns Sy 1k Ns | Ns
 .Sy 2k Ns | Ns Sy 4k Ns | Ns Sy 8k Ns | Ns Sy 16k
@@ -1192,7 +1192,7 @@ does not override the ancestor's
 but rather imposes an additional limit.
 This feature must be enabled to be used
 .Po see
-.Xr zpool-features 5
+.Xr zpool-features 7
 .Pc .
 .It Sy special_small_blocks Ns = Ns Ar size
 This value represents the threshold block size for including small file
@@ -1207,14 +1207,14 @@ will be allocated in the special class.
 Before setting this property, a special class vdev must be added to the
 pool.
 See
-.Xr zpoolconcepts 8
+.Xr zpoolconcepts 7
 for more details on the special allocation class.
 .It Sy mountpoint Ns = Ns Pa path Ns | Ns Sy none Ns | Ns Sy legacy
 Controls the mount point used for this file system.
 See the
 .Sx Mount Points
 section of
-.Xr zfsconcepts 8
+.Xr zfsconcepts 7
 for more information on how this property is used.
 .Pp
 When the
@@ -1292,7 +1292,7 @@ For example, this means that recursive snapshots taken from the global zone are
 counted against each delegated dataset within a zone.
 This feature must be enabled to be used
 .Po see
-.Xr zpool-features 5
+.Xr zpool-features 7
 .Pc .
 .It Sy userquota@ Ns Ar user Ns = Ns Ar size Ns | Ns Sy none
 Limits the amount of space consumed by the specified user.
@@ -1435,7 +1435,7 @@ If the
 feature is enabled on the pool, the size may be up to
 .Ar 1MB .
 See
-.Xr zpool-features 5
+.Xr zpool-features 7
 for details on ZFS feature flags.
 .Pp
 Changing the file system's
@@ -1686,7 +1686,7 @@ directory is hidden or visible in the root of the file system as discussed in
 the
 .Sx Snapshots
 section of
-.Xr zfsconcepts 8 .
+.Xr zfsconcepts 7 .
 The default value is
 .Sy hidden .
 .It Sy sync Ns = Ns Sy standard Ns | Ns Sy always Ns | Ns Sy disabled

diff --git a/man/man5/zpool-features.5 → man/man7/zpool-features.7 b/man/man5/zpool-features.5 → man/man7/zpool-features.7
@@ -19,7 +19,7 @@
 .\" Copyright (c) 2021, Colm Buckley <[email protected]>
 .\"
 .Dd May 31, 2021
-.Dt ZPOOL-FEATURES 5
+.Dt ZPOOL-FEATURES 7
 .Os
 .
 .Sh NAME
@@ -521,7 +521,7 @@ will not match the source.
 Its use by
 .Nm zfs Cm send Fl i
 has been disabled by default
-.Pq see Sy send_holes_without_birth_time No in Xr zfs-module-parameters 5 .
+.Pq see Sy send_holes_without_birth_time No in Xr zfs-module-parameters 7 .
 .Pp
 This feature improves performance of incremental sends
 .Pq Nm zfs Cm send Fl i

diff --git a/man/man8/zpoolconcepts.8 → man/man7/zpoolconcepts.7 b/man/man8/zpoolconcepts.8 → man/man7/zpoolconcepts.7
@@ -27,7 +27,7 @@
 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
 .\"
 .Dd June 2, 2021
-.Dt ZPOOLCONCEPTS 8
+.Dt ZPOOLCONCEPTS 7
 .Os
 .
 .Sh NAME
@@ -508,5 +508,5 @@ in the special class by setting the
 .Sy special_small_blocks
 property to nonzero.
 See
-.Xr zfsprops 8
+.Xr zfsprops 7
 for more info on this property.
diff --git a/man/man8/zpoolprops.8 → man/man7/zpoolprops.7 b/man/man8/zpoolprops.8 → man/man7/zpoolprops.7
@@ -28,7 +28,7 @@
 .\" Copyright (c) 2021, Colm Buckley <[email protected]>
 .\"
 .Dd May 27, 2021
-.Dt ZPOOLPROPS 8
+.Dt ZPOOLPROPS 7
 .Os
 .
 .Sh NAME
@@ -89,7 +89,7 @@ This discrepancy is due to several factors, including raidz parity;
 zfs reservation, quota, refreservation, and refquota properties; and space set aside by
 .Sy spa_slop_shift
 (see
-.Xr zfs-module-parameters 5
+.Xr zfs-module-parameters 7
 for more information).
 .It Sy freeing
 After a file system or snapshot is destroyed, the space it was using is
@@ -121,7 +121,7 @@ Total size of the storage pool.
 .It Sy unsupported@ Ns Em guid
 Information about unsupported features that are enabled on the pool.
 See
-.Xr zpool-features 5
+.Xr zpool-features 7
 for details.
 .El
 .Pp
@@ -316,7 +316,7 @@ whitespace and/or commas.
 Only features present in all files may be enabled.
 .Pp
 See
-.Xr zpool-features 5 ,
+.Xr zpool-features 7 ,
 .Xr zpool-create 8
 and
 .Xr zpool-upgrade 8
@@ -357,7 +357,7 @@ which moves
 .Ar feature_name
 to the enabled state.
 See
-.Xr zpool-features 5
+.Xr zpool-features 7
 for details on feature states.
 .It Sy listsnapshots Ns = Ns Sy on Ns | Ns Sy off
 Controls whether information about snapshots associated with this pool is
@@ -390,13 +390,13 @@ in use.
 See
 .Sy zfs_multihost_interval
 in the
-.Xr zfs-module-parameters 5
+.Xr zfs-module-parameters 7
 manual page.
 In order to enable this property each host must set a unique hostid.
 See
 .Xr genhostid 1
 .Xr zgenhostid 8
-.Xr spl-module-parameters 5
+.Xr spl-module-parameters 7
 for additional details.
 The default value is
 .Sy off .

diff --git a/man/man8/mount.zfs.8 b/man/man8/mount.zfs.8
@@ -56,7 +56,7 @@ in most cases.
 are handled according to the
 .Em Temporary Mount Point Properties
 section in
-.Xr zfsprops 8 ,
+.Xr zfsprops 7 ,
 except for those described below.
 .Pp
 If

diff --git a/man/man8/zed.8.in b/man/man8/zed.8.in
@@ -237,7 +237,7 @@ Terminate the daemon.
 .El
 .
 .Sh SEE ALSO
-.Xr zfs-events 5 ,
+.Xr zfs-events 7 ,
 .Xr zfs 8 ,
 .Xr zpool 8 ,
 .Xr zpool-events 8

diff --git a/man/man8/zfs-bookmark.8 b/man/man8/zfs-bookmark.8
@@ -56,7 +56,7 @@ a redaction bookmark.
 .Pp
 This feature must be enabled to be used.
 See
-.Xr zpool-features 5
+.Xr zpool-features 7
 for details on ZFS feature flags and the
 .Sy bookmarks
 feature.

diff --git a/man/man8/zfs-clone.8 b/man/man8/zfs-clone.8
@@ -47,7 +47,7 @@
 See the
 .Sx Clones
 section of
-.Xr zfsconcepts 8
+.Xr zfsconcepts 7
 for details.
 The target dataset can be located anywhere in the ZFS hierarchy,
 and is created as the same type as the original.