| Message ID | 20190308133654.21264-41-tstoyanov@vmware.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Libtraceevent MAN pages | expand |
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
> On Mar 8, 2019, at 5:36 AM, Tzvetomir Stoyanov <tstoyanov@vmware.com> wrote: > > Create man page for tep_data_lat_fmt() > as part of the libtraceevent APIs. > > 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. It’s not exactly an issue with this man page but I notice that, unlike a sampling of libtraceevent API function names in this series, this one is quite abbreviated. Is it called very often? Would it make sense to rename it to be as clear as the other function names? tep_data_latency_format seems much clearer to me. > + > +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. This one is missing the RETURN VALUE section. Cheers, -Matt
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
Create man page for tep_data_lat_fmt() as part of the libtraceevent APIs. 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