[PATCH] docs: admin-guide: Extend short title underline in sysctl

[PATCH] docs: admin-guide: Extend short title underline in sysctl

[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 <adam.zerella@gmail.com>
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index 614179dc79a9..383eda89f411 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -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
-- 
2.21.0

Re: [PATCH] docs: admin-guide: Extend short title underline in sysctl

[Randy Dunlap]

On 10/14/19 4:00 AM, Adam Zerella 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 <adam.zerella@gmail.com>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index 614179dc79a9..383eda89f411 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -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/55ce9772-cffe-f28f-d002-088127842980@infradead.org/

-- 
~Randy

Re: [PATCH] docs: admin-guide: Extend short title underline in sysctl

[Jonathan Corbet]

On Mon, 14 Oct 2019 22:00:08 +1100
Adam Zerella <adam.zerella@gmail.com> 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 <adam.zerella@gmail.com>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index 614179dc79a9..383eda89f411 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -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

Re: [PATCH] docs: admin-guide: Extend short title underline in sysctl

[Randy Dunlap]

On 10/15/19 11:32 AM, Jonathan Corbet wrote:
> On Mon, 14 Oct 2019 22:00:08 +1100
> Adam Zerella <adam.zerella@gmail.com> 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 <adam.zerella@gmail.com>
>> ---
>>  Documentation/admin-guide/sysctl/kernel.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
>> index 614179dc79a9..383eda89f411 100644
>> --- a/Documentation/admin-guide/sysctl/kernel.rst
>> +++ b/Documentation/admin-guide/sysctl/kernel.rst
>> @@ -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...:(

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

thnx.
-- 
~Randy

Re: [PATCH] docs: admin-guide: Extend short title underline in sysctl

[Jonathan Corbet]

On Tue, 15 Oct 2019 14:28:56 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> > 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