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

Bagas Sanjaya
2025-03-13T03:02:06Z

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

On Wed, Mar 12, 2025 at 01:49:07PM -0400, Steven Rostedt wrote:
> On Wed, 12 Mar 2025 18:17:17 +0530
> Purva Yeshi <purvayeshi550@gmail.com> 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.
> >
> > 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
>
> If you made this the first patch, you would only need to modify one place.
>
> This is a patch series. If the end result is going to be maxdepth 1,
> you shouldn't add a bunch of maxdepth 2 and then in the next patch make
> them all maxdepth 1 as the only change.

If you'd like to generate a patch series, you can refer to thoughtbot
blogpost at [1].

And you can also add cover letter by passing --cover-letter to
git-format-patch(1).

Thanks.

[1]: https://thoughtbot.com/blog/send-a-patch-to-someone-using-git-format-patch

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

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