[PATCH] overlayfs.rst: Fix and improve grammar

[PATCH] overlayfs.rst: Fix and improve grammar

[Geert Uytterhoeven]

  - Correct "in a way the" to "in a way that",
  - Add a comma to improve readability.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/filesystems/overlayfs.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/filesystems/overlayfs.rst b/Documentation/filesystems/overlayfs.rst
index 4c8387e1c88068fa..a93dddeae199491a 100644
--- a/Documentation/filesystems/overlayfs.rst
+++ b/Documentation/filesystems/overlayfs.rst
@@ -266,7 +266,7 @@ Non-directories
 Objects that are not directories (files, symlinks, device-special
 files etc.) are presented either from the upper or lower filesystem as
 appropriate.  When a file in the lower filesystem is accessed in a way
-the requires write-access, such as opening for write access, changing
+that requires write-access, such as opening for write access, changing
 some metadata etc., the file is first copied from the lower filesystem
 to the upper filesystem (copy_up).  Note that creating a hard-link
 also requires copy_up, though of course creation of a symlink does
@@ -549,8 +549,8 @@ Nesting overlayfs mounts
 
 It is possible to use a lower directory that is stored on an overlayfs
 mount. For regular files this does not need any special care. However, files
-that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs will be
-interpreted by the underlying overlayfs mount and stripped out. In order to
+that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs, will
+be interpreted by the underlying overlayfs mount and stripped out. In order to
 allow the second overlayfs mount to see the attributes they must be escaped.
 
 Overlayfs specific xattrs are escaped by using a special prefix of
-- 
2.43.0

Re: [PATCH] overlayfs.rst: Fix and improve grammar

[Amir Goldstein]

On Tue, Jan 7, 2025 at 9:45 AM Geert Uytterhoeven
<geert+renesas@glider.be> wrote:
>
>   - Correct "in a way the" to "in a way that",
>   - Add a comma to improve readability.
>
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Acked-by: Amir Goldstein <amir73il@gmail.com>

John,

Please take this patch via the documentation tree,
as I have no overlayfs patches queued for v6.14.

Thanks,
Amir.

> ---
>  Documentation/filesystems/overlayfs.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/filesystems/overlayfs.rst b/Documentation/filesystems/overlayfs.rst
> index 4c8387e1c88068fa..a93dddeae199491a 100644
> --- a/Documentation/filesystems/overlayfs.rst
> +++ b/Documentation/filesystems/overlayfs.rst
> @@ -266,7 +266,7 @@ Non-directories
>  Objects that are not directories (files, symlinks, device-special
>  files etc.) are presented either from the upper or lower filesystem as
>  appropriate.  When a file in the lower filesystem is accessed in a way
> -the requires write-access, such as opening for write access, changing
> +that requires write-access, such as opening for write access, changing
>  some metadata etc., the file is first copied from the lower filesystem
>  to the upper filesystem (copy_up).  Note that creating a hard-link
>  also requires copy_up, though of course creation of a symlink does
> @@ -549,8 +549,8 @@ Nesting overlayfs mounts
>
>  It is possible to use a lower directory that is stored on an overlayfs
>  mount. For regular files this does not need any special care. However, files
> -that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs will be
> -interpreted by the underlying overlayfs mount and stripped out. In order to
> +that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs, will
> +be interpreted by the underlying overlayfs mount and stripped out. In order to
>  allow the second overlayfs mount to see the attributes they must be escaped.
>
>  Overlayfs specific xattrs are escaped by using a special prefix of
> --
> 2.43.0
>
>

Re: [PATCH] overlayfs.rst: Fix and improve grammar

[Randy Dunlap]

On 1/7/25 12:44 AM, Geert Uytterhoeven wrote:
>   - Correct "in a way the" to "in a way that",
>   - Add a comma to improve readability.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/filesystems/overlayfs.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/filesystems/overlayfs.rst b/Documentation/filesystems/overlayfs.rst
> index 4c8387e1c88068fa..a93dddeae199491a 100644
> --- a/Documentation/filesystems/overlayfs.rst
> +++ b/Documentation/filesystems/overlayfs.rst
> @@ -266,7 +266,7 @@ Non-directories
>  Objects that are not directories (files, symlinks, device-special
>  files etc.) are presented either from the upper or lower filesystem as
>  appropriate.  When a file in the lower filesystem is accessed in a way
> -the requires write-access, such as opening for write access, changing
> +that requires write-access, such as opening for write access, changing
>  some metadata etc., the file is first copied from the lower filesystem
>  to the upper filesystem (copy_up).  Note that creating a hard-link
>  also requires copy_up, though of course creation of a symlink does
> @@ -549,8 +549,8 @@ Nesting overlayfs mounts
>  
>  It is possible to use a lower directory that is stored on an overlayfs
>  mount. For regular files this does not need any special care. However, files
> -that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs will be
> -interpreted by the underlying overlayfs mount and stripped out. In order to
> +that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs, will
> +be interpreted by the underlying overlayfs mount and stripped out. In order to
>  allow the second overlayfs mount to see the attributes they must be escaped.
>  
>  Overlayfs specific xattrs are escaped by using a special prefix of

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

-- 
~Randy

Re: [PATCH] overlayfs.rst: Fix and improve grammar

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1774 bytes --]

On Tue, Jan 07, 2025 at 09:44:28AM +0100, Geert Uytterhoeven wrote:
> diff --git a/Documentation/filesystems/overlayfs.rst b/Documentation/filesystems/overlayfs.rst
> index 4c8387e1c88068fa..a93dddeae199491a 100644
> --- a/Documentation/filesystems/overlayfs.rst
> +++ b/Documentation/filesystems/overlayfs.rst
> @@ -266,7 +266,7 @@ Non-directories
>  Objects that are not directories (files, symlinks, device-special
>  files etc.) are presented either from the upper or lower filesystem as
>  appropriate.  When a file in the lower filesystem is accessed in a way
> -the requires write-access, such as opening for write access, changing
> +that requires write-access, such as opening for write access, changing
>  some metadata etc., the file is first copied from the lower filesystem
>  to the upper filesystem (copy_up).  Note that creating a hard-link
>  also requires copy_up, though of course creation of a symlink does
> @@ -549,8 +549,8 @@ Nesting overlayfs mounts
>  
>  It is possible to use a lower directory that is stored on an overlayfs
>  mount. For regular files this does not need any special care. However, files
> -that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs will be
> -interpreted by the underlying overlayfs mount and stripped out. In order to
> +that have overlayfs attributes, such as whiteouts or "overlay.*" xattrs, will
> +be interpreted by the underlying overlayfs mount and stripped out. In order to
>  allow the second overlayfs mount to see the attributes they must be escaped.
>  
>  Overlayfs specific xattrs are escaped by using a special prefix of

Looks good, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] overlayfs.rst: Fix and improve grammar

[Jonathan Corbet]

Amir Goldstein <amir73il@gmail.com> writes:

> On Tue, Jan 7, 2025 at 9:45 AM Geert Uytterhoeven
> <geert+renesas@glider.be> wrote:
>>
>>   - Correct "in a way the" to "in a way that",
>>   - Add a comma to improve readability.
>>
>> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
>
> Acked-by: Amir Goldstein <amir73il@gmail.com>
>
> John,
>
> Please take this patch via the documentation tree,
> as I have no overlayfs patches queued for v6.14.

OK, applied, thanks.

jon