2024-02-08 16:21:05

by Vincenzo Mezzela

[permalink] [raw]
Subject: [PATCH] docs: filesystems: fix typo in docs

This patch resolves a spelling error in the filesystem documentation.

It is submitted as part of my application to the "Linux Kernel Bug
Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel
Foundation.

Signed-off-by: Vincenzo Mezzela <[email protected]>
---
Documentation/filesystems/files.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/filesystems/files.rst b/Documentation/filesystems/files.rst
index 9e38e4c221ca..eb770f891b27 100644
--- a/Documentation/filesystems/files.rst
+++ b/Documentation/filesystems/files.rst
@@ -116,7 +116,7 @@ before and after the reference count increment. This pattern can be seen
in get_file_rcu() and __files_get_rcu().

In addition, it isn't possible to access or check fields in struct file
-without first aqcuiring a reference on it under rcu lookup. Not doing
+without first acquiring a reference on it under rcu lookup. Not doing
that was always very dodgy and it was only usable for non-pointer data
in struct file. With SLAB_TYPESAFE_BY_RCU it is necessary that callers
either first acquire a reference or they must hold the files_lock of the
--
2.34.1



2024-02-09 09:40:09

by Christian Brauner

[permalink] [raw]
Subject: Re: [PATCH] docs: filesystems: fix typo in docs

On Thu, 08 Feb 2024 17:20:32 +0100, Vincenzo Mezzela wrote:
> This patch resolves a spelling error in the filesystem documentation.
>
> It is submitted as part of my application to the "Linux Kernel Bug
> Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel
> Foundation.
>
>
> [...]

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] docs: filesystems: fix typo in docs
https://git.kernel.org/vfs/vfs/c/f1d1f00279f6

2024-02-09 09:44:45

by Christian Brauner

[permalink] [raw]
Subject: Re: [PATCH] docs: filesystems: fix typo in docs

On Thu, Feb 08, 2024 at 05:20:32PM +0100, Vincenzo Mezzela wrote:
> This patch resolves a spelling error in the filesystem documentation.
>
> It is submitted as part of my application to the "Linux Kernel Bug
> Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel
> Foundation.
>
> Signed-off-by: Vincenzo Mezzela <[email protected]>
> ---
> Documentation/filesystems/files.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/filesystems/files.rst b/Documentation/filesystems/files.rst
> index 9e38e4c221ca..eb770f891b27 100644
> --- a/Documentation/filesystems/files.rst
> +++ b/Documentation/filesystems/files.rst
> @@ -116,7 +116,7 @@ before and after the reference count increment. This pattern can be seen
> in get_file_rcu() and __files_get_rcu().
>
> In addition, it isn't possible to access or check fields in struct file
> -without first aqcuiring a reference on it under rcu lookup. Not doing
> +without first acquiring a reference on it under rcu lookup. Not doing

I stared at this for way too long to figure out that there's actually a
spelling mistake in there. Thanks! I've snagged it. Jon, let me know if
you prefer to take it.

2024-02-09 14:22:40

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] docs: filesystems: fix typo in docs

Christian Brauner <[email protected]> writes:

> On Thu, Feb 08, 2024 at 05:20:32PM +0100, Vincenzo Mezzela wrote:
>> This patch resolves a spelling error in the filesystem documentation.
>>
>> It is submitted as part of my application to the "Linux Kernel Bug
>> Fixing Spring Unpaid 2024" mentorship program of the Linux Kernel
>> Foundation.
>>
>> Signed-off-by: Vincenzo Mezzela <[email protected]>
>> ---
>> Documentation/filesystems/files.rst | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/filesystems/files.rst b/Documentation/filesystems/files.rst
>> index 9e38e4c221ca..eb770f891b27 100644
>> --- a/Documentation/filesystems/files.rst
>> +++ b/Documentation/filesystems/files.rst
>> @@ -116,7 +116,7 @@ before and after the reference count increment. This pattern can be seen
>> in get_file_rcu() and __files_get_rcu().
>>
>> In addition, it isn't possible to access or check fields in struct file
>> -without first aqcuiring a reference on it under rcu lookup. Not doing
>> +without first acquiring a reference on it under rcu lookup. Not doing
>
> I stared at this for way too long to figure out that there's actually a
> spelling mistake in there. Thanks! I've snagged it. Jon, let me know if
> you prefer to take it.

I'd applied it too - sorry, he sent two and I replied once to the other
one, which you didn't get. I can drop my copy.

Thanks,

jon