linux-kernelorg-stable/Documentation/RCU/Design
Akira Yokosawa d33b01d793 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>
2025-08-20 11:51:28 -07:00
..
Data-Structures rcu: Document separation of rcu_state and rnp's gp_seq 2025-07-22 17:10:31 +05:30
Expedited-Grace-Periods rcu: Standardize explicit CPU-hotplug calls 2023-10-04 22:29:45 +02:00
Memory-Ordering rcu: Update stray documentation references to rcu_dynticks_eqs_{enter, exit}() 2024-08-15 21:30:43 +05:30
Requirements rcu: docs: Requirements.rst: Abide by conventions of kernel documentation 2025-08-20 11:51:28 -07:00