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

From: Akira Yokosawa
Date: Fri Aug 15 2025 - 21:43:08 EST


On Fri, 15 Aug 2025 17:00:07 -0700, Paul E. McKenney wrote:
> From: Akira Yokosawa <akiyks@xxxxxxxxx>
>
> 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@xxxxxxxxx>
> Cc: Joel Fernandes <joelagnelf@xxxxxxxxxx>
> Signed-off-by: Neeraj Upadhyay (AMD) <neeraj.upadhyay@xxxxxxxxxx>

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(-)
>
[...]