[v6,09/26] tools/lib/traceevent: Man page for tep_strerror()

Commit Message

Tzvetomir Stoyanov May 3, 2019, 9:11 a.m. UTC

Create man page for tep_strerror() libtraceevent API.

Signed-off-by: Tzvetomir Stoyanov <[e-mail]>
---
 .../Documentation/libtraceevent-strerror.txt  | 84 +++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-strerror.txt

Comments

Steven Rostedt May 10, 2019, 5:48 p.m. UTC | #1

On Fri,  3 May 2019 12:11:02 +0300
Tzvetomir Stoyanov <[e-mail]> wrote:

> +It as a thread safe wrapper around strerror_r(). The library function has two
> +different behaviors - POSIX and GNU specific. The _tep_strerror()_ API behaves
> +as the POSIX version - the error string is copied in the user supplied buffer.

I updated this to say "API always behaves as the POSIX version", to
remove any ambiguity.

Thanks!

-- Steve

Patch

diff --git a/tools/lib/traceevent/Documentation/libtraceevent-strerror.txt b/tools/lib/traceevent/Documentation/libtraceevent-strerror.txt
new file mode 100644
index 000000000000..14a9c6b916e1
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-strerror.txt
@@ -0,0 +1,84 @@ 
+libtraceevent(3)
+================
+
+NAME
+----
+tep_strerror - Returns a string describing regular errno and tep error number.
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <event-parse.h>*
+
+int *tep_strerror*(struct tep_handle pass:[*]_tep_, enum tep_errno _errnum_, char pass:[*]_buf_, size_t _buflen_);
+
+--
+DESCRIPTION
+-----------
+The _tep_strerror()_ function converts tep error number into a human
+readable string.
+The _tep_ argument is trace event parser context. The _errnum_ is a regular
+errno, defined in errno.h, or a tep error number. The string, describing this
+error number is copied in the _buf_ argument. The _buflen_ argument is
+the size of the _buf_.
+
+It as a thread safe wrapper around strerror_r(). The library function has two
+different behaviors - POSIX and GNU specific. The _tep_strerror()_ API behaves
+as the POSIX version - the error string is copied in the user supplied buffer.
+
+RETURN VALUE
+------------
+The _tep_strerror()_ function returns 0, if a valid _errnum_ is passed and the
+string is copied into _buf_. If _errnum_ is not a valid error number,
+-1 is returned and _buf_ is not modified.
+
+EXAMPLE
+-------
+[source,c]
+--
+#include <event-parse.h>
+...
+struct tep_handle *tep = tep_alloc();
+...
+char buf[32];
+char *pool = calloc(1, 128);
+if (tep == NULL) {
+	tep_strerror(tep, TEP_ERRNO__MEM_ALLOC_FAILED, buf, 32);
+	printf ("The pool is not initialized, %s", buf);
+}
+...
+--
+
+FILES
+-----
+[verse]
+--
+*event-parse.h*
+	Header file to include in order to have access to the library APIs.
+*-ltraceevent*
+	Linker switch to add when building a program that uses the library.
+--
+
+SEE ALSO
+--------
+_libtraceevent(3)_, _trace-cmd(1)_
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <[e-mail]>, author of *libtraceevent*.
+*Tzvetomir Stoyanov* <[e-mail]>, author of this man page.
+--
+REPORTING BUGS
+--------------
+Report bugs to  <[e-mail]>
+
+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