tracing: Add histogram-design document
authorTom Zanussi <zanussi@kernel.org>
Fri, 3 Apr 2020 19:31:20 +0000 (14:31 -0500)
committerSteven Rostedt (VMware) <rostedt@goodmis.org>
Mon, 1 Jun 2020 12:22:04 +0000 (08:22 -0400)
commit16b585fe71924b3aebaef5548a291021efaf7c7f
tree0c63907309fe5880714f090d883bbe41a40a7def
parent1b94b3aed367ff2cdc84d325e0aa9d7cc9e3cf2a
tracing: Add histogram-design document

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 <zanussi@kernel.org>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Documentation/trace/histogram-design.rst [new file with mode: 0644]