From 7fce6bd50990f582e0b81401dd8ffc25841af626 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 9 Jun 2021 15:26:01 -0400 Subject: [PATCH] doc/man: remove vtracef() and vtracelog() manual pages Following 2268c76f ("Remove vtracelog and vtracef from v0 compat API"), this patch removes the manual pages of vtracef() and vtracelog() which don't exist. Signed-off-by: Philippe Proulx Signed-off-by: Mathieu Desnoyers Change-Id: I1a07c74b330015ee74bb92235db2171066751503 --- .gitignore | 2 -- doc/man/Makefile.am | 15 +++++---------- doc/man/tracef.3.txt | 13 +++++-------- doc/man/tracelog.3.txt | 14 ++++++-------- 4 files changed, 16 insertions(+), 28 deletions(-) diff --git a/.gitignore b/.gitignore index 884189be..3e36981f 100644 --- a/.gitignore +++ b/.gitignore @@ -71,8 +71,6 @@ cscope.* /doc/man/lttng-ust.3 /doc/man/tracef.3 /doc/man/tracelog.3 -/doc/man/vtracef.3 -/doc/man/vtracelog.3 /doc/man/lttng_ust_tracef.3 /doc/man/lttng_ust_tracelog.3 /doc/man/lttng_ust_vtracef.3 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index fed0e344..4072c512 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -20,7 +20,7 @@ MAN3_NAMES = \ tracelog # Man page aliases (generated from other sources): -MAN3_ALIASES = lttng_ust_vtracef.3 lttng_ust_vtracelog.3 vtracef.3 vtracelog.3 +MAN3_ALIASES = lttng_ust_vtracef.3 lttng_ust_vtracelog.3 # troff man pages: MAN3_TROFF = \ @@ -92,15 +92,10 @@ XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< -# These pair of files are generated by a single invocation of xmlto, use an -# empty rule that depends on a fake intermediate file to track the dependencies -# without resorting to Group Targets which were only introduced in GNU Make 4.3. -tracef.3 vtracef.3: tracef.3.alias - @# Empty recipe to mark tracef.3 and vtracef.3 as rebuilt - -tracelog.3 vtracelog.3: tracelog.3.alias - @# Empty recipe to mark tracelog.3 and vtracelog.3 as rebuilt - +# These pair of files are generated by a single invocation of xmlto, use +# an empty rule that depends on a fake intermediate file to track the +# dependencies without resorting to Group Targets which were only +# introduced in GNU Make 4.3. lttng_ust_tracef.3 lttng_ust_vtracef.3: lttng_ust_tracef.3.alias @# Empty recipe to mark lttng_ust_tracef.3 and lttng_ust_vtracef.3 as rebuilt diff --git a/doc/man/tracef.3.txt b/doc/man/tracef.3.txt index dc2b293b..165e7261 100644 --- a/doc/man/tracef.3.txt +++ b/doc/man/tracef.3.txt @@ -5,7 +5,7 @@ tracef(3) NAME ---- -tracef, vtracef - LTTng-UST printf(3)-like interface +tracef - LTTng-UST printf(3)-like interface SYNOPSIS @@ -15,20 +15,17 @@ SYNOPSIS [verse] #define *tracef*('fmt', ...) -#define *vtracef*('fmt', 'ap') Link with `-llttng-ust -llttng-ust-common`. DESCRIPTION ----------- -The `tracef()` and `vtracef()` macros are part of version{nbsp}0 of the -LTTng-UST API (see the ``Compatibility with previous APIs'' section of -man:lttng-ust(3)). +The `tracef()` macro is part of version{nbsp}0 of the LTTng-UST API (see +the ``Compatibility with previous APIs'' section of man:lttng-ust(3)). -Prefer using man:lttng_ust_tracef(3) and man:lttng_ust_vtracef(3) which -are part of version{nbsp}1 of the API and have the `lttng_ust_` -namespace. +Prefer using man:lttng_ust_tracef(3) which is part of version{nbsp}1 of +the API and has the `lttng_ust_` namespace. include::common-footer.txt[] diff --git a/doc/man/tracelog.3.txt b/doc/man/tracelog.3.txt index 13284636..5f1603b9 100644 --- a/doc/man/tracelog.3.txt +++ b/doc/man/tracelog.3.txt @@ -5,7 +5,7 @@ tracelog(3) NAME ---- -tracelog, vtracelog - LTTng-UST printf(3)-like interface with a log level +tracelog - LTTng-UST printf(3)-like interface with a log level SYNOPSIS @@ -15,20 +15,18 @@ SYNOPSIS [verse] #define *tracelog*('level', 'fmt', ...) -#define *vtracelog*('level', 'fmt', 'ap') Link with `-llttng-ust -llttng-ust-common`. DESCRIPTION ----------- -The `tracelog()` and `vtracelog()` macros are part of version{nbsp}0 of -the LTTng-UST API (see the ``Compatibility with previous APIs'' section -of man:lttng-ust(3)). +The `tracelog()` macro is part of version{nbsp}0 of the LTTng-UST API +(see the ``Compatibility with previous APIs'' section of +man:lttng-ust(3)). -Prefer using man:lttng_ust_tracelog(3) and man:lttng_ust_vtracelog(3) -which are part of version{nbsp}1 of the API and have the `lttng_ust_` -namespace. +Prefer using man:lttng_ust_tracelog(3) which is part of version{nbsp}1 +of the API and has the `lttng_ust_` namespace. include::common-footer.txt[] -- 2.34.1