[PATCH 0/2] RCU docs toctree cleanup

[PATCH 0/2] RCU docs toctree cleanup

[Bagas Sanjaya]

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/20250819004559.11429-1-bagasdotme@gmail.com/

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(-)

-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/2] Documentation: RCU: Reduce toctree depth

[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 <bagasdotme@gmail.com>
---
 Documentation/RCU/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
index 84a79903f6a883..e1be5b3c2c6773 100644
--- a/Documentation/RCU/index.rst
+++ b/Documentation/RCU/index.rst
@@ -7,7 +7,7 @@ RCU concepts
 ============
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    checklist
    lockdep
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 1/2] Documentation: RCU: Reduce toctree depth

[Paul E. McKenney]

On Tue, Aug 19, 2025 at 08:26:19AM +0700, Bagas Sanjaya wrote:
> 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 <bagasdotme@gmail.com>

I pulled all three in for testing and review, thank you!

							Thanx, Paul

> ---
>  Documentation/RCU/index.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
> index 84a79903f6a883..e1be5b3c2c6773 100644
> --- a/Documentation/RCU/index.rst
> +++ b/Documentation/RCU/index.rst
> @@ -7,7 +7,7 @@ RCU concepts
>  ============
>  
>  .. toctree::
> -   :maxdepth: 3
> +   :maxdepth: 2
>  
>     checklist
>     lockdep
> -- 
> An old man doll... just what I always wanted! - Clara
> 

[PATCH 2/2] Documentation: RCU: Retitle toctree index

[Bagas Sanjaya]

toctree 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.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/RCU/index.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
index e1be5b3c2c6773..ef26c78507d369 100644
--- a/Documentation/RCU/index.rst
+++ b/Documentation/RCU/index.rst
@@ -1,9 +1,9 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _rcu_concepts:
+.. _rcu_handbook:
 
 ============
-RCU concepts
+RCU Handbook
 ============
 
 .. toctree::
-- 
An old man doll... just what I always wanted! - Clara