Re: [PATCH v4 40/46] tools/lib/traceevent: Man page for tep_data_lat_fmt()

[Steven Rostedt <rostedt@goodmis.org>]

On Fri,  8 Mar 2019 15:36:48 +0200
Tzvetomir Stoyanov <tstoyanov@vmware.com> wrote:

> Create man page for tep_data_lat_fmt()
> as part of the libtraceevent APIs.

This should be included in the same man page as
tep_set_latency_format and tep_is_latency_format.

-- Steve

> 
> Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
> ---
>  .../libtraceevent-record_lat.txt              | 77 +++++++++++++++++++
>  1 file changed, 77 insertions(+)
>  create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt
> 
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt
> new file mode 100644
> index 000000000000..f4e37b186f61
> --- /dev/null
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-record_lat.txt
> @@ -0,0 +1,77 @@
> +libtraceevent(3)
> +================
> +
> +NAME
> +----
> +tep_data_lat_fmt - Parses the data for the latency format.
> +
> +SYNOPSIS
> +--------
> +[verse]
> +--
> +*#include <event-parse.h>*
> +
> +void *tep_data_lat_fmt*(struct tep_handle pass:[*]_tep_, struct trace_seq pass:[*]_s_, struct tep_record pass:[*]_record_);
> +--
> +DESCRIPTION
> +-----------
> +The _tep_data_lat_fmt()_ function parses out the latency format (interrupts
> +disabled, need rescheduling, in hard/soft interrupt, preempt count and
> +lock depth) from _record_ and places it into the _s_.  The _tep_ argument is
> +the trace event parser context.
> +
> +EXAMPLE
> +-------
> +[source,c]
> +--
> +#include <event-parse.h>
> +#include <trace-seq.h>
> +...
> +struct tep_handle *tep = tep_alloc();
> +struct trace_seq seq;
> +trace_seq_init(&seq);
> +...
> +void process_record(struct tep_record *record)
> +{
> +	/* Place latency information in the seq */
> +	tep_data_lat_fmt(tep, &seq, record);
> +}
> +...
> +--
> +
> +FILES
> +-----
> +[verse]
> +--
> +*event-parse.h*
> +	Header file to include in order to have access to the library APIs.
> +*trace-seq.h*
> +	Header file to include in order to have access to trace sequences related APIs.
> +	Trace sequences are used to allow a function to call several other functions
> +	to create a string of data to use.
> +*-ltraceevent*
> +	Linker switch to add when building a program that uses the library.
> +--
> +
> +SEE ALSO
> +--------
> +_libtraceevent(3)_, _trace-cmd(1)_,_tep_set_latency_format(3)_
> +
> +AUTHOR
> +------
> +[verse]
> +--
> +*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
> +*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
> +--
> +REPORTING BUGS
> +--------------
> +Report bugs to  <linux-trace-devel@vger.kernel.org>
> +
> +LICENSE
> +-------
> +libtraceevent is Free Software licensed under the GNU LGPL 2.1
> +
> +RESOURCES
> +---------
> +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git