summaryrefslogtreecommitdiff
path: root/scripts/kernel-doc.py
diff options
context:
space:
mode:
authorAkira Yokosawa <akiyks@gmail.com>2025-07-23 17:59:10 +0900
committerPaul E. McKenney <paulmck@kernel.org>2025-08-20 11:51:28 -0700
commitd33b01d793d91e0c9db5a7360bab35da0cb8a453 (patch)
treee1a50f88dbe582e68693b8bf09da699f99bbee88 /scripts/kernel-doc.py
parent820f8da73dfeccf32e7b6580b4c41d0d3e2c2e02 (diff)
rcu: docs: Requirements.rst: Abide by conventions of kernel documentation
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> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'scripts/kernel-doc.py')
0 files changed, 0 insertions, 0 deletions