RCU docs toctree cleanup
Subsystems (2)
cover RCU docs toctree cleanup
Hi,
As the subject suggests: a small cleanup on RCU documentation toctree index. The first patch tidying up toctree by not spoiling the full hierarchy by means of reducing its depth. The second one edits the index title to reflect nature of the toctree.
Enjoy!
This series is based on kvm-remote.sh wrap patch [1].
[1]: https://lore.kernel.org/linux-doc/[email protected]/
Bagas Sanjaya (2):
Documentation: RCU: Reduce toctree depth
Documentation: RCU: Retitle toctree index
Documentation/RCU/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/2 Documentation: RCU: Reduce toctree depth
toctree index for RCU currently has maximum depth of 3. Since no docs currently use more than 3 section heading levels, this effectively spills the entire docs hierarchy.
Tidy up by reducing toctree depth to 2 (only showing docs title and second-level sections).
--- Documentation/RCU/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/index.rst +1 -1
@@ -7,7 +7,7 @@ RCU concepts ============ .. toctree:: - :maxdepth: 3 + :maxdepth: 2 checklist lockdep
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Paul E. McKenney
maintainerRe: [PATCH 1/2] Documentation: RCU: Reduce toctree depth
Quoted 8 lines · Bagas Sanjaya
toctree index for RCU currently has maximum depth of 3. Since no docs currently use more than 3 section heading levels, this effectively spills the entire docs hierarchy.
Tidy up by reducing toctree depth to 2 (only showing docs title and second-level sections).
Signed-off-by Bagas Sanjaya <[email protected]>
I pulled all three in for testing and review, thank you!
Thanx, Paul
Quoted 20 lines
--- Documentation/RCU/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/RCU/index.rst +1
-1@@ -7,7 +7,7 @@ RCU concepts ============ .. toctree:: - :maxdepth: 3 + :maxdepth: 2 checklist lockdepSignature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 2/2 Documentation: RCU: Retitle toctree index
In reply to Bagas Sanjayatoctree index title ("RCU concepts") is rather a misnomer: RCU concepts is already described in rcu.rst, whereas the toctree suggests that the docs themes about handbook on RCU subsystem instead.
Edit the title to reflect the fact.
--- Documentation/RCU/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/index.rst +2 -2
@@ -1,9 +1,9 @@ .. SPDX-License-Identifier: GPL-2.0 -.. _rcu_concepts: +.. _rcu_handbook: ============ -RCU concepts +RCU Handbook ============ .. toctree::
Signature · 1 line
An old man doll... just what I always wanted! - Clara