Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

overlayfs.rst: fix typos

Grammatical fixes

Signed-off-by: Matthias Frank <frank.mt125@gmail.com>
Acked-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250710050607.2891-1-frank.mt125@gmail.com

authored by

Matthias Frank and committed by
Jonathan Corbet
2afcd629 f587722a

+12 -12
+12 -12
Documentation/filesystems/overlayfs.rst
··· 9 9 This document describes a prototype for a new approach to providing 10 10 overlay-filesystem functionality in Linux (sometimes referred to as 11 11 union-filesystems). An overlay-filesystem tries to present a 12 - filesystem which is the result over overlaying one filesystem on top 12 + filesystem which is the result of overlaying one filesystem on top 13 13 of the other. 14 14 15 15 ··· 425 425 The "lower data" file can be on any lower layer, except from the top most 426 426 lower layer. 427 427 428 - Below the top most lower layer, any number of lower most layers may be defined 428 + Below the topmost lower layer, any number of lowermost layers may be defined 429 429 as "data-only" lower layers, using double colon ("::") separators. 430 430 A normal lower layer is not allowed to be below a data-only layer, so single 431 431 colon separators are not allowed to the right of double colon ("::") separators. ··· 445 445 446 446 Instead of explicitly enabling "metacopy=on" it is sufficient to specify at 447 447 least one data-only layer to enable redirection of data to a data-only layer. 448 - In this case other forms of metacopy are rejected. Note: this way data-only 449 - layers may be used toghether with "userxattr", in which case careful attention 448 + In this case other forms of metacopy are rejected. Note: this way, data-only 449 + layers may be used together with "userxattr", in which case careful attention 450 450 must be given to privileges needed to change the "user.overlay.redirect" xattr 451 451 to prevent misuse. 452 452 ··· 515 515 The metacopy digest is never generated or used. This is the 516 516 default if verity option is not specified. 517 517 - "on": 518 - Whenever a metacopy files specifies an expected digest, the 518 + Whenever a metacopy file specifies an expected digest, the 519 519 corresponding data file must match the specified digest. When 520 520 generating a metacopy file the verity digest will be set in it 521 521 based on the source file (if it has one). ··· 537 537 another overlay mount is not allowed and may fail with EBUSY. Using 538 538 partially overlapping paths is not allowed and may fail with EBUSY. 539 539 If files are accessed from two overlayfs mounts which share or overlap the 540 - upper layer and/or workdir path the behavior of the overlay is undefined, 540 + upper layer and/or workdir path, the behavior of the overlay is undefined, 541 541 though it will not result in a crash or deadlock. 542 542 543 543 Mounting an overlay using an upper layer path, where the upper layer path ··· 778 778 - "auto": (default) 779 779 UUID is taken from xattr "trusted.overlay.uuid" if it exists. 780 780 Upgrade to "uuid=on" on first time mount of new overlay filesystem that 781 - meets the prerequites. 781 + meets the prerequisites. 782 782 Downgrade to "uuid=null" for existing overlay filesystems that were never 783 783 mounted with "uuid=on". 784 784 ··· 794 794 The advantage of mounting with the "volatile" option is that all forms of 795 795 sync calls to the upper filesystem are omitted. 796 796 797 - In order to avoid a giving a false sense of safety, the syncfs (and fsync) 797 + In order to avoid giving a false sense of safety, the syncfs (and fsync) 798 798 semantics of volatile mounts are slightly different than that of the rest of 799 799 VFS. If any writeback error occurs on the upperdir's filesystem after a 800 800 volatile mount takes place, all sync functions will return an error. Once this 801 801 condition is reached, the filesystem will not recover, and every subsequent sync 802 - call will return an error, even if the upperdir has not experience a new error 802 + call will return an error, even if the upperdir has not experienced a new error 803 803 since the last sync call. 804 804 805 805 When overlay is mounted with "volatile" option, the directory 806 806 "$workdir/work/incompat/volatile" is created. During next mount, overlay 807 807 checks for this directory and refuses to mount if present. This is a strong 808 - indicator that user should throw away upper and work directories and create 809 - fresh one. In very limited cases where the user knows that the system has 810 - not crashed and contents of upperdir are intact, The "volatile" directory 808 + indicator that the user should discard upper and work directories and create 809 + fresh ones. In very limited cases where the user knows that the system has 810 + not crashed and contents of upperdir are intact, the "volatile" directory 811 811 can be removed. 812 812 813 813