linux-kernel - Re: [PATCH] docs: Move "debugging" section to the top in index.rst

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: <ffe61212-1b2c-4db2-9e7b-e50748075495@gmail.com>
Date: Wed, 5 Feb 2025 19:01:15 +0530
From: Purva Yeshi <purvayeshi550@...il.com>
To: Jonathan Corbet <corbet@....net>, rostedt@...dmis.org, mhiramat@...nel.org
Cc: 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] docs: Move "debugging" section to the top in index.rst

On 04/02/25 22:09, Jonathan Corbet wrote:
> Purva Yeshi <purvayeshi550@...il.com> writes:
> 
>> Move the "debugging" entry to the top in Documentation/trace/index.rst.
>> Turn index.rst into a good starting point for people wanting to learn
>> about tracing. Make it the first document users see, as it serves as a
>> tracing tutorial
>>
>> Signed-off-by: Purva Yeshi <purvayeshi550@...il.com>
>> ---
>>   Documentation/trace/index.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
>> index 2c991dc96ace..f3d235c8438b 100644
>> --- a/Documentation/trace/index.rst
>> +++ b/Documentation/trace/index.rst
>> @@ -5,6 +5,7 @@ Linux Tracing Technologies
>>   .. toctree::
>>      :maxdepth: 2
>>   
>> +   debugging
>>      ftrace-design
>>      tracepoint-analysis
>>      ftrace
>> @@ -24,7 +25,6 @@ Linux Tracing Technologies
>>      histogram
>>      histogram-design
>>      boottime-trace
>> -   debugging
>>      hwlat_detector
>>      osnoise-tracer
> 
> So I totally approve of improving our index.rst files.  Without some
> occasional maintenance, they become unorganized dumping grounds, and
> Documentation/trace appears to be no exception.
> 
> This small change does not really help, though.  Could I please
> encourage you to consider bringing some real order to this page?  As an
> example, you could look at commit 270beb5b2aae from 6.13.
> 
> Thanks,
> 
> jon

Thanks for your feedback. I'll review commit 270beb5b2aae and work on a 
more comprehensive reorganization to bring better order to 
Documentation/trace/index.rst page.

I'll follow up with an updated patch soon.

Best regards,
Purva Yeshi