mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Vedang Kandalkar <vedangkandalkar@gmail.com>, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: remove broken overline from sysctl/vm.rst
Date: Sun, 27 Jul 2025 13:20:51 -0700	[thread overview]
Message-ID: <54aca5de-2f42-4bbf-ac58-2ee6ddf3f8ca@infradead.org> (raw)
In-Reply-To: <CAJSSbgCRT-EcQTdTKof_gG5eBD1eYZKEFC_9pdQsaCiXx9yQHA@mail.gmail.com>

Hi,

On 7/27/25 12:33 PM, Vedang Kandalkar wrote:
> From 098513ca1d41c0c69f3956a6d22f34aee452afdd Mon Sep 17 00:00:00 2001
> From: Vedang Kandalkar <vedangkandalkar@gmail.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@gmail.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


      reply	other threads:[~2025-07-27 20:20 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-27 19:33 Vedang Kandalkar
2025-07-27 20:20 ` Randy Dunlap [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=54aca5de-2f42-4bbf-ac58-2ee6ddf3f8ca@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=vedangkandalkar@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®