From 5cc8729236a95d784e9561abbcb93a0fce90890c 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 | 3 +++ doc/man/Makefile.am | 7 ++++--- doc/man/lttng-ust.3.txt | 7 ++++--- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/configure.ac b/configure.ac index a1c12412..05c343b7 100644 --- a/configure.ac +++ b/configure.ac @@ -609,6 +609,9 @@ AC_SUBST(AM_CPPFLAGS) AC_SUBST(JNI_CPPFLAGS) +# Used in man pages +AC_SUBST([LTTNG_UST_MAJOR_VERSION], ust_version_major) +AC_SUBST([LTTNG_UST_MINOR_VERSION], ust_version_minor) ## ## ## Output files generated by configure ## diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 29c06739..94510d4e 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -76,13 +76,14 @@ xmlto_verbose_out_ = $(xmlto_verbose_out_@AM_DEFAULT_V@) xmlto_verbose_out_0 = 2>/dev/null # Tools to execute: -ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \ +ADOC = $(asciidoc_verbose)$(ASCIIDOC) -v -f $(ASCIIDOC_CONF) -d manpage \ -a mansource="LTTng" \ -a manmanual="LTTng Manual" \ - -a manversion="$(PACKAGE_VERSION)" + -a manversion="$(PACKAGE_VERSION)" \ + -a lttng_version="$(LTTNG_UST_MAJOR_VERSION).$(LTTNG_UST_MINOR_VERSION)" ADOC_DOCBOOK = $(ADOC) -b docbook -XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man +XTO = $(xmlto_verbose)$(XMLTO) -v -m $(XSL_FILE) man # Recipes: %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS) diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt index 0864b9a3..601ebec8 100644 --- a/doc/man/lttng-ust.3.txt +++ b/doc/man/lttng-ust.3.txt @@ -1230,8 +1230,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 @@ -1545,7 +1546,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. @@ -1554,7 +1555,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_MAP_POPULATE_POLICY`:: + -- 2.34.1