From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Thu, 24 Mar 2016 17:14:17 +0000 (-0400)
Subject: doc/man: add linkgenoptions AsciiDoc macro
X-Git-Tag: v2.8.0~162
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f5d2e3f54ff6f431986860b8999e6fa0259fa9b8;p=lttng-tools.git

doc/man: add linkgenoptions AsciiDoc macro

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

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)[\\]?(?P<name>linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
 
+# linkgenoptions macro
+#
+# Usage: linkgenoptions:(text)
+(?su)[\\]?(?P<name>linkgenoptions):\((?P<text>.*?)\)=
+
 # no link option macro
 #
 # Usage: nloption:--option-name
@@ -37,6 +42,12 @@ ifdef::backend-docbook[]
 {0#</citerefentry>}
 endif::backend-docbook[]
 
+# linkgenoptions macro expansions
+ifdef::backend-docbook[]
+[linkgenoptions-inlinemacro]
+{text}
+endif::backend-docbook[]
+
 # option macro expansions
 ifdef::backend-docbook[]
 [option-inlinemacro]