linux-kernel - Re: [PATCH] sysctl: documentation: fix table format warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <d1769d1c-9f0d-5aa7-d5c6-d0f9d2b3dba8@igalia.com>
Date:   Mon, 10 Jan 2022 09:24:12 -0300
From:   "Guilherme G. Piccoli" <gpiccoli@...lia.com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org,
        Stephen Rothwell <sfr@...b.auug.org.au>
Cc:     Andrew Morton <akpm@...ux-foundation.org>, linux-mm@...ck.org
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 <rdunlap@...radead.org>
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Cc: Guilherme G. Piccoli <gpiccoli@...lia.com>
> Cc: Andrew Morton <akpm@...ux-foundation.org>
> Cc: linux-mm@...ck.org
> ---
>  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 <gpiccoli@...lia.com>