Re: [PATCH v2] docs: trace: Refactor index documentation

On Mon, Feb 10, 2025 at 05:45:56PM -0500, Steven Rostedt wrote:

On Thu,  6 Feb 2025 19:44:53 +0530
Purva Yeshi [off-list ref] wrote:

quoted

+Introduction to Tracing
+-----------------------
+
+This section provides an overview of Linux tracing mechanisms
+and debugging approaches.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1

I don't really know what the maxdepth gives here, but there was no mention
in the change log why it had to be converted from 2 to 1.

:maxdepth: specifies heading levels depth of the toctree. In this case,
the author wants only doc titles (hence 1), whereas 2 also includes
second-level (section) headings.

Thanks.

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