From: Akira Yokosawa <akiyks@gmail.com>
To: "Paul E. McKenney" <paulmck@kernel.org>,
rcu@vger.kernel.org, Joel Fernandes <joelagnelf@nvidia.com>
Cc: linux-kernel@vger.kernel.org, kernel-team@meta.com,
rostedt@goodmis.org, Neeraj Upadhyay <neeraj.upadhyay@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH 3/3] rcu: docs: Requirements.rst: Abide by conventions of kernel documentation
Date: Sat, 16 Aug 2025 10:30:24 +0900 [thread overview]
Message-ID: <47d4f9df-4fd5-48e6-9769-58c6d6497620@gmail.com> (raw)
In-Reply-To: <20250816000007.2622326-3-paulmck@kernel.org>
On Fri, 15 Aug 2025 17:00:07 -0700, Paul E. McKenney wrote:
> From: Akira Yokosawa <akiyks@gmail.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@gmail.com>
> Cc: Joel Fernandes <joelagnelf@nvidia.com>
> Signed-off-by: Neeraj Upadhyay (AMD) <neeraj.upadhyay@kernel.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(-)
>
[...]
next prev parent reply other threads:[~2025-08-16 1:42 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-15 23:59 [PATCH 0/3] rcu: Documentation updates for v6.18 Paul E. McKenney
2025-08-16 0:00 ` [PATCH 1/3] doc: Update whatisRCU.rst for recent RCU API additions Paul E. McKenney
2025-08-16 3:54 ` Bagas Sanjaya
2025-08-16 4:54 ` Paul E. McKenney
2025-08-16 5:38 ` Bagas Sanjaya
2025-08-16 11:28 ` Paul E. McKenney
2025-08-16 0:00 ` [PATCH 2/3] doc: Add RCU guards to checklist.rst Paul E. McKenney
2025-08-16 0:00 ` [PATCH 3/3] rcu: docs: Requirements.rst: Abide by conventions of kernel documentation Paul E. McKenney
2025-08-16 1:30 ` Akira Yokosawa [this message]
2025-08-16 2:02 ` Paul E. McKenney
2025-09-18 10:14 ` [PATCH 0/3] rcu: Documentation updates for v6.18 Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 1/8] doc: Update whatisRCU.rst for recent RCU API additions Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 2/8] doc: Add RCU guards to checklist.rst Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 3/8] rcu: docs: Requirements.rst: Abide by conventions of kernel documentation Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 4/8] Documentation: RCU: Wrap kvm-remote.sh rerun snippet in literal code block Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 5/8] Documentation: RCU: Reduce toctree depth Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 6/8] Documentation: RCU: Retitle toctree index Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 7/8] doc: Fix typo in RCU's torture.rst documentation Paul E. McKenney
2025-09-18 10:14 ` [PATCH v2 8/8] docs: rcu: Replace multiple dead OLS links in RTFP.txt Paul E. McKenney
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=47d4f9df-4fd5-48e6-9769-58c6d6497620@gmail.com \
--to=akiyks@gmail.com \
--cc=joelagnelf@nvidia.com \
--cc=kernel-team@meta.com \
--cc=linux-kernel@vger.kernel.org \
--cc=neeraj.upadhyay@kernel.org \
--cc=paulmck@kernel.org \
--cc=rcu@vger.kernel.org \
--cc=rostedt@goodmis.org \
/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