From 5b46d907b448bf793a6dfc219c9826d51575c33a Mon Sep 17 00:00:00 2001 From: Kienan Stewart Date: Thu, 2 May 2024 16:51:45 -0400 Subject: [PATCH] docs: Correct GitHub URLs in lttng-ust.3 The branches follow the format `stable-X.YZ` rather than `vX.YZ`. Furthermore, when rendering the man pages from source, the URLs were omitted completely as the subsitution `{lttng_version}` was not defined. This hasn't been an issue for the published HTML versions as those are produced via a different script in the `lttng-www` project which presumably sets the substitution properly. Change-Id: Ib96c99df13ddf724e128f95e7ce7c74b2c10c766 Signed-off-by: Kienan Stewart Signed-off-by: Mathieu Desnoyers --- configure.ac | 4 ++++ doc/man/Makefile.am | 3 ++- doc/man/lttng-ust.3.txt | 7 ++++--- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/configure.ac b/configure.ac index eeb02f67..ef0d0d15 100644 --- a/configure.ac +++ b/configure.ac @@ -554,6 +554,10 @@ AM_CFLAGS="-Wall" AC_SUBST(AM_CFLAGS) AC_SUBST(JNI_CPPFLAGS) +# Used in man pages +AC_SUBST([LTTNG_UST_MAJOR_VERSION], V_MAJOR) +AC_SUBST([LTTNG_UST_MINOR_VERSION], V_MINOR) + AC_CONFIG_FILES([ Makefile doc/Makefile diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index f562bfd1..85c7eb4d 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -59,7 +59,8 @@ xmlto_verbose_0 = @echo " XMLTO " $@; # Tools to execute: ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \ -a lttng_version="$(PACKAGE_VERSION)" \ - -a lttng_ust_register_timeout="@LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS@" + -a lttng_ust_register_timeout="@LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS@" \ + -a lttng_version="$(LTTNG_UST_MAJOR_VERSION).$(LTTNG_UST_MINOR_VERSION)" ADOC_DOCBOOK = $(ADOC) -b docbook XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt index 02c94836..c1cd13a2 100644 --- a/doc/man/lttng-ust.3.txt +++ b/doc/man/lttng-ust.3.txt @@ -1091,8 +1091,9 @@ if (lttng_ust_loaded) { [[example]] EXAMPLE ------- + NOTE: A few examples are available in the -https://github.com/lttng/lttng-ust/tree/v{lttng_version}/doc/examples[`doc/examples`] +https://github.com/lttng/lttng-ust/tree/stable-{lttng_version}/doc/examples[`doc/examples`] directory of LTTng-UST's source tree. This example shows all the features documented in the previous @@ -1384,7 +1385,7 @@ affect application timings. Path to the shared object which acts as the clock override plugin. An example of such a plugin can be found in the LTTng-UST documentation under - https://github.com/lttng/lttng-ust/tree/v{lttng_version}/doc/examples/clock-override[`examples/clock-override`]. + https://github.com/lttng/lttng-ust/tree/stable-{lttng_version}/doc/examples/clock-override[`examples/clock-override`]. `LTTNG_UST_DEBUG`:: If set, enable `liblttng-ust`'s debug and error output. @@ -1393,7 +1394,7 @@ affect application timings. Path to the shared object which acts as the `getcpu()` override plugin. An example of such a plugin can be found in the LTTng-UST documentation under - https://github.com/lttng/lttng-ust/tree/v{lttng_version}/doc/examples/getcpu-override[`examples/getcpu-override`]. + https://github.com/lttng/lttng-ust/tree/stable-{lttng_version}/doc/examples/getcpu-override[`examples/getcpu-override`]. `LTTNG_UST_REGISTER_TIMEOUT`:: Waiting time for the _registration done_ session daemon command -- 2.34.1