On 04/02/25 22:09, Jonathan Corbet wrote:
Purva Yeshi <purvayeshi550@xxxxxxxxx> 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@xxxxxxxxx>
---
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