linux-kernel - Re: [PATCH 3/3] rcu: docs: Requirements.rst: Abide by conventions of kernel documentation

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <47d4f9df-4fd5-48e6-9769-58c6d6497620@gmail.com>
Date: Sat, 16 Aug 2025 10:30:24 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: "Paul E. McKenney" <paulmck@...nel.org>, rcu@...r.kernel.org,
 Joel Fernandes <joelagnelf@...dia.com>
Cc: linux-kernel@...r.kernel.org, kernel-team@...a.com, rostedt@...dmis.org,
 Neeraj Upadhyay <neeraj.upadhyay@...nel.org>,
 Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH 3/3] rcu: docs: Requirements.rst: Abide by conventions of
 kernel documentation

On Fri, 15 Aug 2025 17:00:07 -0700, Paul E. McKenney wrote:
> From: Akira Yokosawa <akiyks@...il.com>
> 
> Here is a list of conventions applied here:
> 
> - Don't mark up function names, to be taken care of by the automarkup
>   extension.  Just say func().
> - Instead of ".. code-block:: none", just say "::".
> - Mark inline literals by a pair of ``xxxx``.  Don't use rust doc's
>   dialect of `yyyy`.
> - Instead of emphasizing headings by **strong emphasis**, use sub-level
>   title adornments, in this case "^^^^^^^^^^" and make them proper
>   sub-sections under "Hotplug CPU".
> 
> Signed-off-by: Akira Yokosawa <akiyks@...il.com>
> Cc: Joel Fernandes <joelagnelf@...dia.com>
> Signed-off-by: Neeraj Upadhyay (AMD) <neeraj.upadhyay@...nel.org>

Missing S-o-b of Paul?

Joel, I'd rather like to have your ack here.  Could you?

        Thanks, Akira

> ---
>  .../RCU/Design/Requirements/Requirements.rst  | 52 +++++++++----------
>  1 file changed, 24 insertions(+), 28 deletions(-)
> 
[...]