A table's header and footer lines must match its text columns in
width, so extend the header/footer for column 1 to match the text.
Fixes this documentation build error:
Documentation/filesystems/tmpfs.rst:116: ERROR: Malformed table.
Text in column margin in table line 4.
Fixes: a0ebb5aa2de3 ("tmpfs: fix Documentation of noswap and huge mount options")
Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
Link: https://lore.kernel.org/lkml/[email protected]/T/#me28ed2124bca2e632eee86ff1d986e5c1f731a7c
Cc: Hugh Dickins <[email protected]>
Cc: [email protected]
Cc: Andrew Morton <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
---
I guess that Andrew will merge this since he merged the previous patch.
Documentation/filesystems/tmpfs.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff -- a/Documentation/filesystems/tmpfs.rst b/Documentation/filesystems/tmpfs.rst
--- a/Documentation/filesystems/tmpfs.rst
+++ b/Documentation/filesystems/tmpfs.rst
@@ -110,13 +110,13 @@ configured with CONFIG_TRANSPARENT_HUGEP
your system (has_transparent_hugepage(), which is architecture specific).
The mount options for this are:
-=========== ==============================================================
-huge=never Do not allocate huge pages. This is the default.
-huge=always Attempt to allocate huge page every time a new page is needed.
+================ ==============================================================
+huge=never Do not allocate huge pages. This is the default.
+huge=always Attempt to allocate huge page every time a new page is needed.
huge=within_size Only allocate huge page if it will be fully within i_size.
- Also respect madvise(2) hints.
-huge=advise Only allocate huge page if requested with madvise(2).
-=========== ==============================================================
+ Also respect madvise(2) hints.
+huge=advise Only allocate huge page if requested with madvise(2).
+================ ==============================================================
See also Documentation/admin-guide/mm/transhuge.rst, which describes the
sysfs file /sys/kernel/mm/transparent_hugepage/shmem_enabled: which can
On Mon, 24 Jul 2023, Randy Dunlap wrote:
> A table's header and footer lines must match its text columns in
> width, so extend the header/footer for column 1 to match the text.
>
> Fixes this documentation build error:
> Documentation/filesystems/tmpfs.rst:116: ERROR: Malformed table.
> Text in column margin in table line 4.
>
> Fixes: a0ebb5aa2de3 ("tmpfs: fix Documentation of noswap and huge mount options")
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: Stephen Rothwell <[email protected]>
> Link: https://lore.kernel.org/lkml/[email protected]/T/#me28ed2124bca2e632eee86ff1d986e5c1f731a7c
> Cc: Hugh Dickins <[email protected]>
> Cc: [email protected]
> Cc: Andrew Morton <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> ---
> I guess that Andrew will merge this since he merged the previous patch.
Acked-by: Hugh Dickins <[email protected]>
Many thanks, Randy: your rapid rescue service is much appreciated.
>
> Documentation/filesystems/tmpfs.rst | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff -- a/Documentation/filesystems/tmpfs.rst b/Documentation/filesystems/tmpfs.rst
> --- a/Documentation/filesystems/tmpfs.rst
> +++ b/Documentation/filesystems/tmpfs.rst
> @@ -110,13 +110,13 @@ configured with CONFIG_TRANSPARENT_HUGEP
> your system (has_transparent_hugepage(), which is architecture specific).
> The mount options for this are:
>
> -=========== ==============================================================
> -huge=never Do not allocate huge pages. This is the default.
> -huge=always Attempt to allocate huge page every time a new page is needed.
> +================ ==============================================================
> +huge=never Do not allocate huge pages. This is the default.
> +huge=always Attempt to allocate huge page every time a new page is needed.
> huge=within_size Only allocate huge page if it will be fully within i_size.
> - Also respect madvise(2) hints.
> -huge=advise Only allocate huge page if requested with madvise(2).
> -=========== ==============================================================
> + Also respect madvise(2) hints.
> +huge=advise Only allocate huge page if requested with madvise(2).
> +================ ==============================================================
>
> See also Documentation/admin-guide/mm/transhuge.rst, which describes the
> sysfs file /sys/kernel/mm/transparent_hugepage/shmem_enabled: which can