linux-kernel - Re: [PATCH] docs: fix WARNING document not included in any toctree

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: <2ccc6f29-45d1-48b4-b39f-3b2a01cb6068@gmail.com>
Date: Fri, 11 Oct 2024 19:39:12 +0530
From: Suraj Sonawane <surajsonawane0215@...il.com>
To: Jonathan Corbet <corbet@....net>, Steven Rostedt <rostedt@...dmis.org>
Cc: mhiramat@...nel.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: fix WARNING document not included in any toctree

On 11/10/24 18:58, Jonathan Corbet wrote:
> Suraj Sonawane <surajsonawane0215@...il.com> writes:
> 
>> Can I send an updated patch with this change (moving debugging section
>> to the top)?
> 
> The patch is already applied, so no.  You can send a new patch against
> docs-next if that sort of movement is warranted.

Sure! I will send a patch against docs-next to move the debugging 
section to the top.

> 
> Honestly, though, just shuffling one file around only seems so useful.
> What would be nice would be to turn index.rst into a good starting point
> for people wanting to learn about tracing, rather than just a jumble of
> files.  It needs organization into sections and some connecting text; as
> an example, see the (minimal) organizational work that I did for
> Documentation/process/index.rst.
> 
> It's more work, but would certainly pay off.
> 
> Thanks,
> 
> jon

I’ve also seen the structure in Documentation/process/index.rst with the 
clear titles and descriptions.

Thanks,
Suraj Sonawane