On Fri, 8 Mar 2019 15:36:31 +0200 Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx> wrote: > Create man pages for tep_get_any_field_val(), tep_get_common_field_val(), > tep_get_field_val() and tep_get_field_raw() as part of the libtraceevent APIs. > > Signed-off-by: Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx> > --- > .../libtraceevent-field_get_val.txt | 117 ++++++++++++++++++ > 1 file changed, 117 insertions(+) > create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt > > diff --git a/tools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt b/tools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt > new file mode 100644 > index 000000000000..dbb4875c49fb > --- /dev/null > +++ b/tools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt > @@ -0,0 +1,117 @@ > +libtraceevent(3) > +================ > + > +NAME > +---- > +tep_get_any_field_val,tep_get_common_field_val,tep_get_field_val,tep_get_field_raw - Get value of a field. > + > +SYNOPSIS > +-------- > +[verse] > +-- > +*#include <event-parse.h>* > +*#include <trace-seq.h>* > + > +int *tep_get_any_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); > +int *tep_get_common_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); > +int *tep_get_field_val*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, unsigned long long pass:[*]_val_, int _err_); > +void pass:[*]*tep_get_field_raw*(struct trace_seq pass:[*]_s_, struct tep_event pass:[*]_event_, const char pass:[*]_name_, struct tep_record pass:[*]_record_, int pass:[*]_len_, int _err_); > +-- > + > +DESCRIPTION > +----------- > +These functions can be used to find a field and retrieve its value. > + > +The _tep_get_any_field_val()_ function searches in the _record_ for a filed with s/filed/field/ > +_name_, part of the _event_. If the field is found, its value is stored in _val_. > +In case of an error, an error string is printed into _s_, if _err_ is not 0. The above is worded in a confusing way. May want to make it: "If there is an error and _err_ is not zero, then an error string is written into _s_." > + > +The _tep_get_common_field_val()_ function does the same as > +_tep_get_any_field_val()_, but searches only in the common fields. Add "This will work for any event as all events include the common fields". > + > +The _tep_get_field_val()_ function does the same as > +_tep_get_any_field_val()_, but searches only in the event specific fields. > + > +The _tep_get_field_raw()_ function searches in the _record_ for a filed with _name_, /filed/field/ > +part of the _event_. If the field is found, a pointer to its raw data is returned. > +The size of the data is stored in _len_. In case of an error, an error string > +is printed into _s_, if _err_ is not 0. Change that last sentence too. -- Steve > + > +RETURN VALUE > +------------ > +The _tep_get_any_field_val()_, _tep_get_common_field_val()_ and > +_tep_get_field_val()_ functions return 0 on success, or -1 in case of an error. > + > +The _tep_get_field_raw()_ function returns a pointer to field's raw data, and > +places the length of this data in _len_. In case of an error NULL is returned. > +
|