linux-toradex.git/Documentation/trace/histogram-design.rst, branch v7.0-rc2

Documentation: trace: histogram-design: Wrap introductory note in note:: directive

2025-09-18T17:49:26+00:00

Use Sphinx note:: directive for the introductory note at the beginning
of docs, instead of aligned-text paragraph that renders as definition
list.

Reviewed-by: Tom Zanussi 
Reviewed-by: Masami Hiramatsu (Google) 
Signed-off-by: Bagas Sanjaya 
Acked-by: Steven Rostedt (Google) 
Signed-off-by: Jonathan Corbet 
Message-ID: <20250916054202.582074-6-bagasdotme@gmail.com>

Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram

2025-09-18T17:49:26+00:00

Section heading for sched_waking histogram is shown as normal paragraph
instead due to codeblock marker for the following diagram being in the
same line as the section underline. Separate them.

Fixes: daceabf1b494 ("tracing/doc: Fix ascii-art in histogram-design.rst")
Reviewed-by: Tom Zanussi 
Reviewed-by: Masami Hiramatsu (Google) 
Signed-off-by: Bagas Sanjaya 
Acked-by: Steven Rostedt (Google) 
Signed-off-by: Jonathan Corbet 
Message-ID: <20250916054202.582074-5-bagasdotme@gmail.com>

Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text

2025-09-18T17:49:26+00:00

Diagram explanation text is supposed to be interleaved commentary
between diagram parts that are spread out, but it outputs ugly in
htmldocs due to trailing vertices as if both the explanation and the
diagram are in the same literal code block.

Trim trailing vertices.

Reviewed-by: Tom Zanussi 
Reviewed-by: Masami Hiramatsu (Google) 
Signed-off-by: Bagas Sanjaya 
Acked-by: Steven Rostedt (Google) 
Signed-off-by: Jonathan Corbet 
Message-ID: <20250916054202.582074-4-bagasdotme@gmail.com>

docs: ftrace: always use canonical ftrace path

2023-01-31T21:02:30+00:00

The canonical location for the tracefs filesystem is at /sys/kernel/tracing.

But, from Documentation/trace/ftrace.rst:

  Before 4.1, all ftrace tracing control files were within the debugfs
  file system, which is typically located at /sys/kernel/debug/tracing.
  For backward compatibility, when mounting the debugfs file system,
  the tracefs file system will be automatically mounted at:

  /sys/kernel/debug/tracing

Many parts of Documentation still reference this older debugfs path, so
let's update them to avoid confusion.

Signed-off-by: Ross Zwisler 
Reviewed-by: Steven Rostedt (Google) 
Link: https://lore.kernel.org/r/20230125213251.2013791-1-zwisler@google.com
Signed-off-by: Jonathan Corbet

Documentation: trace/histogram-design: drop doubled words

2020-07-05T20:40:55+00:00

Drop the doubled words "to" and "the".

Signed-off-by: Randy Dunlap 
Cc: Jonathan Corbet 
Cc: linux-doc@vger.kernel.org
Cc: Steven Rostedt 
Cc: Ingo Molnar 
Link: https://lore.kernel.org/r/20200703212453.30553-3-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet

tracing/doc: Fix ascii-art in histogram-design.rst

2020-06-03T23:38:13+00:00

This fixes the Sphinx parallel build error when building htmldocs:

  docutils.utils.SystemMessage: /home/sfr/next/next/Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.

It also fixes a bunch of other warnings I noticed when fixing the
above, caused by mixing ascii-art and text.

Link: https://lkml.kernel.org/r/69c291c76964642a417e5dd170d183ba6b552010.camel@kernel.org

Reported-by: Stephen Rothwell 
Tested-by: Stephen Rothwell 
Signed-off-by: Tom Zanussi 
Signed-off-by: Steven Rostedt (VMware)

tracing/doc: Fix typos in histogram-design.rst

2020-06-01T12:22:46+00:00

There's a few typos in the histogram-design.rst document that need need to
be fixed.

Cc: Tom Zanussi 
Acked-by: Randy Dunlap 
Signed-off-by: Steven Rostedt (VMware)

tracing: Add histogram-design document

2020-06-01T12:22:04+00:00

Add a new Documentation/trace/histogram-design.rst file describing the
ftrace histogram low-level design, meant to help developers trying to
understand the internals when extending or making use of the hist
triggers for higher-level tools.

This documentation refers to the hist_debug files implemented by
'tracing: Add hist_debug trace event files for histogram debugging' so
users wishing to try out the test examples here should make sure
CONFIG_HIST_TRIGGERS_DEBUG is enabled.

Link: http://lkml.kernel.org/r/256b29c3274bb89a10157c4a8d1a8bce7e74849e.1585941485.git.zanussi@kernel.org

Signed-off-by: Tom Zanussi 
Signed-off-by: Steven Rostedt (VMware)