Re: [PATCH 3/3] rcu: docs: Requirements.rst: Abide by conventions of kernel documentation
From: Paul E. McKenney
Date: Fri Aug 15 2025 - 22:02:52 EST
On Sat, Aug 16, 2025 at 10:30:24AM +0900, Akira Yokosawa wrote:
> 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?
My fault when pulling in changes from Neeraj, will fix, thank you!
> Joel, I'd rather like to have your ack here. Could you?
I would be happy to add that as well. ;-)
Thanx, Paul
> Thanks, Akira
>
> > ---
> > .../RCU/Design/Requirements/Requirements.rst | 52 +++++++++----------
> > 1 file changed, 24 insertions(+), 28 deletions(-)
> >
> [...]
>