Skip to content

Commit b44fe40

Browse files
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} Signed-off-by: Ahelenia Ziemiańska <[email protected]> Co-authored-by: Daniel Ebdrup Jensen <[email protected]> Closes openzfs#12149
1 parent 1357f8c commit b44fe40

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+554
-581
lines changed

cmd/zpool/zpool_main.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ usage(boolean_t requested)
533533
(void) fprintf(fp, "YES disabled | enabled | active\n");
534534

535535
(void) fprintf(fp, gettext("\nThe feature@ properties must be "
536-
"appended with a feature name.\nSee zpool-features(5).\n"));
536+
"appended with a feature name.\nSee zpool-features(7).\n"));
537537
}
538538

539539
/*
@@ -8248,7 +8248,7 @@ status_callback(zpool_handle_t *zhp, void *data)
82488248
printf_color(ANSI_YELLOW, gettext("Enable all features using "
82498249
"'zpool upgrade'. Once this is done,\n\tthe pool may no "
82508250
"longer be accessible by software that does not support\n\t"
8251-
"the features. See zpool-features(5) for details.\n"));
8251+
"the features. See zpool-features(7) for details.\n"));
82528252
break;
82538253

82548254
case ZPOOL_STATUS_COMPATIBILITY_ERR:
@@ -8951,7 +8951,7 @@ upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg)
89518951
"pool may become incompatible with "
89528952
"software\nthat does not support "
89538953
"the feature. See "
8954-
"zpool-features(5) for "
8954+
"zpool-features(7) for "
89558955
"details.\n\n"
89568956
"Note that the pool "
89578957
"'compatibility' feature can be "

cmd/zpool_influxdb/dashboards/grafana/ZFS-pool-latency-heatmaps-influxdb.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1360,7 +1360,7 @@
13601360
"type": "row"
13611361
},
13621362
{
1363-
"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",
1363+
"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",
13641364
"datasource": "${DS_MACBOOK-INFLUX}",
13651365
"fieldConfig": {
13661366
"defaults": {
@@ -1664,4 +1664,4 @@
16641664
"list": []
16651665
},
16661666
"version": 2
1667-
}
1667+
}

man/Makefile.am

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,21 @@ dist_man_MANS = \
1111
man1/arcstat.1 \
1212
\
1313
man5/vdev_id.conf.5 \
14-
man5/zpool-features.5 \
15-
man5/spl-module-parameters.5 \
16-
man5/zfs-module-parameters.5 \
17-
man5/zfs-events.5 \
14+
\
15+
man4/spl.4 \
16+
man4/zfs.4 \
17+
\
18+
man7/zpool-features.7 \
19+
man7/zfsconcepts.7 \
20+
man7/zfsprops.7 \
21+
man7/zpoolconcepts.7 \
22+
man7/zpoolprops.7 \
1823
\
1924
man8/fsck.zfs.8 \
2025
man8/mount.zfs.8 \
2126
man8/vdev_id.8 \
2227
man8/zdb.8 \
2328
man8/zfs.8 \
24-
man8/zfsconcepts.8 \
25-
man8/zfsprops.8 \
2629
man8/zfs-allow.8 \
2730
man8/zfs-bookmark.8 \
2831
man8/zfs-change-key.8 \
@@ -63,8 +66,6 @@ dist_man_MANS = \
6366
man8/zgenhostid.8 \
6467
man8/zinject.8 \
6568
man8/zpool.8 \
66-
man8/zpoolconcepts.8 \
67-
man8/zpoolprops.8 \
6869
man8/zpool-add.8 \
6970
man8/zpool-attach.8 \
7071
man8/zpool-checkpoint.8 \

man/man1/zhack.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,5 +138,5 @@ descriptions_obj:
138138
.
139139
.Sh SEE ALSO
140140
.Xr ztest 1 ,
141-
.Xr zpool-features 5 ,
141+
.Xr zpool-features 7 ,
142142
.Xr zfs 8

man/man1/ztest.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,4 +230,4 @@ By default the stack size is limited to
230230
.Xr zdb 1 ,
231231
.Xr zfs 1 ,
232232
.Xr zpool 1 ,
233-
.Xr spl-module-parameters 5
233+
.Xr spl 4

man/man5/spl-module-parameters.5 renamed to man/man4/spl.4

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
.\" Copyright 2013 Turbo Fredriksson <[email protected]>. All rights reserved.
1616
.\"
1717
.Dd August 24, 2020
18-
.Dt SPL-MODULE-PARAMETERS 5
18+
.Dt SPL 4
1919
.Os
2020
.
2121
.Sh NAME
22-
.Nm spl-module-parameters
22+
.Nm spl
2323
.Nd parameters of the SPL kernel module
2424
.
2525
.Sh DESCRIPTION
@@ -192,5 +192,4 @@ The proc file will walk the lists with lock held,
192192
reading it could cause a lock-up if the list grow too large
193193
without limiting the output.
194194
"(truncated)" will be shown if the list is larger than the limit.
195-
.
196195
.El

man/man5/zfs-module-parameters.5 renamed to man/man4/zfs.4

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@
1616
.\" Portions Copyright [yyyy] [name of copyright owner]
1717
.\"
1818
.Dd June 1, 2021
19-
.Dt ZFS-MODULE-PARAMETERS 5
19+
.Dt ZFS 4
2020
.Os
2121
.
2222
.Sh NAME
23-
.Nm zfs-module-parameters
24-
.Nd parameters of the ZFS kernel module
23+
.Nm zfs
24+
.Nd tuning of the ZFS kernel module
2525
.
2626
.Sh DESCRIPTION
27+
The ZFS module supports these parameters:
2728
.Bl -tag -width Ds
2829
.It Sy dbuf_cache_max_bytes Ns = Ns Sy ULONG_MAX Ns B Pq ulong
2930
Maximum size in bytes of the dbuf cache.

0 commit comments

Comments
 (0)