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 for Android: free password hash cracker in your pocket

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

Message-ID: <20241011095413.0e57758f@gandalf.local.home>
Date: Fri, 11 Oct 2024 09:54:13 -0400
From: Steven Rostedt <rostedt@...dmis.org>
To: Jonathan Corbet <corbet@....net>
Cc: Suraj Sonawane <surajsonawane0215@...il.com>, 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 Fri, 11 Oct 2024 07:28:40 -0600
Jonathan Corbet <corbet@....net> 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.
> 
> 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.

I'm still new to how the Documentation directory is set up. But I agree
with Jon. It's been on my todo list to make the tracing directory more of a
tutorial. I just need to find the time to do so.

-- Steve