diff mbox series

[v4,1/2] docs: tracing: Reduce maxdepth in index.rst for clarity

Message ID 20250318113230.24950-1-purvayeshi550@gmail.com (mailing list archive)
State New
Headers show
Series [v4,1/2] docs: tracing: Reduce maxdepth in index.rst for clarity | expand

Commit Message

Purva Yeshi March 18, 2025, 11:32 a.m. UTC
Reduce :maxdepth: from 2 to 1 in index.rst to simplify the table of
contents, showing only top-level document titles for better readability.

Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
---
V1 - https://lore.kernel.org/all/20250204133616.27694-1-purvayeshi550@gmail.com/
V2 - https://lore.kernel.org/lkml/20250206141453.139613-1-purvayeshi550@gmail.com/
V3 - https://lore.kernel.org/all/20250312124717.7208-1-purvayeshi550@gmail.com/
V4 - Reorder patches to apply the 'maxdepth' change first, then refactor
the index documentation to avoid introducing maxdepth: 2 only to modify
it in the next patch.

 Documentation/trace/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bagas Sanjaya March 18, 2025, 2:22 p.m. UTC | #1
On Tue, Mar 18, 2025 at 05:02:29PM +0530, Purva Yeshi wrote:
> diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
> index 2c991dc96..fecc4adf7 100644
> --- a/Documentation/trace/index.rst
> +++ b/Documentation/trace/index.rst
> @@ -3,7 +3,7 @@ Linux Tracing Technologies
>  ==========================
>  
>  .. toctree::
> -   :maxdepth: 2
> +   :maxdepth: 1
>  
>     ftrace-design
>     tracepoint-analysis

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
diff mbox series

Patch

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 2c991dc96..fecc4adf7 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -3,7 +3,7 @@  Linux Tracing Technologies
 ==========================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    ftrace-design
    tracepoint-analysis