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

From: Suraj Sonawane
Date: Fri Oct 11 2024 - 10:09:28 EST


On 11/10/24 18:58, Jonathan Corbet wrote:
Suraj Sonawane <surajsonawane0215@xxxxxxxxx> 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