linux-kernel - Re: [PATCH] docs: remove broken overline from sysctl/vm.rst

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: <54aca5de-2f42-4bbf-ac58-2ee6ddf3f8ca@infradead.org>
Date: Sun, 27 Jul 2025 13:20:51 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Vedang Kandalkar <vedangkandalkar@...il.com>, linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: remove broken overline from sysctl/vm.rst

Hi,

On 7/27/25 12:33 PM, Vedang Kandalkar wrote:
> From 098513ca1d41c0c69f3956a6d22f34aee452afdd Mon Sep 17 00:00:00 2001
> From: Vedang Kandalkar <vedangkandalkar@...il.com>
> Date: Sun, 27 Jul 2025 23:38:12 +0530
> Subject: [PATCH] docs: remove broken overline from sysctl/vm.rst
> 
> The overline above the /proc/sys/vm/ section was broken and not
> following standard reStructuredText conventions. Removed to improve
> readability.
> 
> Signed-off-by: Vedang Kandalkar <vedangkandalkar@...il.com>
> 

All of the .rst files in that sub-directory are like this.
Should they all be patched?

OTOH, there are many files in Documentation/admin-guide/ that use this
pattern. Are they all incorrect?

Exactly how is it "broken?"
Did you read Documentation/doc-guide/sphinx.rst, where it says:

* Please stick to this order of heading adornments:

  1. ``=`` with overline for document title::

       ==============
       Document title
       ==============

  2. ``=`` for chapters::

       Chapters
       ========

> ---
>  Documentation/admin-guide/sysctl/vm.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/sysctl/vm.rst
> b/Documentation/admin-guide/sysctl/vm.rst
> index 9bef46151d53cd..8f3875d68ac8ea 100644
> --- a/Documentation/admin-guide/sysctl/vm.rst
> +++ b/Documentation/admin-guide/sysctl/vm.rst
> @@ -1,4 +1,3 @@
> -===============================
>  Documentation for /proc/sys/vm/
>  ===============================
> 

thanks.
-- 
~Randy