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

[Bagas Sanjaya]

On Wed, Feb 12, 2025 at 09:51:11AM -0500, Steven Rostedt wrote:
> On Wed, 12 Feb 2025 18:10:44 +0700
> Bagas Sanjaya <bagasdotme@xxxxxxxxx> wrote:
> 
> > > > +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.
> 
> As I'm the original author, I would like to know why there was a change.
> 

Oops, I mean I'm referring to the patch author (Purva Yeshi).

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

Attachment: signature.asc
Description: PGP signature