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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <8147edd6-074e-4888-a7a0-798c8d0de612@gmail.com>
Date: Fri, 14 Mar 2025 14:25:25 +0530
From: Purva Yeshi <purvayeshi550@...il.com>
To: Steven Rostedt <rostedt@...dmis.org>
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 12/03/25 23:19, 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.
> 
> Just change the one maxdepth 1 first, and then you can update the code
> with the new maxdepth of 1.
> 
> -- Steve

Hi Steven,

Got it. If I understand correctly, you’re suggesting that I reorder the 
patches so that the 'maxdepth' change happens first. That way, I won’t 
introduce maxdepth: 2 only to change it in the next patch. Does that 
sound right?

> 
> 
>>   
>>      debugging
>>      tracepoints
>> @@ -28,7 +28,7 @@ The following are the primary tracing frameworks integrated into
>>   the Linux kernel.
>>   
>>   .. toctree::
>> -   :maxdepth: 2
>> +   :maxdepth: 1
>>   
>>      ftrace
>>      ftrace-design
>> @@ -47,7 +47,7 @@ A detailed explanation of event tracing mechanisms and their
>>   applications.
>>   
>>   .. toctree::
>> -   :maxdepth: 2
>> +   :maxdepth: 1
>>   
>>      events
>>      events-kmem
>> @@ -65,7 +65,7 @@ This section covers tracing features that monitor hardware
>>   interactions and system performance.
>>   
>>   .. toctree::
>> -   :maxdepth: 2
>> +   :maxdepth: 1
>>   
>>      intel_th
>>      stm
>> @@ -85,7 +85,7 @@ These tools allow tracing user-space applications and
>>   interactions.
>>   
>>   .. toctree::
>> -   :maxdepth: 2
>> +   :maxdepth: 1
>>   
>>      user_events
>>   
>