Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various minor improvements/fixes to the manpages #17140

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion man/man1/ztest.1
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Max loops in
.It Fl B , -alt-ztest Ns =
Path to alternate ("older")
.Nm ztest
to drive, which will be used to initialise the pool, and, a stochastic half the
to drive, which will be used to initialize the pool, and, a stochastic half the
time, to run the tests.
The parallel
.Pa lib
Expand Down
6 changes: 3 additions & 3 deletions man/man4/spl.4
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ when exceeding this value.
.It Sy spl_kmem_cache_magazine_size Ns = Ns Sy 0 Pq uint
Cache magazines are an optimization designed to minimize the cost of
allocating memory.
They do this by keeping a per-cpu cache of recently
They do this by keeping a per-CPU cache of recently
freed objects, which can then be reallocated without taking a lock.
This can improve performance on highly contended caches.
However, because objects in magazines will prevent otherwise empty slabs
Expand All @@ -110,8 +110,8 @@ For this reason,
can be used to set a maximum magazine size.
When this value is set to 0 the magazine size will
be automatically determined based on the object size.
Otherwise magazines will be limited to 2-256 objects per magazine (i.e per cpu).
Magazines may never be entirely disabled in this implementation.
Otherwise magazines will be limited to 2-256 objects per magazine (i.e. per
CPU). Magazines may never be entirely disabled in this implementation.
.
.It Sy spl_hostid Ns = Ns Sy 0 Pq ulong
The system hostid, when set this can be used to uniquely identify a system.
Expand Down
20 changes: 10 additions & 10 deletions man/man4/zfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ transition to MRU, in which case the
Setting it to 1 means to L2 cache only MFU data and metadata.
.Pp
Setting it to 2 means to L2 cache all metadata (MRU+MFU) but
only MFU data (ie: MRU data are not cached). This can be the right setting
only MFU data (i.e. MRU data are not cached). This can be the right setting
to cache as much metadata as possible even when having high data turnover.
.Pp
Regardless of
Expand Down Expand Up @@ -236,7 +236,7 @@ in reading stored log metadata, or the metadata
has become somehow fragmented/unusable).
.
.It Sy l2arc_rebuild_blocks_min_l2size Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64
Mininum size of an L2ARC device required in order to write log blocks in it.
Minimum size of an L2ARC device required in order to write log blocks in it.
The log blocks are used upon importing the pool to rebuild the persistent L2ARC.
.Pp
For L2ARC devices less than 1 GiB, the amount of data
Expand Down Expand Up @@ -571,16 +571,16 @@ most ZPL operations (e.g. write, create) will return
.Sy ENOSPC .
.
.It Sy spa_num_allocators Ns = Ns Sy 4 Pq int
Determines the number of block alloctators to use per spa instance.
Determines the number of block allocators to use per spa instance.
Capped by the number of actual CPUs in the system via
.Sy spa_cpus_per_allocator .
.Pp
Note that setting this value too high could result in performance
degredation and/or excess fragmentation.
degradation and/or excess fragmentation.
Set value only applies to pools imported/created after that.
.
.It Sy spa_cpus_per_allocator Ns = Ns Sy 4 Pq int
Determines the minimum number of CPUs in a system for block alloctator
Determines the minimum number of CPUs in a system for block allocator
per spa instance.
Set value only applies to pools imported/created after that.
.
Expand Down Expand Up @@ -1105,7 +1105,7 @@ Max memory to use for dedup logs, as a percentage of total memory.
.Pp
If
.Sy zfs_dedup_log_mem_max
is not set, it will be initialised as a percentage of the total memory in the
is not set, it will be initialized as a percentage of the total memory in the
system.
.
.It Sy zfs_delay_min_dirty_percent Ns = Ns Sy 60 Ns % Pq uint
Expand Down Expand Up @@ -1281,7 +1281,7 @@ This should be less than
.Sy zfs_vdev_async_write_active_min_dirty_percent .
.
.It Sy zfs_wrlog_data_max Ns = Pq int
The upper limit of write-transaction zil log data size in bytes.
The upper limit of write-transaction ZIL log data size in bytes.
Write operations are throttled when approaching the limit until log data is
cleared out after transaction group sync.
Because of some overhead, it should be set at least 2 times the size of
Expand Down Expand Up @@ -1990,7 +1990,7 @@ as it typically results in leaked space, or worse.
.It Sy zfs_removal_ignore_errors Ns = Ns Sy 0 Ns | Ns 1 Pq int
Ignore hard I/O errors during device removal.
When set, if a device encounters a hard I/O error during the removal process
the removal will not be cancelled.
the removal will not be canceled.
This can result in a normally recoverable block becoming permanently damaged
and is hence not recommended.
This should only be used as a last resort when the
Expand Down Expand Up @@ -2395,7 +2395,7 @@ This controls the number of threads used by
.Sy dp_zil_clean_taskq .
The default value of
.Sy 100%
will create a maximum of one thread per cpu.
will create a maximum of one thread per CPU.
.
.It Sy zil_maxblocksize Ns = Ns Sy 131072 Ns B Po 128 KiB Pc Pq uint
This sets the maximum block size used by the ZIL.
Expand Down Expand Up @@ -2649,7 +2649,7 @@ and
limits.
.
.It Sy zvol_volmode Ns = Ns Sy 1 Pq uint
Defines zvol block devices behaviour when
Defines zvol block devices behavior when
.Sy volmode Ns = Ns Sy default :
.Bl -tag -compact -offset 4n -width "a"
.It Sy 1
Expand Down
4 changes: 2 additions & 2 deletions man/man7/vdevprops.7
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ state of this vdev such as online, faulted, or offline
.It Sy guid
globally unique id of this vdev
.It Sy asize
The allocable size of this vdev
The allocatable size of this vdev
.It Sy psize
The physical size of this vdev
.It Sy ashift
Expand All @@ -95,7 +95,7 @@ The physical path to the device
.It Sy encpath
The enclosure path to the device
.It Sy fru
Field Replacable Unit, usually a model number
Field Replaceable Unit, usually a model number
.It Sy parent
Parent of this vdev
.It Sy children
Expand Down
34 changes: 17 additions & 17 deletions man/man7/zfsprops.7
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ This property can also be referred to by its shortened column name,
.It Sy logicalused
The amount of space that is
.Qq logically
consumed by this dataset and all its descendents.
consumed by this dataset and all its descendants.
See the
.Sy used
property.
Expand Down Expand Up @@ -262,10 +262,10 @@ this opaque token can be provided to
to resume and complete the
.Nm zfs Cm receive .
.It Sy redact_snaps
For bookmarks, this is the list of snapshot guids the bookmark contains a
For bookmarks, this is the list of snapshot GUIDs the bookmark contains a
redaction
list for.
For snapshots, this is the list of snapshot guids the snapshot is redacted with
For snapshots, this is the list of snapshot GUIDs the snapshot is redacted with
respect to.
.It Sy referenced
The amount of data that is accessible by this dataset, which may or may not be
Expand Down Expand Up @@ -297,7 +297,7 @@ The type of dataset:
or
.Sy bookmark .
.It Sy used
The amount of space consumed by this dataset and all its descendents.
The amount of space consumed by this dataset and all its descendants.
This is the value that is checked against this dataset's quota and reservation.
The space used does not include this dataset's reservation, but does take into
account the reservations of any descendent datasets.
Expand Down Expand Up @@ -360,7 +360,7 @@ The amount of space used by this dataset itself, which would be freed if the
dataset were destroyed
.Po after first removing any
.Sy refreservation
and destroying any necessary snapshots or descendents
and destroying any necessary snapshots or descendants
.Pc .
.It Sy usedbyrefreservation
The amount of space used by a
Expand Down Expand Up @@ -542,8 +542,8 @@ cannot be changed once the volume has been written, so it should be set at
volume creation time.
The default
.Sy blocksize
for volumes is 16 Kbytes.
Any power of 2 from 512 bytes to 128 Kbytes is valid.
for volumes is 16 KiB.
Any power of 2 from 512 bytes to 128 KiB is valid.
.Pp
This property can also be referred to by its shortened column name,
.Sy volblock .
Expand Down Expand Up @@ -1269,7 +1269,7 @@ Setting a
.Sy filesystem_limit
to
.Sy on
a descendent of a filesystem that already has a
a descendant of a filesystem that already has a
.Sy filesystem_limit
does not override the ancestor's
.Sy filesystem_limit ,
Expand Down Expand Up @@ -1328,7 +1328,7 @@ as it was before.
Controls whether the file system should be mounted with
.Sy nbmand
.Pq Non-blocking mandatory locks .
Changes to this property only take effect when the file system is umounted and
Changes to this property only take effect when the file system is unmounted and
remounted.
This was only supported by Linux prior to 5.15, and was buggy there,
and is not supported by
Expand Down Expand Up @@ -1361,22 +1361,22 @@ then only metadata is cached.
The default value is
.Sy all .
.It Sy quota Ns = Ns Ar size Ns | Ns Sy none
Limits the amount of space a dataset and its descendents can consume.
Limits the amount of space a dataset and its descendants can consume.
This property enforces a hard limit on the amount of space used.
This includes all space consumed by descendents, including file systems and
This includes all space consumed by descendants, including file systems and
snapshots.
Setting a quota on a descendent of a dataset that already has a quota does not
Setting a quota on a descendant of a dataset that already has a quota does not
override the ancestor's quota, but rather imposes an additional limit.
.Pp
Quotas cannot be set on volumes, as the
.Sy volsize
property acts as an implicit quota.
.It Sy snapshot_limit Ns = Ns Ar count Ns | Ns Sy none
Limits the number of snapshots that can be created on a dataset and its
descendents.
descendants.
Setting a
.Sy snapshot_limit
on a descendent of a dataset that already has a
on a descendant of a dataset that already has a
.Sy snapshot_limit
does not override the ancestor's
.Sy snapshot_limit ,
Expand Down Expand Up @@ -1607,11 +1607,11 @@ The default value is
.It Sy refquota Ns = Ns Ar size Ns | Ns Sy none
Limits the amount of space a dataset can consume.
This property enforces a hard limit on the amount of space used.
This hard limit does not include space used by descendents, including file
This hard limit does not include space used by descendants, including file
systems and snapshots.
.It Sy refreservation Ns = Ns Ar size Ns | Ns Sy none Ns | Ns Sy auto
The minimum amount of space guaranteed to a dataset, not including its
descendents.
descendants.
When the amount of space used is below this value, the dataset is treated as if
it were taking up the amount of space specified by
.Sy refreservation .
Expand Down Expand Up @@ -2097,7 +2097,7 @@ value behavior, see the "ZFS Administration Guide".
.Sy formD Ns | Ns Sy formKC Ns | Ns Sy formKD
.Xc
Indicates whether the file system should perform a
.Sy unicode
.Sy Unicode
normalization of file names whenever two file names are compared, and which
normalization algorithm should be used.
File names are always stored unmodified, names are normalized as part of any
Expand Down
2 changes: 1 addition & 1 deletion man/man7/zpool-features.7
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ dedup tables.
This feature will be
.Sy active
when the first deduplicated block is written after a new dedup table is created
(ie after a new pool creation, or new checksum used on a dataset with
(i.e. after a new pool creation, or new checksum used on a dataset with
.Sy dedup
enabled).
It will be returned to the
Expand Down
2 changes: 1 addition & 1 deletion man/man7/zpoolconcepts.7
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ and both pools suffer a device failure at the same time,
both could attempt to use the spare at the same time.
This may not be detected, resulting in data corruption.
.Pp
An in-progress spare replacement can be cancelled by detaching the hot spare.
An in-progress spare replacement can be canceled by detaching the hot spare.
If the original faulted device is detached, then the hot spare assumes its
place in the configuration, and is removed from the spare list of all active
pools.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zed.8.in
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Force the daemon to run if at all possible, disabling security checks and
throwing caution to the wind.
Not recommended for use in production.
.It Fl F
Don't daemonise: remain attached to the controlling terminal,
Don't daemonize: remain attached to the controlling terminal,
log to the standard I/O streams.
.It Fl M
Lock all current and future pages in the virtual memory address space.
Expand Down
8 changes: 4 additions & 4 deletions man/man8/zfs-allow.8
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ form below for details.
If neither of the
.Fl dl
options are specified, or both are, then the permissions are allowed for the
file system or volume, and all of its descendents.
file system or volume, and all of its descendants.
.Pp
Permissions are generally the ability to use a ZFS subcommand or change a ZFS
property.
Expand All @@ -205,7 +205,7 @@ diff subcommand Allows lookup of paths within a dataset given an object number,
hold subcommand Allows adding a user hold to a snapshot
load-key subcommand Allows loading and unloading of encryption key (see \fBzfs load-key\fR and \fBzfs unload-key\fR).
change-key subcommand Allows changing an encryption key via \fBzfs change-key\fR.
mount subcommand Allows mounting/umounting ZFS datasets
mount subcommand Allows mounting/unmounting ZFS datasets
promote subcommand Must also have the \fBmount\fR and \fBpromote\fR ability in the origin file system
receive subcommand Must also have the \fBmount\fR and \fBcreate\fR ability
release subcommand Allows releasing a user hold which might destroy the snapshot
Expand Down Expand Up @@ -309,7 +309,7 @@ to the creator of any newly-created descendent file system.
Defines or adds permissions to a permission set.
The set can be used by other
.Nm zfs Cm allow
commands for the specified file system and its descendents.
commands for the specified file system and its descendants.
Sets are evaluated dynamically, so changes to a set are immediately reflected.
Permission sets follow the same naming restrictions as ZFS file systems, but the
name must begin with
Expand Down Expand Up @@ -369,7 +369,7 @@ command for a description of the
options.
.Bl -tag -width "-r"
.It Fl r
Recursively remove the permissions from this file system and all descendents.
Recursively remove the permissions from this file system and all descendants.
.El
.It Xo
.Nm zfs
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-hold.8
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ listing the holds on the named snapshot.
.It Fl H
Do not print headers, use tab-delimited output.
.It Fl p
Prints holds timestamps as unix epoch timestamps.
Prints holds timestamps as Unix epoch timestamps.
.El
.It Xo
.Nm zfs
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zfs-send.8
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ hierarchy.
When a snapshot is missing, instead of throwing an error and aborting the send,
a warning is printed to the standard error stream and the dataset to which it
belongs
and its descendents are skipped.
and its descendants are skipped.
This flag can only be used in conjunction with
.Fl R .
.It Fl v , -verbose
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool-attach.8
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ is part of a two-way mirror, attaching
creates a three-way mirror, and so on.
In either case,
.Ar new_device
begins to resilver immediately and any running scrub is cancelled.
begins to resilver immediately and any running scrub is canceled.
.Pp
If the existing device is a RAID-Z device
.Pq e.g. specified as Qq Ar raidz2-0 ,
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool-events.8
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ See
.Xr zfs 4
for more details on the
.Sy zfs_vdev_direct_write_verify
module paramter.
module parameter.
.It Sy config
Issued every time a vdev change have been done to the pool.
.It Sy zpool
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool-remove.8
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ command initiates the removal and returns, while the evacuation continues in
the background.
The removal progress can be monitored with
.Nm zpool Cm status .
If an I/O error is encountered during the removal process it will be cancelled.
If an I/O error is encountered during the removal process it will be canceled.
The
.Sy device_removal
feature flag must be enabled to remove a top-level vdev, see
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool-replace.8
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This is equivalent to attaching
.Ar new-device ,
waiting for it to resilver, and then detaching
.Ar device .
Any in progress scrub will be cancelled.
Any in progress scrub will be canceled.
.Pp
The size of
.Ar new-device
Expand Down
2 changes: 1 addition & 1 deletion man/man8/zpool.8
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ The value is not used, only the presence or absence of the variable matters.
.It Sy ZPOOL_VDEV_NAME_GUID
Cause
.Nm
subcommands to output vdev guids by default.
subcommands to output vdev GUIDs by default.
This behavior is identical to the
.Nm zpool Cm status Fl g
command line option.
Expand Down
Loading