Re: [PATCH v5 22/30] tools/lib/traceevent: Man page for tep_read_number_field()

[Steven Rostedt <rostedt@goodmis.org>]

On Fri, 12 Apr 2019 16:38:03 +0300
Tzvetomir Stoyanov <tstoyanov@vmware.com> wrote:

> Create man page for libtraceevent API tep_read_number_field().
> 
> Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
> ---
>  .../libtraceevent-field_read.txt              | 80 +++++++++++++++++++
>  1 file changed, 80 insertions(+)
>  create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_read.txt
> 
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-field_read.txt b/tools/lib/traceevent/Documentation/libtraceevent-field_read.txt
> new file mode 100644
> index 000000000000..0c560c416ac2
> --- /dev/null
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-field_read.txt
> @@ -0,0 +1,80 @@
> +libtraceevent(3)
> +================
> +
> +NAME
> +----
> +tep_read_number_field - Reads a number from a raw data.

 "Reads a number from raw data"

> +
> +SYNOPSIS
> +--------
> +[verse]
> +--
> +*#include <event-parse.h>*
> +
> +int *tep_read_number_field*(struct tep_format_field pass:[*]_field_, const void pass:[*]_data_, unsigned long long pass:[*]_value_);
> +--
> +
> +DESCRIPTION
> +-----------
> +The _tep_read_number_field()_ function reads the value of the _field_ from the
> +raw _data_ and stores it in the _value_. The function sets the _value_ according

 and stores it in _value_

-- Steve

> +to the endianness of the raw data and the current machine.
> +