From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Steven Rostedt <rostedt@goodmis.org>,
Purva Yeshi <purvayeshi550@gmail.com>
Cc: mhiramat@kernel.org, corbet@lwn.net, skhan@linuxfoundation.org,
mathieu.desnoyers@efficios.com, linux-kernel@vger.kernel.org,
linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v2] docs: trace: Refactor index documentation
Date: Wed, 12 Feb 2025 18:10:44 +0700 [thread overview]
Message-ID: <Z6yBtB7mjoiquKRj@archie.me> (raw)
In-Reply-To: <20250210174556.70fc53b7@gandalf.local.home>
[-- Attachment #1: Type: text/plain, Size: 786 bytes --]
On Mon, Feb 10, 2025 at 05:45:56PM -0500, Steven Rostedt wrote:
> On Thu, 6 Feb 2025 19:44:53 +0530
> Purva Yeshi <purvayeshi550@gmail.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.
Thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2025-02-12 11:10 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-06 14:14 [PATCH v2] docs: trace: Refactor index documentation Purva Yeshi
2025-02-10 22:45 ` Steven Rostedt
2025-02-12 11:10 ` Bagas Sanjaya [this message]
2025-02-12 14:51 ` Steven Rostedt
2025-02-13 3:31 ` Bagas Sanjaya
2025-02-13 11:56 ` Purva Yeshi
2025-02-13 16:47 ` Steven Rostedt
2025-02-13 19:12 ` Purva Yeshi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Z6yBtB7mjoiquKRj@archie.me \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=purvayeshi550@gmail.com \
--cc=rostedt@goodmis.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.