diff mbox series

man5/tmpfs.5: fix typo in reference to CONFIG_TRANSPARENT_HUGEPAGE

Message ID 20230719020533.1608867-1-jhubbard@nvidia.com (mailing list archive)
State New
Headers show
Series man5/tmpfs.5: fix typo in reference to CONFIG_TRANSPARENT_HUGEPAGE | expand

Commit Message

John Hubbard July 19, 2023, 2:05 a.m. UTC 
In commit 462a385e9a2 ("tmpfs.5: Document current mount options"), there
is a reference to CONFIG_TRANSPARENT_HUGE_PAGECACHE. However, that
option was removed from the kernel via commit 396bcc5299c2 ("mm: remove
CONFIG_TRANSPARENT_HUGE_PAGECACHE"), a couple of years later.

The net effect is that CONFIG_TRANSPARENT_HUGEPAGE is now used in all
the remaining places in the kernel where
CONFIG_TRANSPARENT_HUGE_PAGECACHE had previously been used.

This has caused some minor confusion at the man page level, though. So
let's fix it by updating the man page to also refer to
CONFIG_TRANSPARENT_HUGEPAGE.

Reported-by: Vahid Noormofidi <vnoormof@nvidia.com>
Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Carsten Grohmann <carstengrohmann@gmx.de>
Cc: Signed-off-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: John Hubbard <jhubbard@nvidia.com>
---
 man5/tmpfs.5 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: c654cde5ec9e9fa975d5d041aa069489ab12a4ce

Comments

Alejandro Colomar July 19, 2023, 7:59 p.m. UTC | #1 
On 2023-07-19 04:05, John Hubbard wrote:
> In commit 462a385e9a2 ("tmpfs.5: Document current mount options"), there
> is a reference to CONFIG_TRANSPARENT_HUGE_PAGECACHE. However, that
> option was removed from the kernel via commit 396bcc5299c2 ("mm: remove
> CONFIG_TRANSPARENT_HUGE_PAGECACHE"), a couple of years later.
> 
> The net effect is that CONFIG_TRANSPARENT_HUGEPAGE is now used in all
> the remaining places in the kernel where
> CONFIG_TRANSPARENT_HUGE_PAGECACHE had previously been used.
> 
> This has caused some minor confusion at the man page level, though. So
> let's fix it by updating the man page to also refer to
> CONFIG_TRANSPARENT_HUGEPAGE.
> 
> Reported-by: Vahid Noormofidi <vnoormof@nvidia.com>
> Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
> Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Carsten Grohmann <carstengrohmann@gmx.de>
> Cc: Signed-off-by: Mike Frysinger <vapier@gentoo.org>

Accident here :-)

> Signed-off-by: John Hubbard <jhubbard@nvidia.com>
> ---
>  man5/tmpfs.5 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man5/tmpfs.5 b/man5/tmpfs.5
> index 09d955898..cdd5f2fd8 100644
> --- a/man5/tmpfs.5
> +++ b/man5/tmpfs.5
> @@ -115,7 +115,7 @@ Set the initial user ID of the root directory.
>  .BR huge "=\fIhuge_option\fR (since Linux 4.7.0)"
>  .\" commit 5a6e75f8110c97e2a5488894d4e922187e6cb343
>  Set the huge table memory allocation policy for all files in this instance (if
> -.B CONFIG_TRANSPARENT_HUGE_PAGECACHE
> +.B CONFIG_TRANSPARENT_HUGEPAGE
>  is enabled).
>  .IP
>  The
> 
> base-commit: c654cde5ec9e9fa975d5d041aa069489ab12a4ce
John Hubbard July 19, 2023, 8:13 p.m. UTC | #2 
On 7/19/23 12:59, Alejandro Colomar wrote:
> On 2023-07-19 04:05, John Hubbard wrote:
>> In commit 462a385e9a2 ("tmpfs.5: Document current mount options"), there
>> is a reference to CONFIG_TRANSPARENT_HUGE_PAGECACHE. However, that
>> option was removed from the kernel via commit 396bcc5299c2 ("mm: remove
>> CONFIG_TRANSPARENT_HUGE_PAGECACHE"), a couple of years later.
>>
>> The net effect is that CONFIG_TRANSPARENT_HUGEPAGE is now used in all
>> the remaining places in the kernel where
>> CONFIG_TRANSPARENT_HUGE_PAGECACHE had previously been used.
>>
>> This has caused some minor confusion at the man page level, though. So
>> let's fix it by updating the man page to also refer to
>> CONFIG_TRANSPARENT_HUGEPAGE.
>>
>> Reported-by: Vahid Noormofidi <vnoormof@nvidia.com>
>> Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
>> Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
>> Cc: Andrew Morton <akpm@linux-foundation.org>
>> Cc: Carsten Grohmann <carstengrohmann@gmx.de>
>> Cc: Signed-off-by: Mike Frysinger <vapier@gentoo.org>
> 
> Accident here :-)
> 

Yes. :)  Michael Kerrisk, could you change that line for me
to just be a Cc, for Mike Frysinger?

Or, let me know if you'd prefer a re-send of the patch instead.


thanks,
Alejandro Colomar July 20, 2023, 8:03 a.m. UTC | #3 
Hi John,

On 2023-07-19 22:13, John Hubbard wrote:
> On 7/19/23 12:59, Alejandro Colomar wrote:
>> On 2023-07-19 04:05, John Hubbard wrote:
>>> In commit 462a385e9a2 ("tmpfs.5: Document current mount options"), there
>>> is a reference to CONFIG_TRANSPARENT_HUGE_PAGECACHE. However, that
>>> option was removed from the kernel via commit 396bcc5299c2 ("mm: remove
>>> CONFIG_TRANSPARENT_HUGE_PAGECACHE"), a couple of years later.
>>>
>>> The net effect is that CONFIG_TRANSPARENT_HUGEPAGE is now used in all
>>> the remaining places in the kernel where
>>> CONFIG_TRANSPARENT_HUGE_PAGECACHE had previously been used.
>>>
>>> This has caused some minor confusion at the man page level, though. So
>>> let's fix it by updating the man page to also refer to
>>> CONFIG_TRANSPARENT_HUGEPAGE.
>>>
>>> Reported-by: Vahid Noormofidi <vnoormof@nvidia.com>
>>> Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
>>> Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
>>> Cc: Andrew Morton <akpm@linux-foundation.org>
>>> Cc: Carsten Grohmann <carstengrohmann@gmx.de>
>>> Cc: Signed-off-by: Mike Frysinger <vapier@gentoo.org>
>>
>> Accident here :-)
>>
> 
> Yes. :)  Michael Kerrisk, could you change that line for me
> to just be a Cc, for Mike Frysinger?
> 
> Or, let me know if you'd prefer a re-send of the patch instead.

I can change it.  Don't worry.  I'll review it later.

Thanks,
Alex

> 
> 
> thanks,
Alejandro Colomar July 28, 2023, 7:04 p.m. UTC | #4 
Hi John,

On 2023-07-20 10:03, Alejandro Colomar wrote:
> Hi John,
> 
> On 2023-07-19 22:13, John Hubbard wrote:
>> On 7/19/23 12:59, Alejandro Colomar wrote:
>>> On 2023-07-19 04:05, John Hubbard wrote:
>>>> In commit 462a385e9a2 ("tmpfs.5: Document current mount options"), there
>>>> is a reference to CONFIG_TRANSPARENT_HUGE_PAGECACHE. However, that
>>>> option was removed from the kernel via commit 396bcc5299c2 ("mm: remove
>>>> CONFIG_TRANSPARENT_HUGE_PAGECACHE"), a couple of years later.
>>>>
>>>> The net effect is that CONFIG_TRANSPARENT_HUGEPAGE is now used in all
>>>> the remaining places in the kernel where
>>>> CONFIG_TRANSPARENT_HUGE_PAGECACHE had previously been used.
>>>>
>>>> This has caused some minor confusion at the man page level, though. So
>>>> let's fix it by updating the man page to also refer to
>>>> CONFIG_TRANSPARENT_HUGEPAGE.
>>>>
>>>> Reported-by: Vahid Noormofidi <vnoormof@nvidia.com>
>>>> Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
>>>> Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
>>>> Cc: Andrew Morton <akpm@linux-foundation.org>
>>>> Cc: Carsten Grohmann <carstengrohmann@gmx.de>
>>>> Cc: Signed-off-by: Mike Frysinger <vapier@gentoo.org>
>>>
>>> Accident here :-)
>>>
>>
>> Yes. :)  Michael Kerrisk, could you change that line for me
>> to just be a Cc, for Mike Frysinger?
>>
>> Or, let me know if you'd prefer a re-send of the patch instead.
> 
> I can change it.  Don't worry.  I'll review it later.

Patch applied.  Thanks!
I've slightly reworded the commit message:

-  Use tmpfs.5: instead of man5/tmpfs.5:.  We only specify the last
   filename in the path (see the git log).

-  It really wasn't a typo, because the previous text was written in
   a time when that was the correct spelling.  So, instead, I've
   changed it to talk about an update, rather than a typo fix.

<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/?id=80e3024bde68ee3fa55cfd87728b81f94ec931df>

Cheers,
Alex

> 
> Thanks,
> Alex
> 
>>
>>
>> thanks,
>
John Hubbard July 28, 2023, 7:18 p.m. UTC | #5 
On 7/28/23 12:04, Alejandro Colomar wrote:
...
> I've slightly reworded the commit message:
> 
> -  Use tmpfs.5: instead of man5/tmpfs.5:.  We only specify the last
>     filename in the path (see the git log).
> 
> -  It really wasn't a typo, because the previous text was written in
>     a time when that was the correct spelling.  So, instead, I've
>     changed it to talk about an update, rather than a typo fix.
> 

Oh yes, thanks for fixing that up! That's perfect.

I wrote the subject line early on, when I initially thought it was a
typo. After looking more closely it became clear what happened, but I
failed to update the subject line accordingly, so I really appreciate
that you caught it.


thanks,
diff mbox series

Patch

diff --git a/man5/tmpfs.5 b/man5/tmpfs.5
index 09d955898..cdd5f2fd8 100644
--- a/man5/tmpfs.5
+++ b/man5/tmpfs.5
@@ -115,7 +115,7 @@  Set the initial user ID of the root directory.
 .BR huge "=\fIhuge_option\fR (since Linux 4.7.0)"
 .\" commit 5a6e75f8110c97e2a5488894d4e922187e6cb343
 Set the huge table memory allocation policy for all files in this instance (if
-.B CONFIG_TRANSPARENT_HUGE_PAGECACHE
+.B CONFIG_TRANSPARENT_HUGEPAGE
 is enabled).
 .IP
 The