[PATCH] docs: tracing: Reduce maxdepth in index documentation

[PATCH] docs: tracing: Reduce maxdepth in index documentation

[Purva Yeshi]

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>
---
 Documentation/trace/index.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 6b268194f..5ddd47ee7 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -14,7 +14,7 @@ This section provides an overview of Linux tracing mechanisms
 and debugging approaches.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    debugging
    tracepoints
@@ -28,7 +28,7 @@ The following are the primary tracing frameworks integrated into
 the Linux kernel.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    ftrace
    ftrace-design
@@ -47,7 +47,7 @@ A detailed explanation of event tracing mechanisms and their
 applications.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    events
    events-kmem
@@ -65,7 +65,7 @@ This section covers tracing features that monitor hardware
 interactions and system performance.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    intel_th
    stm
@@ -85,7 +85,7 @@ These tools allow tracing user-space applications and
 interactions.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    user_events
 
-- 
2.34.1

Re: [PATCH] docs: tracing: Reduce maxdepth in index documentation

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 472 bytes --]

On Mon, Feb 17, 2025 at 04:51:09PM +0530, Purva Yeshi wrote:
> Reduce :maxdepth: from 2 to 1 in index.rst to simplify the table of
> contents, showing only top-level document titles for better readability.
> 

Is this patch mean to be applied on top of/squashed into your toctree
refactoring ([1])?

Confused...

[1]: https://lore.kernel.org/linux-doc/20250217110637.6640-1-purvayeshi550@gmail.com/

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] docs: tracing: Reduce maxdepth in index documentation

[Purva Yeshi]

On 20/02/25 08:39, Bagas Sanjaya wrote:
> On Mon, Feb 17, 2025 at 04:51:09PM +0530, Purva Yeshi wrote:
>> Reduce :maxdepth: from 2 to 1 in index.rst to simplify the table of
>> contents, showing only top-level document titles for better readability.
>>
> 
> Is this patch mean to be applied on top of/squashed into your toctree
> refactoring ([1])?
> 
> Confused...
> 
> [1]: https://lore.kernel.org/linux-doc/20250217110637.6640-1-purvayeshi550@gmail.com/
> 

Sorry for the confusion. I will send a series of patches, like [0/3] and 
[1/3], to make the dependencies clear. Thanks for your patience!