Re: [PATCH v3 09/46] tools/lib/traceevent: Man page for tep_is_host_bigendian() and tep_set_host_bigendian()

[Steven Rostedt <rostedt@goodmis.org>]

On Tue, 27 Nov 2018 15:42:17 +0000
Tzvetomir Stoyanov <tstoyanov@vmware.com> wrote:

> Create man pages for tep_is_host_bigendian() and tep_set_host_bigendian()
> as part of the libtraceevent APIs.
> 
> Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
> ---
>  .../libtraceevent-host_endian.txt             | 90 +++++++++++++++++++
>  1 file changed, 90 insertions(+)
>  create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-host_endian.txt
> 
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-host_endian.txt b/tools/lib/traceevent/Documentation/libtraceevent-host_endian.txt
> new file mode 100644
> index 000000000000..250eb430c06a
> --- /dev/null
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-host_endian.txt
> @@ -0,0 +1,90 @@
> +libtraceevent(3)
> +================
> +
> +NAME
> +----
> +tep_is_host_bigendian,tep_set_host_bigendian,tep_host_bigendian - Get / set the endianess of 
> +the machine running the current code.
> +
> +SYNOPSIS
> +--------
> +[verse]
> +--
> +*#include <event-parse.h>*
> +
> +enum *tep_endian* {
> +	TEP_LITTLE_ENDIAN = 0,
> +	TEP_BIG_ENDIAN
> +};
> +
> +int *tep_is_host_bigendian*(struct tep_handle pass:[*]_tep_);
> +void *tep_set_host_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_);
> +int tep_host_bigendian(void);
> +--
> +
> +DESCRIPTION
> +-----------
> +The _tep_is_host_bigendian()_ function returns the endianess of the the machine 
> +running the current code. The _tep_ argument is trace event parser context.
> +
> +The _tep_set_host_bigendian()_ set the endianess of the machine running the code.
> +The _tep_ argument is trace event parser context. The _endian_ argument is the endianess:
> +[verse]

FYI,

I changed the above to to read "_tep_ argument is the trace event
parser context"

-- Steve

> +--
>