doc/man: use propagated default values in man pages

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

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index fca79c9d6adce445c682cdf15a31457d97bb5204..075ab8ba0f0f36bf8987c0787e0faa152fdc8f3b 100644 (file)
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -76,11 +76,7 @@ if MAN_PAGES_OPT
 # at this point, we know the user asked to build the man pages
 if HAVE_ASCIIDOC_XMLTO
 # tools
 # at this point, we know the user asked to build the man pages
 if HAVE_ASCIIDOC_XMLTO
 # tools

-ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
-       -a lttng_version="$(PACKAGE_VERSION)" \
-       -a system_sessions_dir="$(sysconfdir)/lttng/sessions" \
-       -a system_sessions_auto_dir="$(sysconfdir)/lttng/sessions/auto" \
-       -a system_lttng_conf="$(sysconfdir)/lttng/lttng.conf"
+ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage

 ADOC_DOCBOOK = $(ADOC) -b docbook
 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
 
 ADOC_DOCBOOK = $(ADOC) -b docbook
 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
 

diff --git a/doc/man/asciidoc.conf.in b/doc/man/asciidoc.conf.in
index b264bc6eb85a1a5e10d5de3104dd0d19e0e03e8b..894e8d9f5f720fcfb51ac8486d3397b3e5cdf7e4 100644 (file)
--- a/doc/man/asciidoc.conf.in
+++ b/doc/man/asciidoc.conf.in
@@ -151,3 +151,7 @@ default_agent_bind_address="@DEFAULT_AGENT_BIND_ADDRESS@"
 default_network_control_bind_address="@DEFAULT_NETWORK_CONTROL_BIND_ADDRESS@"
 default_network_data_bind_address="@DEFAULT_NETWORK_DATA_BIND_ADDRESS@"
 default_network_viewer_bind_address="@DEFAULT_NETWORK_VIEWER_BIND_ADDRESS@"
 default_network_control_bind_address="@DEFAULT_NETWORK_CONTROL_BIND_ADDRESS@"
 default_network_data_bind_address="@DEFAULT_NETWORK_DATA_BIND_ADDRESS@"
 default_network_viewer_bind_address="@DEFAULT_NETWORK_VIEWER_BIND_ADDRESS@"

+lttng_version="@PACKAGE_VERSION@"
+system_sessions_dir="@CONFDIR@/lttng/sessions"
+system_sessions_auto_dir="@CONFDIR@/lttng/sessions/auto"
+system_lttng_conf="@CONFDIR@/lttng/lttng.conf"

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index ef94472f06fd81ee34527b63136e6bf20a69b93f..05ff4d64e6c8fd6bde57a80f1143ee09a4aefbd2 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -147,8 +147,8 @@ option:--live[='DELAYUS']::
     (options option:--set-url, or option:--ctrl-url and option:--data-url)
     and must have a relay daemon listening (see man:lttng-relayd(8)).
 +
     (options option:--set-url, or option:--ctrl-url and option:--data-url)
     and must have a relay daemon listening (see man:lttng-relayd(8)).
 +

-By default, 'DELAYUS' is 1000000 and the network URL is set to
-`net://127.0.0.1`.
+By default, 'DELAYUS' is {default_lttng_live_timer} and the network URL
+is set to `net://127.0.0.1`.

 
 option:--snapshot::
     Create the session in snapshot mode. This is the equivalent of using
 
 option:--snapshot::
     Create the session in snapshot mode. This is the equivalent of using

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 1178b08d202a08e8c4aaf9297a32b1107bd6b0da..b1514ed5162c4a8b0616c7a19b56961cdbf27fb7 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -252,8 +252,12 @@ option:--num-subbuf='COUNT'::
 +
 Default values:
 +
 +
 Default values:
 +

-* `metadata` channel: 2
-* Everything else: 4
+* option:--userspace and option:--buffers-uid options:
+  {default_ust_uid_channel_subbuf_num}
+* option:--userspace and option:--buffers-pid options:
+  {default_ust_pid_channel_subbuf_num}
+* option:--kernel option: {default_kernel_channel_subbuf_num}
+* `metadata` channel: {default_metadata_subbuf_num}

 
 option:--subbuf-size='SIZE'::
     Set the individual size of sub-buffers to 'SIZE' bytes.
 
 option:--subbuf-size='SIZE'::
     Set the individual size of sub-buffers to 'SIZE' bytes.


@@ -266,10 +270,12 @@ command shows the current system's page size: `getconf PAGE_SIZE`.
 +
 Default values:
 +
 +
 Default values:
 +

-* option:--userspace and option:--buffers-uid options: `128k`
-* option:--userspace and option:--buffers-pid options: `4k`
-* option:--kernel option: `256k`
-* `metadata` channel: `4k`
+* option:--userspace and option:--buffers-uid options:
+  {default_ust_uid_channel_subbuf_size}
+* option:--userspace and option:--buffers-pid options:
+  {default_ust_pid_channel_subbuf_size}
+* option:--kernel option: {default_kernel_channel_subbuf_size}
+* `metadata` channel: {default_metadata_subbuf_size}

 
 option:--output='TYPE'::
     Set channel's output type to 'TYPE'.
 
 option:--output='TYPE'::
     Set channel's output type to 'TYPE'.


@@ -306,7 +312,8 @@ Trace files
 ~~~~~~~~~~~
 option:--tracefile-count='COUNT'::
     Limit the number of trace files created by this channel to
 ~~~~~~~~~~~
 option:--tracefile-count='COUNT'::
     Limit the number of trace files created by this channel to

-    'COUNT'. 0 means unlimited. Default: 0.
+    'COUNT'. 0 means unlimited. Default:
+    {default_channel_tracefile_count}.

 +
 Use this option in conjunction with the option:--tracefile-size option.
 +
 +
 Use this option in conjunction with the option:--tracefile-size option.
 +


@@ -317,7 +324,7 @@ the first trace file of the stream is cleared and used again.
 option:--tracefile-size='SIZE'::
     Set the maximum size of each trace file written by
     this channel within a stream to 'SIZE' bytes. 0 means unlimited.
 option:--tracefile-size='SIZE'::
     Set the maximum size of each trace file written by
     this channel within a stream to 'SIZE' bytes. 0 means unlimited.

-    Default: 0.
+    Default: {default_channel_tracefile_size}.

 +
 Note: traces generated with this option may inaccurately report
 discarded events as of CTF 1.8.
 +
 Note: traces generated with this option may inaccurately report
 discarded events as of CTF 1.8.


@@ -331,14 +338,25 @@ option:--read-timer::
 +
 Default values:
 +
 +
 Default values:
 +

-* option:--userspace and option:--buffers-uid options: 0
-* option:--userspace and option:--buffers-pid options: 0
-* option:--kernel option: 200000
-* `metadata` channel: 0
+* option:--userspace and option:--buffers-uid options:
+  {default_ust_uid_channel_read_timer}
+* option:--userspace and option:--buffers-pid options:
+  {default_ust_pid_channel_read_timer}
+* option:--kernel option: {default_kernel_channel_read_timer}
+* `metadata` channel: {default_metadata_read_timer}

 
 option:--switch-timer='PERIODUS'::
     Set the channel's switch timer's period to 'PERIODUS' µs. 0 means
 
 option:--switch-timer='PERIODUS'::
     Set the channel's switch timer's period to 'PERIODUS' µs. 0 means

-    a disabled switch timer. Default: 0.
+    a disabled switch timer.
++
+Default values:
++
+* option:--userspace and option:--buffers-uid options:
+  {default_ust_uid_channel_switch_timer}
+* option:--userspace and option:--buffers-pid options:
+  {default_ust_pid_channel_switch_timer}
+* option:--kernel option: {default_kernel_channel_switch_timer}
+* `metadata` channel: {default_metadata_switch_timer}

 
 
 include::common-cmd-help-options.txt[]
 
 
 include::common-cmd-help-options.txt[]

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 1a366f9b8a50e9f0cb31d2a26942fb1371d089cd..e2d1365d536142a207ef4f139aef2690188f1b7d 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -37,7 +37,8 @@ The relay daemon does not require any particular permissions, as long as
 it can write to the output directory and listen on the configured ports.
 If a user is within a secured network and/or has proper firewall
 settings, `lttng-relayd` can listen to LTTng live connections from _all_
 it can write to the output directory and listen on the configured ports.
 If a user is within a secured network and/or has proper firewall
 settings, `lttng-relayd` can listen to LTTng live connections from _all_

-network interfaces by specifying `--live-port=tcp://0.0.0.0:5344`.
+network interfaces by specifying
++--live-port=tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+.

 
 Once a trace has been streamed completely, the trace can be processed by
 any tool that can process an LTTng trace located on the local
 
 Once a trace has been streamed completely, the trace can be processed by
 any tool that can process an LTTng trace located on the local


@@ -127,14 +128,17 @@ See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
 option:-C, option:--control-port='URL'::
 about the syntax of the following options' 'URL' argument.
 
 option:-C, option:--control-port='URL'::

-    Listen to control data on URL 'URL' (default: `tcp://0.0.0.0:5342`).
+    Listen to control data on URL 'URL' (default:
+    +tcp://{default_network_control_bind_address}:{default_network_control_port}+).

 
 option:-D, option:--data-port='URL'::
 
 option:-D, option:--data-port='URL'::

-    Listen to trace data on URL 'URL' (default: `tcp://0.0.0.0:5343`).
+    Listen to trace data on URL 'URL' (default:
+    +tcp://{default_network_data_bind_address}:{default_network_data_port}+).

 
 option:-L, option:--live-port='URL'::
     Listen to LTTng live connections on URL 'URL'
 
 option:-L, option:--live-port='URL'::
     Listen to LTTng live connections on URL 'URL'

-    (default: `tcp://0.0.0.0:5344`).
+    (default:
+    +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).

 
 
 Program information
 
 
 Program information

diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt
index 24f73143aeb94cf7a5915a1da9d303e23185a75b..f4348d85b14c0e3eac7cabdfefe4557daa420481 100644 (file)
--- a/doc/man/lttng-sessiond.8.txt
+++ b/doc/man/lttng-sessiond.8.txt
@@ -152,7 +152,7 @@ Paths and ports
 ~~~~~~~~~~~~~~~
 option:--agent-tcp-port='PORT'::
     Listen on TCP port 'PORT' for agent application registrations
 ~~~~~~~~~~~~~~~
 option:--agent-tcp-port='PORT'::
     Listen on TCP port 'PORT' for agent application registrations

-    (default: 5345).
+    (default: {default_agent_tcp_port}).

 
 option:-a, option:--apps-sock='PATH'::
     Set application Unix socket path to 'PATH'.
 
 option:-a, option:--apps-sock='PATH'::
     Set application Unix socket path to 'PATH'.


@@ -228,7 +228,7 @@ variable.
     Application socket's timeout (seconds) when sending/receiving
     commands. After this period of time, the application is unregistered
     by the session daemon. A value of 0 or -1 means an infinite timeout.
     Application socket's timeout (seconds) when sending/receiving
     commands. After this period of time, the application is unregistered
     by the session daemon. A value of 0 or -1 means an infinite timeout.

-    Default value: 5.
+    Default value: {default_app_socket_rw_timeout}.

 
 `LTTNG_CONSUMERD32_BIN`::
     32-bit consumer daemon binary path.
 
 `LTTNG_CONSUMERD32_BIN`::
     32-bit consumer daemon binary path.