Skip to contentSkip to conversation

sysctl: documentation: fix table format warning

PATCH In review Randy Dunlap 2 participants 2 messages Jan 9, 2022 – Jan 10, 2022

Subsystems (2)
lore
Share & tools
lore

Randy Dunlap

author reviewer
#0 lore raw

PATCH 1/1 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")
Cc Guilherme G. Piccoli <[email protected]>
Cc Andrew Morton <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/sysctl/kernel.rst +2 -2
@@ -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::
Reviewed-by on v1 1/1
#1 lore raw
Quoted 29 lines · Randy Dunlap

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")
Cc Guilherme G. Piccoli <[email protected]>
Cc Andrew Morton <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Documentation/admin-guide/sysctl/kernel.rst bit 1 print system memory info · line 802

Quoted 10 lines
Documentation/admin-guide/sysctl/kernel.rst +2 -2
@@ -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!