doc/man: document LTTng-UST 2.13
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 25 May 2021 17:06:56 +0000 (13:06 -0400)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Mon, 7 Jun 2021 19:29:43 +0000 (15:29 -0400)
commit5b1163c6cf674c6461cc1e0ad1211924df7af789
treebe702f625285d968ad48458c3153a39044e1f31b
parente436e84d48332d559fe60c1a5eba81f03e9f38f9
doc/man: document LTTng-UST 2.13

Significant changes:

* Prefix all macro/definition names with `LTTNG_UST_` or `lttng_ust_`
  where needed.

* Prefix all log level definitions with `LTTNG_UST_TRACEPOINT_LOGLEVEL`.

* lttng-ust(3):

  * Add "Compatibility with previous APIs" section to explain
    the new `LTTNG_UST_COMPAT_API_VERSION` definition.

  * Document the new tracepoint class provider name parameter of
    `LTTNG_UST_TRACEPOINT_EVENT_INSTANCE()`.

    Update examples accordingly.

* Mention `liblttng-ust-common` where missing.

* tracef(3), vtracef(3), tracelog(3), and vtracelog(3) now indicate that
  the macros are part of version 0 of the LTTng-UST API, albeit still
  available, and point to lttng_ust_tracef(3), lttng_ust_vtracef(3),
  lttng_ust_tracelog(3), and lttng_ust_vtracelog(3).

* New lttng_ust_do_tracepoint(3), lttng_ust_tracepoint(3),
  and lttng_ust_tracepoint_enabled(3) manual pages which source
  lttng-ust(3).

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: I07d6ace0d6f219c36d7c99a455726bbf4b0736a2
15 files changed:
.gitignore
doc/man/Makefile.am
doc/man/README.md
doc/man/log-levels.txt
doc/man/lttng-gen-tp.1.txt
doc/man/lttng-ust-cyg-profile.3.txt
doc/man/lttng-ust.3.txt
doc/man/lttng_ust_do_tracepoint.3 [new file with mode: 0644]
doc/man/lttng_ust_tracef.3.txt [new file with mode: 0644]
doc/man/lttng_ust_tracelog.3.txt [new file with mode: 0644]
doc/man/lttng_ust_tracepoint.3 [new file with mode: 0644]
doc/man/lttng_ust_tracepoint_enabled.3 [new file with mode: 0644]
doc/man/tracef-tracelog-limitations.txt
doc/man/tracef.3.txt
doc/man/tracelog.3.txt
This page took 0.026069 seconds and 4 git commands to generate.