]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: correct mistaken uses of "overwrite" to say "override" instead
authorBenno Schulenberg <bensberg@telfort.nl>
Thu, 17 Apr 2025 09:48:24 +0000 (11:48 +0200)
committerKarel Zak <kzak@redhat.com>
Thu, 24 Apr 2025 09:51:45 +0000 (11:51 +0200)
This mostly comes down to harmonizing the wording and markup of the
various --lock options.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
12 files changed:
disk-utils/cfdisk.8.adoc
disk-utils/fdisk.8.adoc
disk-utils/mkfs.bfs.8.adoc
disk-utils/mkfs.cramfs.8.adoc
disk-utils/mkfs.minix.8.adoc
disk-utils/mkswap.8.adoc
disk-utils/sfdisk.8.adoc
misc-utils/logger.1.adoc
misc-utils/wipefs.8.adoc
sys-utils/hwclock.8.adoc
sys-utils/losetup.8.adoc
sys-utils/mount.8.adoc

index 0075fd472fd8a7f8cdd2fee728497243d6fb3e0e..121d023ab6e266d2684c21fef49805e79703c4b5 100644 (file)
@@ -48,7 +48,12 @@ If you want to remove an old partition table from a device, use *wipefs*(8).
 Colorize the output. The optional argument _when_ can be *auto*, *never* or *always*. If the _when_ argument is omitted, it defaults to *auto*. The colors can be disabled, for the current built-in default see *--help* output. See also the *COLORS* section.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-r*, *--read-only*::
 Forced open in read-only mode.
index c18c382730d23ebd50dfb8bfc1c41ec211305032..13e7147bb727ded3097f2a15c04de645cd3a9aa3 100644 (file)
@@ -60,7 +60,12 @@ If no devices are given, the devices mentioned in _/proc/partitions_ (if this fi
 Like *--list*, but provides more details.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-n*, *--noauto-pt*::
 Don't automatically create a default partition table on empty device. The partition table has to be explicitly created by user (by command like 'o', 'g', etc.).
index 248013731e2e39f8c32f688b803219e399478256..e66f8e0b588e990c17cc51531c205d63abdf6bbc 100644 (file)
@@ -36,7 +36,12 @@ Specify the volume _label_. I have no idea if/where this is used.
 Specify the filesystem _name_. I have no idea if/where this is used.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-v*, *--verbose*::
 Explain what is being done.
index 8a2c4a79ed14379ca0f0da759c224123177039bd..bca5e8f624d15eb1199f02fcf058963b2a7b8ab5 100644 (file)
@@ -67,8 +67,8 @@ Use an exclusive BSD lock for the device or file that is operated upon.
 The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
 If the _mode_ argument is omitted, it defaults to *yes*.
 This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
-The default is to not use any lock at all, but using a lock
-is recommended to avoid collisions with udevd or other tools.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 include::man-common/help-version.adoc[]
 
index 4b8426f3eea5035c1a630fae34842f3e2c88e191..f747ee40f30a52a7bb3cd8f97206223a1f28d885 100644 (file)
@@ -47,7 +47,12 @@ Check the device for bad blocks before creating the filesystem. If any are found
 Specify the maximum length of filenames. Currently, the only allowable values are 14 and 30 for file system versions 1 and 2. Version 3 allows only value 60. The default is 30.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-i*, *--inodes* _number_::
 Specify the number of inodes for the filesystem.
index 974a5af4e2102d7b493b10d03dc92fe9fa7f09a8..a7838ae9197f3c2a627954f09d972a82378b2685 100644 (file)
@@ -58,7 +58,12 @@ Suppress output and warning messages.
 Specify a _label_ for the device, to allow *swapon*(8) by label.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-p*, *--pagesize* _size_::
 Specify the page _size_ (in bytes) to use. This option is usually unnecessary; *mkswap* reads the size from the kernel.
index 1ffc61588370539f78ee9ce56389d365e4ed5373..ac81ec93983b74563c36949f69394055e1ec26d3 100644 (file)
@@ -165,7 +165,12 @@ Disable all consistency checking.
 Deprecated and ignored option. Partitioning that is compatible with Linux (and other modern operating systems) is the default.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-n*, *--no-act*::
 Do everything except writing to the device.
index 0c4edbeac48d1306853417efbd77b2477418f42d..e63f5eff85fe8653640c08f1440925d4e7a618af 100644 (file)
@@ -73,7 +73,7 @@ Log the PID of the *logger* process with each line.
 *--id*[**=**__id__]::
 Log the PID of the *logger* process with each line. When the optional argument _id_ is specified, then it is used instead of the *logger* command's PID. The use of *--id=$$* (PPID) is recommended in scripts that send several messages.
 +
-Note that the system logging infrastructure (for example *systemd* when listening on _/dev/log_) may follow local socket credentials to overwrite the PID specified in the message. *logger*(1) is able to set those socket credentials to the given _id_, but only if you have root permissions and a process with the specified PID exists, otherwise the socket credentials are not modified and the problem is silently ignored.
+Note that the system logging infrastructure (for example *systemd* when listening on _/dev/log_) may follow local socket credentials to override the PID specified in the message. *logger*(1) is able to set those socket credentials to the given _id_, but only if you have root permissions and a process with the specified PID exists, otherwise the socket credentials are not modified and the problem is silently ignored.
 
 *--journald*[**=**__file__]::
 Write a *systemd* journal entry. The entry is read from the given _file_, when specified, otherwise from standard input. Each line must begin with a field that is accepted by *journald*; see *systemd.journal-fields*(7) for details. The use of a MESSAGE_ID field is generally a good idea, as it makes finding entries easy. Examples:
index 88efaeca5b318a78eb5f3e45bb7b60937890b934..5226ea8b4bb5acc62088068e4d6e4398b5c50e9e 100644 (file)
@@ -50,7 +50,12 @@ Force erasure, even if the filesystem is mounted. This is required in order to e
 Use JSON output format.
 
 *--lock*[**=**_mode_]::
-Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *"yes"*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with udevd or other tools.
+Use an exclusive BSD lock for the device or file that is operated upon.
+The optional argument _mode_ can be *yes* (*1*), *no* (*0*), or *nonblock*.
+If the _mode_ argument is omitted, it defaults to *yes*.
+This option overrides the environment variable *$LOCK_BLOCK_DEVICE*.
+The default is to not use any lock at all, but using a lock is recommended
+to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-i*, *--noheadings*::
 Do not print a header line.
index e30fb5e90a6486869d608398a7193e30d90a5255..3ad02054f3bd186bc9bca176b237d4b8fd6e1751 100644 (file)
@@ -124,9 +124,17 @@ This option must be used with the *--set* or *--predict* functions, otherwise it
 The argument must be in local time, even if you keep your Hardware Clock in UTC. See the *--localtime* option. Therefore, the argument should not include any timezone information. It also should not be a relative time like "+5 minutes", because *hwclock*'s precision depends upon correlation between the argument's value and when the enter key is pressed. Fractional seconds are silently dropped. This option is capable of understanding many time and date formats, but the previous parameters should be observed.
 
 **--delay=**__seconds__::
-This option can be used to overwrite the internally used delay when setting the clock time. The default is 0.5 (500ms) for rtc_cmos, for another RTC types the delay is 0. If RTC type is impossible to determine (from sysfs) then it defaults also to 0.5 to be backwardly compatible.
-+
-The 500ms default is based on commonly used MC146818A-compatible (x86) hardware clock. This Hardware Clock can only be set to any integer time plus one half second. The integer time is required because there is no interface to set or get a fractional second. The additional half second delay is because the Hardware Clock updates to the following second precisely 500 ms after setting the new time. Unfortunately, this behavior is hardware specific and in some cases another delay is required.
+This option overrides the default delay used when setting the clock time.
+The default is *0.5* (500 ms) for rtc_cmos; for other RTC types the delay is *0*.
+If the RTC type cannot be determined (from sysfs), then the delay defaults
+also to *0.5* to be backwardly compatible.
++
+The 500 ms default is based on the commonly used MC146818A-compatible (x86) hardware clock.
+This Hardware Clock can only be set to an integer time plus one half second.
+The integer time is required because there is no interface to get or set a fractional second.
+The additional half second is because the Hardware Clock updates to the following second
+precisely 500 ms after setting the new time. Unfortunately, this behavior is hardware specific
+and in some cases a different delay is required.
 
 *-D*, *--debug*::
 Use *--verbose*. The *--debug* option has been deprecated and may be repurposed or removed in a future release.
index e549ddf1a5d478c2612fef82703957a7cfcd1150..48d71ec185990e18317d94df5327ed7b30649a0e 100644 (file)
@@ -42,7 +42,9 @@ Resize a loop device:
 
 Note that the old output format (i.e., *losetup -a*) with comma-delimited strings is deprecated in favour of the *--list* output format.
 
-It's possible to create more independent loop devices for the same backing file. *This setup may be dangerous, can cause data loss, corruption and overwrites.* Use *--nooverlap* with *--find* during setup to avoid this problem.
+It is possible to create multiple independent loop devices for the same backing file.
+*This setup may be dangerous, can cause data loss, corruption, and overwrites.*
+Use *--nooverlap* with *--find* during setup to avoid this problem.
 
 The loop device setup is not an atomic operation when used with *--find*, and *losetup* does not protect this operation by any lock. The number of attempts is internally restricted to a maximum of 16. It is recommended to use for example *flock*(1) to avoid a collision in heavily parallel use cases.
 
@@ -75,7 +77,12 @@ Show the status of all loop devices associated with the given _file_.
 The data start is moved _offset_ bytes into the specified file or device. The _offset_ may be followed by the multiplicative suffixes; see above.
 
 *--loop-ref* _string_::
-Set reference string. The backwardly compatible default is to use the backing filename as a reference in loop setup ioctl (aka lo_file_name). This option can overwrite this default behavior and set the reference to the _string_. The reference may be used by udevd in /dev/loop/by-ref. Linux kernel does not use the reference at all, but it could be used by some old utils that cannot read the backing file from sysfs. The reference is readable only for the root user (see *--output* +REF) and it is restricted to 64 bytes.
+Set the reference string. The backwardly compatible default is to use the backing filename
+as a reference in the loop setup ioctl (aka lo_file_name). This option overrides this default
+behavior and sets the reference to the _string_. The reference may be used by udevd in
+/dev/loop/by-ref. The Linux kernel does not use the reference at all, but it could be used
+by some old utils that cannot read the backing file from sysfs. The reference is readable
+only for the root user (see *--output* +REF) and it is restricted to 64 bytes.
 
 *--sizelimit* _size_::
 The data end is set to no more than _size_ bytes after the data start. The _size_ may be followed by the multiplicative suffixes; see above.
index 3f2b1967a808f2c5ceb401e9f9e8dcf8f3d11e01..f4f8669de5eda50c02372ea29d154d692f9282be 100644 (file)
@@ -385,7 +385,8 @@ Use the specified mount options. The _opts_ argument is a comma-separated list.
 +
 *mount LABEL=mydisk -o noatime,nodev,nosuid*
 +
-Note that the order of the options matters, as the last option wins if there are conflicting ones. The options from the command line also overwrite options from fstab by default.
+Note that the order of the options matters, as the last option wins if there are conflicting ones.
+Also, options on the command line override options from fstab.
 +
 For more details, see the *FILESYSTEM-INDEPENDENT MOUNT OPTIONS* and *FILESYSTEM-SPECIFIC MOUNT OPTIONS* sections.