[PATCH] docs: Move "debugging" section to the top in index.rst

Purva Yeshi posted 1 patch 1 year ago
There is a newer version of this series
Documentation/trace/index.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: Move "debugging" section to the top in index.rst
Posted by Purva Yeshi 1 year ago
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@gmail.com>
---
 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
    timerlat-tracer
-- 
2.34.1
Re: [PATCH] docs: Move "debugging" section to the top in index.rst
Posted by Purva Yeshi 1 year ago
On 04/02/25 01:23, Purva Yeshi wrote:
> 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@gmail.com>
> ---
>   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
>      timerlat-tracer

Apologies for not including all the relevant recipients in this patch 
submission. I forgot to run the get_maintainer.pl script, but now I am 
sending the patch again to the correct recipients.

Best Regards,
Purva Yeshi