From f5d2e3f54ff6f431986860b8999e6fa0259fa9b8 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 24 Mar 2016 13:14:17 -0400 Subject: [PATCH] doc/man: add linkgenoptions AsciiDoc macro MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/README.md | 8 ++++++++ doc/man/asciidoc.conf | 11 +++++++++++ 2 files changed, 19 insertions(+) diff --git a/doc/man/README.md b/doc/man/README.md index fc8c81c77..21513ba0d 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -32,6 +32,14 @@ name is rendered in bold, whereas the HTML5 output renders a hyperlink. Usage example: `linklttng:lttng-enable-channel(1)`. +### linkgenoptions + +The linkgenoptions macro is used to link to the general options +section of the `lttng(1)` command. + +Usage example: `See the linkgenoptions:(general options).`. + + ### option The option macro is used to write a command-line option which is diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf index 3410dd2a3..baa697839 100644 --- a/doc/man/asciidoc.conf +++ b/doc/man/asciidoc.conf @@ -8,6 +8,11 @@ # Usage: linklttng:command(manpage-section) (?su)[\\]?(?Plinklttng):(?P\S*?)\((?P.*?)\)= +# linkgenoptions macro +# +# Usage: linkgenoptions:(text) +(?su)[\\]?(?Plinkgenoptions):\((?P.*?)\)= + # no link option macro # # Usage: nloption:--option-name @@ -37,6 +42,12 @@ ifdef::backend-docbook[] {0#} endif::backend-docbook[] +# linkgenoptions macro expansions +ifdef::backend-docbook[] +[linkgenoptions-inlinemacro] +{text} +endif::backend-docbook[] + # option macro expansions ifdef::backend-docbook[] [option-inlinemacro] -- 2.34.1