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

From: Suraj Sonawane
Date: Fri Oct 11 2024 - 03:12:41 EST


On 11/10/24 01:21, Jonathan Corbet wrote:
Steven Rostedt <rostedt@xxxxxxxxxxx> writes:

On Thu, 3 Oct 2024 01:28:17 +0530
SurajSonawane2415 <surajsonawane0215@xxxxxxxxx> wrote:

Add debugging.rst to the relevant toctree to fix warning
about missing documentation inclusion in toctree.

Signed-off-by: SurajSonawane2415 <surajsonawane0215@xxxxxxxxx>
---
Documentation/trace/index.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 0b300901f..2c991dc96 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -24,6 +24,7 @@ Linux Tracing Technologies
histogram
histogram-design
boottime-trace
+ debugging

If order matters here, I'd like the debugging to be at the top. As I plan
on it being more of a tutorial for using tracing, and should be the first
document people see.


Thanks for the feedback!

I need to take some time out and start filling it up!

That's the order that the links will show up in the rendered page, so
yes, it matters.

jon
Can I send an updated patch with this change (moving debugging section to the top)?

Best,
Suraj