Skip to contentSkip to conversation

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

PATCH In review John Hubbard 3 participants 6 messages Jul 19, 2023 – Jul 28, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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

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.

Cc Matthew Wilcox (Oracle) <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Carsten Grohmann <[email protected]>
Cc Signed-off-by: Mike Frysinger <[email protected]>
---
 man5/tmpfs.5 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man5/tmpfs.5 +1 -1
index 09d955898..cdd5f2fd8 100644
@@ -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

Signature · 1 line
2.41.0
#1 lore raw
Quoted 13 lines · John Hubbard

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.

Quoted 6 lines
Cc Matthew Wilcox (Oracle) <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Carsten Grohmann <[email protected]>
Cc Signed-off-by: Mike Frysinger <[email protected]>

Accident here :-)

Quoted 20 lines
---
 man5/tmpfs.5 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man5/tmpfs.5 +1 -1
index 09d955898..cdd5f2fd8 100644
@@ -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

Signature · 2 lines
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5
#2 lore raw
Quoted 14 lines · Alejandro Colomar
Quoted 13 lines · John Hubbard

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.

Quoted 9 lines
Quoted 6 lines
Cc Matthew Wilcox (Oracle) <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Carsten Grohmann <[email protected]>
Cc Signed-off-by: Mike Frysinger <[email protected]>

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,

Signature · 2 lines
John Hubbard
NVIDIA
Quoted 21 lines
Quoted 20 lines
---
  man5/tmpfs.5 | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
man5/tmpfs.5 +1 -1
index 09d955898..cdd5f2fd8 100644
@@ -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

#3 lore raw

Hi John,

Quoted 22 lines · John Hubbard
Quoted 21 lines · Alejandro Colomar
Quoted 19 lines · John Hubbard

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.

Cc Matthew Wilcox (Oracle) <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Carsten Grohmann <[email protected]>
Cc Signed-off-by: Mike Frysinger <[email protected]>
Quoted 7 lines
Quoted 2 lines

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

Quoted 3 lines

thanks,

Signature · 2 lines
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5
#4 lore raw

Hi John,

Quoted 28 lines · Alejandro Colomar

Hi John,

Quoted 25 lines · John Hubbard
Quoted 23 lines · Alejandro Colomar
Quoted 13 lines · John Hubbard

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.

Quoted 6 lines
Cc Matthew Wilcox (Oracle) <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Carsten Grohmann <[email protected]>
Cc Signed-off-by: Mike Frysinger <[email protected]>

Accident here :-)

Quoted 6 lines
Quoted 4 lines

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

Quoted 8 lines

Thanks,
Alex

Quoted 3 lines

thanks,

Signature · 2 lines
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5
#5 lore raw

On 7/28/23 12:04, Alejandro Colomar wrote:
...

Review

Quoted 9 lines

I've slightly reworded the commit message:

(quoted diff) +0 -2
-  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,

Signature · 2 lines
John Hubbard
NVIDIA