On Tue, 27 Nov 2018 15:42:16 +0000
Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx> wrote:
> Create man pages for tep_is_file_bigendian() and tep_set_file_bigendian()
> as part of the libtraceevent APIs.
>
> Signed-off-by: Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx>
> ---
> .../libtraceevent-file_endian.txt | 89 +++++++++++++++++++
> 1 file changed, 89 insertions(+)
> create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt
>
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt b/tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt
> new file mode 100644
> index 000000000000..2b763aaf9c6b
> --- /dev/null
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt
> @@ -0,0 +1,89 @@
> +libtraceevent(3)
> +================
> +
> +NAME
> +----
> +tep_file_bigendian,tep_set_file_bigendian - Get / set the endianess of the
> +raw data, being accessed by the tep handler.
> +
> +SYNOPSIS
> +--------
> +[verse]
> +--
> +*#include <event-parse.h>*
> +
> +enum *tep_endian* {
> + TEP_LITTLE_ENDIAN = 0,
> + TEP_BIG_ENDIAN
> +};
> +
> +int *tep_file_bigendian*(struct tep_handle pass:[*]_tep_);
> +void *tep_set_file_bigendian*(struct tep_handle pass:[*]_tep_, enum tep_endian _endian_);
> +
> +--
> +DESCRIPTION
> +-----------
> +The _tep_file_bigendian()_ function returns the endianess of the raw data,
> +being accessed by the tep handler. The _tep_ argument is trace event parser context.
FYI, I removed the comma from the above "the raw_data being accessed"
> +
> +The _tep_set_file_bigendian()_ set the endianess of raw data, the being accessed
> +by the tep handler. The _tep_ argument is trace event parser context.
I also changed the above to "of raw data being accessed"
-- Steve
> +[verse]
> +--
|