From: Philippe Proulx Date: Wed, 4 May 2016 20:24:10 +0000 (-0400) Subject: Propagate default values from configure.ac to asciidoc.conf X-Git-Tag: v2.9.0-rc1~254 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=3fa8d43b5d5d7ce42f6ea6960498800c1de25c3d Propagate default values from configure.ac to asciidoc.conf Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/.gitignore b/.gitignore index 445e76919..f9fd809e2 100644 --- a/.gitignore +++ b/.gitignore @@ -113,6 +113,7 @@ tests/regression/ust/python-logging/test_python_logging /doc/man/*.8 /doc/man/*.xml /doc/man/*.html +/doc/man/asciidoc.conf !/doc/man/lttng-health-check.3 /benchmark/ diff --git a/configure.ac b/configure.ac index 84992244c..51f9bca3f 100644 --- a/configure.ac +++ b/configure.ac @@ -907,6 +907,7 @@ AC_CONFIG_FILES([ Makefile doc/Makefile doc/man/Makefile + doc/man/asciidoc.conf include/Makefile extras/Makefile extras/bindings/Makefile diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index eca1cb20f..fca79c9d6 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -144,4 +144,4 @@ dist-hook: endif # !MAN_PAGES_OPT # always distribute the source files -EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) $(ASCIIDOC_CONF) +EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) $(ASCIIDOC_CONF).in diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf deleted file mode 100644 index 70bd7d68a..000000000 --- a/doc/man/asciidoc.conf +++ /dev/null @@ -1,118 +0,0 @@ -[macros] - -# man macro -# -# Inspired by linkgit macro: -# -# -# Usage: man:command(manpage-section) -(?su)[\\]?(?Pman):(?P\S*?)\((?P.*?)\)= - -# linkgenoptions macro -# -# Usage: linkgenoptions:(text) -(?su)[\\]?(?Plinkgenoptions):\((?P.*?)\)= - -# no link option macro -# -# Usage: nloption:--option-name -(?su)[\\]?(?Pnloption):(?P--?[a-zA-Z0-9-]*)= - -# lttng(1) general option macro -# -# Usage: genoption:--option-name -(?su)[\\]?(?Pgenoption):(?P--?[a-zA-Z0-9-]*)= - -# option macro -# -# Usage: option:--option-name -(?su)[\\]?(?Poption):(?P--?[a-zA-Z0-9-]*)= - -# not macro -# -# Usage: :not: -:not:=not - -# escwc macro -# -# Usage: :escwc: -:escwc:=escwc - -# man macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[man-inlinemacro] -{0%{target}} -{0#} -{0#{target}{0}} -{0#} -endif::backend-docbook[] -endif::doctype-manpage[] - -# linkgenoptions macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[linkgenoptions-inlinemacro] -{text} -endif::backend-docbook[] -endif::doctype-manpage[] - -# option macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[option-inlinemacro] -{opt} -endif::backend-docbook[] -endif::doctype-manpage[] - -# no link option macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[nloption-inlinemacro] -{opt} -endif::backend-docbook[] -endif::doctype-manpage[] - -# lttng(1) general option macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[genoption-inlinemacro] -{opt} -endif::backend-docbook[] -endif::doctype-manpage[] - -# not macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[not-inlinemacro] -NOT -endif::backend-docbook[] -endif::doctype-manpage[] - -# escwc macro expansions -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[escwc-inlinemacro] -\e* -endif::backend-docbook[] -endif::doctype-manpage[] - -# configure XML man page header -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[header] -template::[header-declarations] - - -{mantitle} -{manvolnum} -LTTng -{lttng_version} -LTTng Manual - - - {manname} - {manpurpose} - -endif::backend-docbook[] -endif::doctype-manpage[] diff --git a/doc/man/asciidoc.conf.in b/doc/man/asciidoc.conf.in new file mode 100644 index 000000000..b264bc6eb --- /dev/null +++ b/doc/man/asciidoc.conf.in @@ -0,0 +1,153 @@ +[macros] + +# man macro +# +# Inspired by linkgit macro: +# +# +# Usage: man:command(manpage-section) +(?su)[\\]?(?Pman):(?P\S*?)\((?P.*?)\)= + +# linkgenoptions macro +# +# Usage: linkgenoptions:(text) +(?su)[\\]?(?Plinkgenoptions):\((?P.*?)\)= + +# no link option macro +# +# Usage: nloption:--option-name +(?su)[\\]?(?Pnloption):(?P--?[a-zA-Z0-9-]*)= + +# lttng(1) general option macro +# +# Usage: genoption:--option-name +(?su)[\\]?(?Pgenoption):(?P--?[a-zA-Z0-9-]*)= + +# option macro +# +# Usage: option:--option-name +(?su)[\\]?(?Poption):(?P--?[a-zA-Z0-9-]*)= + +# not macro +# +# Usage: :not: +:not:=not + +# escwc macro +# +# Usage: :escwc: +:escwc:=escwc + +# man macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[man-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] +endif::doctype-manpage[] + +# linkgenoptions macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[linkgenoptions-inlinemacro] +{text} +endif::backend-docbook[] +endif::doctype-manpage[] + +# option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[option-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# no link option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[nloption-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# lttng(1) general option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[genoption-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# not macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[not-inlinemacro] +NOT +endif::backend-docbook[] +endif::doctype-manpage[] + +# escwc macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[escwc-inlinemacro] +\e* +endif::backend-docbook[] +endif::doctype-manpage[] + +# configure XML man page header +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] + + +{mantitle} +{manvolnum} +LTTng +{lttng_version} +LTTng Manual + + + {manname} + {manpurpose} + +endif::backend-docbook[] +endif::doctype-manpage[] + +[attributes] +default_agent_tcp_port="@DEFAULT_AGENT_TCP_PORT@" +default_app_socket_rw_timeout="@DEFAULT_APP_SOCKET_RW_TIMEOUT@" +default_channel_subbuf_size="@DEFAULT_CHANNEL_SUBBUF_SIZE@" +default_channel_tracefile_count="@DEFAULT_CHANNEL_TRACEFILE_COUNT@" +default_channel_tracefile_size="@DEFAULT_CHANNEL_TRACEFILE_SIZE@" +default_kernel_channel_live_timer="@DEFAULT_KERNEL_CHANNEL_LIVE_TIMER@" +default_kernel_channel_read_timer="@DEFAULT_KERNEL_CHANNEL_READ_TIMER@" +default_kernel_channel_subbuf_num="@DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM@" +default_kernel_channel_subbuf_size="@DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE@" +default_kernel_channel_switch_timer="@DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER@" +default_lttng_live_timer="@DEFAULT_LTTNG_LIVE_TIMER@" +default_metadata_cache_size="@DEFAULT_METADATA_CACHE_SIZE@" +default_metadata_read_timer="@DEFAULT_METADATA_READ_TIMER@" +default_metadata_subbuf_num="@DEFAULT_METADATA_SUBBUF_NUM@" +default_metadata_subbuf_size="@DEFAULT_METADATA_SUBBUF_SIZE@" +default_metadata_switch_timer="@DEFAULT_METADATA_SWITCH_TIMER@" +default_network_control_port="@DEFAULT_NETWORK_CONTROL_PORT@" +default_network_data_port="@DEFAULT_NETWORK_DATA_PORT@" +default_network_viewer_port="@DEFAULT_NETWORK_VIEWER_PORT@" +default_ust_pid_channel_live_timer="@DEFAULT_UST_PID_CHANNEL_LIVE_TIMER@" +default_ust_pid_channel_read_timer="@DEFAULT_UST_PID_CHANNEL_READ_TIMER@" +default_ust_pid_channel_subbuf_num="@DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM@" +default_ust_pid_channel_subbuf_size="@DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE@" +default_ust_pid_channel_switch_timer="@DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER@" +default_ust_uid_channel_live_timer="@DEFAULT_UST_UID_CHANNEL_LIVE_TIMER@" +default_ust_uid_channel_read_timer="@DEFAULT_UST_UID_CHANNEL_READ_TIMER@" +default_ust_uid_channel_subbuf_num="@DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM@" +default_ust_uid_channel_subbuf_size="@DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE@" +default_ust_uid_channel_switch_timer="@DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER@" +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@"