[PATCH v2 0/2] Table of contents refactoring for tracing docs

[PATCH v2 0/2] Table of contents refactoring for tracing docs

[Bagas Sanjaya]

Hi,

The trace toctree refactoring series [1] didn't make it through 6.15
merge window previously, so I forwarded it targeting 6.16 via
docs-next tree instead.

Enjoy!

Changes since v1 [2]:

  - Remove mention of individual docs' toctree as the generated sidebar
    toctree don't include them ([patch 1/2])
  - Move uprobetracer to user-space tracing section (Steven, [patch 2/2])

[1]: https://lore.kernel.org/linux-doc/20250318113230.24950-1-purvayeshi550@gmail.com/T/#u
[2]: https://lore.kernel.org/linux-doc/20250415034613.21305-1-bagasdotme@gmail.com/

Purva Yeshi (2):
  Documentation: trace: Reduce toctree depth
  Documentation: trace: Refactor toctree

 Documentation/trace/index.rst | 98 +++++++++++++++++++++++++++++------
 1 file changed, 81 insertions(+), 17 deletions(-)


base-commit: 43e9076a00b17cf8115b4bd4d3b2be33a44245ca
-- 
An old man doll... just what I always wanted! - Clara

[PATCH v2 1/2] Documentation: trace: Reduce toctree depth

[Bagas Sanjaya]

From: Purva Yeshi <purvayeshi550@gmail.com>

Reduce toctree depth from 2 to 1 so that only docs titles are listed
in the toctree.

Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250318113230.24950-1-purvayeshi550@gmail.com
[Bagas: massage commit message]
Signed-off-by: Bagas Sanjaya <bagasdotme@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 2c991dc96ace60..fecc4adf70a830 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -3,7 +3,7 @@ Linux Tracing Technologies
 ==========================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    ftrace-design
    tracepoint-analysis
-- 
An old man doll... just what I always wanted! - Clara

[PATCH v2 2/2] Documentation: trace: Refactor toctree

[Bagas Sanjaya]

From: Purva Yeshi <purvayeshi550@gmail.com>

Refactor table of contents of kernel tracing subsystem docs to improve
clarity, structure, and organization:

- Reformat sections and add appropriate headings
- Improve section grouping and refine descriptions for each group
- Add docs intro paragraph

Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250318113230.24950-2-purvayeshi550@gmail.com
[Bagas: massage commit message and address reviews]
Co-developed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/trace/index.rst | 96 +++++++++++++++++++++++++++++------
 1 file changed, 80 insertions(+), 16 deletions(-)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index fecc4adf70a830..cc1dc5a087e8b1 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -1,39 +1,103 @@
-==========================
-Linux Tracing Technologies
-==========================
+================================
+Linux Tracing Technologies Guide
+================================
+
+Tracing in the Linux kernel is a powerful mechanism that allows
+developers and system administrators to analyze and debug system
+behavior. This guide provides documentation on various tracing
+frameworks and tools available in the Linux kernel.
+
+Introduction to Tracing
+-----------------------
+
+This section provides an overview of Linux tracing mechanisms
+and debugging approaches.
 
 .. toctree::
    :maxdepth: 1
 
-   ftrace-design
+   debugging
+   tracepoints
    tracepoint-analysis
+   ring-buffer-map
+
+Core Tracing Frameworks
+-----------------------
+
+The following are the primary tracing frameworks integrated into
+the Linux kernel.
+
+.. toctree::
+   :maxdepth: 1
+
    ftrace
+   ftrace-design
    ftrace-uses
-   fprobe
    kprobes
    kprobetrace
-   uprobetracer
    fprobetrace
-   tracepoints
+   fprobe
+   ring-buffer-design
+
+Event Tracing and Analysis
+--------------------------
+
+A detailed explanation of event tracing mechanisms and their
+applications.
+
+.. toctree::
+   :maxdepth: 1
+
    events
    events-kmem
    events-power
    events-nmi
    events-msr
-   mmiotrace
+   boottime-trace
    histogram
    histogram-design
-   boottime-trace
-   debugging
-   hwlat_detector
-   osnoise-tracer
-   timerlat-tracer
+
+Hardware and Performance Tracing
+--------------------------------
+
+This section covers tracing features that monitor hardware
+interactions and system performance.
+
+.. toctree::
+   :maxdepth: 1
+
    intel_th
-   ring-buffer-design
-   ring-buffer-map
    stm
    sys-t
    coresight/index
-   user_events
    rv/index
    hisi-ptt
+   mmiotrace
+   hwlat_detector
+   osnoise-tracer
+   timerlat-tracer
+
+User-Space Tracing
+------------------
+
+These tools allow tracing user-space applications and
+interactions.
+
+.. toctree::
+   :maxdepth: 1
+
+   user_events
+   uprobetracer
+
+Additional Resources
+--------------------
+
+For more details, refer to the respective documentation of each
+tracing tool and framework.
+
+.. only:: subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v2 0/2] Table of contents refactoring for tracing docs

[Steven Rostedt]

On Wed, 16 Apr 2025 09:40:48 +0700
Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> Hi,
> 
> The trace toctree refactoring series [1] didn't make it through 6.15
> merge window previously, so I forwarded it targeting 6.16 via
> docs-next tree instead.
> 
> Enjoy!
> 
> Changes since v1 [2]:
> 
>   - Remove mention of individual docs' toctree as the generated sidebar
>     toctree don't include them ([patch 1/2])
>   - Move uprobetracer to user-space tracing section (Steven, [patch 2/2])
> 
> [1]: https://lore.kernel.org/linux-doc/20250318113230.24950-1-purvayeshi550@gmail.com/T/#u
> [2]: https://lore.kernel.org/linux-doc/20250415034613.21305-1-bagasdotme@gmail.com/
> 
> Purva Yeshi (2):
>   Documentation: trace: Reduce toctree depth
>   Documentation: trace: Refactor toctree
> 
>  Documentation/trace/index.rst | 98 +++++++++++++++++++++++++++++------
>  1 file changed, 81 insertions(+), 17 deletions(-)

Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

for both patches.

Jon, feel free to take this through your tree.

Thanks,

-- Steve

Re: [PATCH v2 0/2] Table of contents refactoring for tracing docs

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Hi,
>
> The trace toctree refactoring series [1] didn't make it through 6.15
> merge window previously, so I forwarded it targeting 6.16 via
> docs-next tree instead.
>
> Enjoy!
>
> Changes since v1 [2]:
>
>   - Remove mention of individual docs' toctree as the generated sidebar
>     toctree don't include them ([patch 1/2])
>   - Move uprobetracer to user-space tracing section (Steven, [patch 2/2])
>
> [1]: https://lore.kernel.org/linux-doc/20250318113230.24950-1-purvayeshi550@gmail.com/T/#u
> [2]: https://lore.kernel.org/linux-doc/20250415034613.21305-1-bagasdotme@gmail.com/
>
> Purva Yeshi (2):
>   Documentation: trace: Reduce toctree depth
>   Documentation: trace: Refactor toctree
>
>  Documentation/trace/index.rst | 98 +++++++++++++++++++++++++++++------
>  1 file changed, 81 insertions(+), 17 deletions(-)

Applied, thanks.

jon