Skip to contentSkip to conversation

docs: admin-guide: Extend short title underline in sysctl

PATCH In review Adam Zerella 3 participants 5 messages Oct 14, 2019 – Oct 15, 2019 Documentation

lore
Share & tools
lore

Adam Zerella

author
#0 lore raw

PATCH 1/1 docs: admin-guide: Extend short title underline in sysctl

Title underlines should extend the full length of a title, Sphinx is currently displaying the following warning when building the htmldocs:

sysctl/kernel.rst:397: WARNING: Title underline too short.

hung_task_interval_warnings:
===================

Signed-off-by Adam Zerella <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +1 -1
index 614179dc79a9..383eda89f411 100644
@@ -394,7 +394,7 @@ This file shows up if CONFIG_DETECT_HUNG_TASK is enabled.
 
 
 hung_task_interval_warnings:
-===================
+============================
 
 The same as hung_task_warnings, but set the number of interval
 warnings to be issued about detected hung tasks during check
Signature · 1 line
2.21.0
reviewer
#1 lore raw
Quoted 20 lines · Adam Zerella

Title underlines should extend the full length of a title, Sphinx is currently displaying the following warning when building the htmldocs:

sysctl/kernel.rst:397: WARNING: Title underline too short.

hung_task_interval_warnings:
===================

Signed-off-by Adam Zerella <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +0 -0
index 614179dc79a9..383eda89f411 100644

Documentation/admin-guide/sysctl/kernel.rst This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. · line 400

Quoted 8 lines
Documentation/admin-guide/sysctl/kernel.rst +1 -1
@@ -394,7 +394,7 @@ This file shows up if CONFIG_DETECT_HUNG_TASK is enabled.
 
 
 hung_task_interval_warnings:
-===================
+============================
 
 The same as hung_task_warnings, but set the number of interval
 warnings to be issued about detected hung tasks during check

I sent the same patch on Oct-08 but no one has merged it yet.

https://lore.kernel.org/lkml/[email protected]/

Signature · 1 line
~Randy
maintainer
#2 lore raw
In reply to Adam Zerella
Quoted 19 lines · On Mon, 14 Oct 2019 22:00:08 +1100 Adam Zerella <[email protected]> wrote:

Title underlines should extend the full length of a title, Sphinx is currently displaying the following warning when building the htmldocs:

sysctl/kernel.rst:397: WARNING: Title underline too short.

hung_task_interval_warnings:
===================

Signed-off-by Adam Zerella <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +0 -0
index 614179dc79a9..383eda89f411 100644

Documentation/admin-guide/sysctl/kernel.rst This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. · line 400

Quoted 8 lines
Documentation/admin-guide/sysctl/kernel.rst +1 -1
@@ -394,7 +394,7 @@ This file shows up if CONFIG_DETECT_HUNG_TASK is enabled.
 
 
 hung_task_interval_warnings:
-===================
+============================
 
 The same as hung_task_warnings, but set the number of interval
 warnings to be issued about detected hung tasks during check

So this is a good fix, but it's not an actual patch that I can apply. Randy meanwhile says he fixed it, but the patch wasn't sent to me. I guess this warning will live a little longer...:(

Thanks,

jon

reviewer
#3 lore raw
Quoted 28 lines · Jonathan Corbet
Quoted 25 lines · On Mon, 14 Oct 2019 22:00:08 +1100 Adam Zerella <[email protected]> wrote:

Title underlines should extend the full length of a title, Sphinx is currently displaying the following warning when building the htmldocs:

sysctl/kernel.rst:397: WARNING: Title underline too short.

hung_task_interval_warnings:
===================

Signed-off-by Adam Zerella <[email protected]>
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +1 -1
index 614179dc79a9..383eda89f411 100644
@@ -394,7 +394,7 @@ This file shows up if CONFIG_DETECT_HUNG_TASK is enabled.
 
 
 hung_task_interval_warnings:
-===================
+============================
Quoted 6 lines

Documentation/admin-guide/sysctl/kernel.rst This file shows up if CONFIG_DETECT_HUNG_TASK is enabled. · line 400

Quoted 2 lines
Documentation/admin-guide/sysctl/kernel.rst +0 -0
 The same as hung_task_warnings, but set the number of interval
 warnings to be issued about detected hung tasks during check

So this is a good fix, but it's not an actual patch that I can apply. Randy meanwhile says he fixed it, but the patch wasn't sent to me. I guess this warning will live a little longer...:(

AFAIK, it's a patch to linux-next, not mainline.
Can you take such a patch?

thnx.

Signature · 1 line
~Randy
maintainer
#4 lore raw
Quoted 6 lines · On Tue, 15 Oct 2019 14:28:56 -0700 Randy Dunlap <[email protected]> wrote:
Quoted 3 lines

So this is a good fix, but it's not an actual patch that I can apply. Randy meanwhile says he fixed it, but the patch wasn't sent to me. I guess this warning will live a little longer...:(

AFAIK, it's a patch to linux-next, not mainline.
Can you take such a patch?

Ah, I see the problem, sorry I was dense before. The patch is fixing a change that went into linux-next via somebody else's tree. So yeah, I can't really apply that, it should go to whoever merged the original (which is 0fab3ac21880 "hung_task: allow printing warnings every check interval" BTW). A Fixes: tag and a copy to the original author would also be good.

Sorry for the confusion,

jon