2020-04-21 20:05:36

by Randy Dunlap

Subject: [PATCH -next] Documentation: admin-guide: sysctl/kernel.h: fix underlines and headings

From: Randy Dunlap <[email protected]>

Fix underline length warnings and drop the ending semi-colon from the
title so that they match other title lines.

linux-next-20200420/Documentation/admin-guide/sysctl/kernel.rst:281: WARNING: Title underline too short.

hung_task_all_cpu_backtrace:
================

linux-next-20200420/Documentation/admin-guide/sysctl/kernel.rst:564: WARNING: Title underline too short.

oops_all_cpu_backtrace:
================
Signed-off-by: Randy Dunlap <[email protected]>
---

@Andrew: Jonathan says that this needs to go via you since it fixes something
that went via your tree. ("introduced by patch 93a0fba3de9a")


Documentation/admin-guide/sysctl/kernel.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20200420.orig/Documentation/admin-guide/sysctl/kernel.rst
+++ linux-next-20200420/Documentation/admin-guide/sysctl/kernel.rst
@@ -277,8 +277,8 @@ Path for the hotplug policy agent.
Default value is "``/sbin/hotplug``".


-hung_task_all_cpu_backtrace:
-================
+hung_task_all_cpu_backtrace
+===========================

If this option is set, the kernel will send an NMI to all CPUs to dump
their backtraces when a hung task is detected. This file shows up if
@@ -560,8 +560,8 @@ rate for each task.
scanned for a given scan.


-oops_all_cpu_backtrace:
-================
+oops_all_cpu_backtrace
+======================

If this option is set, the kernel will send an NMI to all CPUs to dump
their backtraces when an oops event occurs. It should be used as a last

2020-04-23 16:30:45

by Guilherme Piccoli

Subject: Re: [PATCH -next] Documentation: admin-guide: sysctl/kernel.h: fix underlines and headings

Thanks Randy for fixing this issue with my patches, I apologize for
that! I'm also adding Stephen to the thread (he's the committer in the
-next tree), and Bolarinwa (which sent a similar fix to linux-doc this
morning, thanks!).

Also, I'd suggest adding fixes tags like below (or don't we need them on
linux-next patches?):

Fixes: 925eca2dee09 ("kernel/hung_task.c: introduce sysctl to print all
traces when a hung task is detected")
Fixes: fb16bede2879 ("panic: add sysctl to dump all CPUs backtraces on
oops event")

Cheers,


Guilherme