linux-kernel - Re: [PATCH v2] docs: trace: Refactor index documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <Z61nkk7X3jQJyzYX@archie.me>
Date: Thu, 13 Feb 2025 10:31:30 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Steven Rostedt <rostedt@...dmis.org>
Cc: Purva Yeshi <purvayeshi550@...il.com>, mhiramat@...nel.org,
	corbet@....net, skhan@...uxfoundation.org,
	mathieu.desnoyers@...icios.com, linux-kernel@...r.kernel.org,
	linux-trace-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH v2] docs: trace: Refactor index documentation

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@...il.com> 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

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)