linux-kernel - Re: [PATCH v3 2/2] docs: tracing: Reduce maxdepth in 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 for Android: free password hash cracker in your pocket

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

Message-ID: <Z9JKqVvG1iw0bFXR@archie.me>
Date: Thu, 13 Mar 2025 10:02:01 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Steven Rostedt <rostedt@...dmis.org>,
	Purva Yeshi <purvayeshi550@...il.com>
Cc: Masami Hiramatsu <mhiramat@...nel.org>,
	Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
	Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
	linux-trace-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH v3 2/2] docs: tracing: Reduce maxdepth in index
 documentation

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

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