]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rcu: docs: Requirements.rst: Abide by conventions of kernel documentation
authorAkira Yokosawa <akiyks@gmail.com>
Wed, 23 Jul 2025 08:59:10 +0000 (17:59 +0900)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 20 Aug 2025 18:51:28 +0000 (11:51 -0700)
commitd33b01d793d91e0c9db5a7360bab35da0cb8a453
treee1a50f88dbe582e68693b8bf09da699f99bbee88
parent820f8da73dfeccf32e7b6580b4c41d0d3e2c2e02
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>
Documentation/RCU/Design/Requirements/Requirements.rst