2022-01-09 05:56:51

by Randy Dunlap

Subject: [PATCH] sysctl: documentation: fix table format warning

Fix malformed table warning in sysctl documentation:
(don't use ':'s)

Documentation/admin-guide/sysctl/kernel.rst:798: WARNING: Malformed table.
Text in column margin in table line 7.

===== ============================================
bit 0 print all tasks info
bit 1 print system memory info
bit 2 print timer info
bit 3 print locks info if ``CONFIG_LOCKDEP`` is on
bit 4 print ftrace buffer
bit 5: print all printk messages in buffer
bit 6: print all CPUs backtrace (if available in the arch)

Fixes: 934d51cad60c ("docs: sysctl/kernel: add missing bit to panic_print")
Fixes: addc64999934 ("panic: add option to dump all CPUs backtraces in panic_print")
Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
Cc: Guilherme G. Piccoli <[email protected]>
Cc: Andrew Morton <[email protected]>
Cc: [email protected]
---
Documentation/admin-guide/sysctl/kernel.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20220107.orig/Documentation/admin-guide/sysctl/kernel.rst
+++ linux-next-20220107/Documentation/admin-guide/sysctl/kernel.rst
@@ -795,8 +795,8 @@ bit 1 print system memory info
bit 2 print timer info
bit 3 print locks info if ``CONFIG_LOCKDEP`` is on
bit 4 print ftrace buffer
-bit 5: print all printk messages in buffer
-bit 6: print all CPUs backtrace (if available in the arch)
+bit 5 print all printk messages in buffer
+bit 6 print all CPUs backtrace (if available in the arch)
===== ============================================

So for example to print tasks and memory info on panic, user can::

2022-01-10 12:25:10

by Guilherme G. Piccoli

Subject: Re: [PATCH] sysctl: documentation: fix table format warning

On 09/01/2022 02:56, Randy Dunlap wrote:
> Fix malformed table warning in sysctl documentation:
> (don't use ':'s)
>
> Documentation/admin-guide/sysctl/kernel.rst:798: WARNING: Malformed table.
> Text in column margin in table line 7.
>
> ===== ============================================
> bit 0 print all tasks info
> bit 1 print system memory info
> bit 2 print timer info
> bit 3 print locks info if ``CONFIG_LOCKDEP`` is on
> bit 4 print ftrace buffer
> bit 5: print all printk messages in buffer
> bit 6: print all CPUs backtrace (if available in the arch)
>
> Fixes: 934d51cad60c ("docs: sysctl/kernel: add missing bit to panic_print")
> Fixes: addc64999934 ("panic: add option to dump all CPUs backtraces in panic_print")
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: Stephen Rothwell <[email protected]>
> Cc: Guilherme G. Piccoli <[email protected]>
> Cc: Andrew Morton <[email protected]>
> Cc: [email protected]
> ---
> Documentation/admin-guide/sysctl/kernel.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20220107.orig/Documentation/admin-guide/sysctl/kernel.rst
> +++ linux-next-20220107/Documentation/admin-guide/sysctl/kernel.rst
> @@ -795,8 +795,8 @@ bit 1 print system memory info
> bit 2 print timer info
> bit 3 print locks info if ``CONFIG_LOCKDEP`` is on
> bit 4 print ftrace buffer
> -bit 5: print all printk messages in buffer
> -bit 6: print all CPUs backtrace (if available in the arch)
> +bit 5 print all printk messages in buffer
> +bit 6 print all CPUs backtrace (if available in the arch)
> ===== ============================================
>
> So for example to print tasks and memory info on panic, user can::

Thanks a lot Randy and Stephen!

Reviewed-by: Guilherme G. Piccoli <[email protected]>