From 61fa50287dfbd4556b9049145700bcfd68facca2 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Tue, 10 May 2016 15:08:00 -0400 Subject: [PATCH] Define command short descriptions in configure.ac MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Refs #1011 Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- configure.ac | 24 ++++++++++++++++++++++ doc/man/asciidoc.conf.in | 25 +++++++++++++++++++++++ doc/man/lttng.1.txt | 44 ++++++++++++++++++++-------------------- 3 files changed, 71 insertions(+), 22 deletions(-) diff --git a/configure.ac b/configure.ac index 51f9bca3f..20d068009 100644 --- a/configure.ac +++ b/configure.ac @@ -265,6 +265,30 @@ _AC_DEFINE_QUOTED_AND_SUBST([DEFAULT_NETWORK_CONTROL_BIND_ADDRESS], [0.0.0.0]) _AC_DEFINE_QUOTED_AND_SUBST([DEFAULT_NETWORK_DATA_BIND_ADDRESS], [0.0.0.0]) _AC_DEFINE_QUOTED_AND_SUBST([DEFAULT_NETWORK_VIEWER_BIND_ADDRESS], [localhost]) +# Command short descriptions +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ADD_CONTEXT], [Add context fields to a channel]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CALIBRATE], [Quantify LTTng overhead]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CREATE], [Create a tracing session]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DESTROY], [Tear down tracing sessions]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_CHANNEL], [Disable tracing channels]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_EVENT], [Disable event rules]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_CHANNEL], [Create or enable tracing channels]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ENABLE_EVENT], [Create or enable event rules]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_HELP], [Display help information about a command]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_LIST], [List tracing sessions, domains, channels, and events]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_LOAD], [Load tracing session configurations]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_METADATA], [Manage an LTTng tracing session's metadata generation]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_SAVE], [Save tracing session configurations]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_SET_SESSION], [Set current tracing session]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_SNAPSHOT], [Snapshot buffers of current tracing session]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_START], [Start tracing]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_STATUS], [Get the status of the current tracing session]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_STOP], [Stop tracing]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_TRACK], [Track specific system resources]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_UNTRACK], [Untrack specific system resources]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_VERSION], [Show version information]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_VIEW], [Start trace viewer]) + if test "x$prefix" = "xNONE"; then prefix=$ac_default_prefix fi diff --git a/doc/man/asciidoc.conf.in b/doc/man/asciidoc.conf.in index 894e8d9f5..3da5ac81c 100644 --- a/doc/man/asciidoc.conf.in +++ b/doc/man/asciidoc.conf.in @@ -118,6 +118,7 @@ endif::backend-docbook[] endif::doctype-manpage[] [attributes] +# default values 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@" @@ -155,3 +156,27 @@ 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" + +# command short descriptions +cmd_descr_add_context="@CMD_DESCR_ADD_CONTEXT@" +cmd_descr_calibrate="@CMD_DESCR_CALIBRATE@" +cmd_descr_create="@CMD_DESCR_CREATE@" +cmd_descr_destroy="@CMD_DESCR_DESTROY@" +cmd_descr_disable_channel="@CMD_DESCR_DISABLE_CHANNEL@" +cmd_descr_disable_event="@CMD_DESCR_DISABLE_EVENT@" +cmd_descr_enable_channel="@CMD_DESCR_ENABLE_CHANNEL@" +cmd_descr_enable_event="@CMD_DESCR_ENABLE_EVENT@" +cmd_descr_help="@CMD_DESCR_HELP@" +cmd_descr_list="@CMD_DESCR_LIST@" +cmd_descr_load="@CMD_DESCR_LOAD@" +cmd_descr_metadata="@CMD_DESCR_METADATA@" +cmd_descr_save="@CMD_DESCR_SAVE@" +cmd_descr_set_session="@CMD_DESCR_SET_SESSION@" +cmd_descr_snapshot="@CMD_DESCR_SNAPSHOT@" +cmd_descr_start="@CMD_DESCR_START@" +cmd_descr_status="@CMD_DESCR_STATUS@" +cmd_descr_stop="@CMD_DESCR_STOP@" +cmd_descr_track="@CMD_DESCR_TRACK@" +cmd_descr_untrack="@CMD_DESCR_UNTRACK@" +cmd_descr_version="@CMD_DESCR_VERSION@" +cmd_descr_view="@CMD_DESCR_VIEW@" diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index 5b30b123b..55359186f 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -148,88 +148,88 @@ The following commands also have their own nloption:--help option. Tracing sessions ~~~~~~~~~~~~~~~~ man:lttng-create(1):: - Create a tracing session. + {cmd_descr_create}. man:lttng-destroy(1):: - Tear down tracing sessions. + {cmd_descr_destroy}. man:lttng-load(1):: - Load tracing session configurations. + {cmd_descr_load}. man:lttng-metadata(1):: - Manage an LTTng tracing session's metadata generation. + {cmd_descr_metadata}. man:lttng-save(1):: - Save tracing session configurations. + {cmd_descr_save}. man:lttng-set-session(1):: - Set current tracing session. + {cmd_descr_set_session}. Channels ~~~~~~~~ man:lttng-add-context(1):: - Add context fields to a channel. + {cmd_descr_add_context}. man:lttng-disable-channel(1):: - Disable tracing channels. + {cmd_descr_disable_channel}. man:lttng-enable-channel(1):: - Create or enable tracing channels. + {cmd_descr_enable_channel}. Event rules ~~~~~~~~~~~ man:lttng-disable-event(1):: - Disable event rules. + {cmd_descr_disable_event}. man:lttng-enable-event(1):: - Create or enable event rules. + {cmd_descr_enable_event}. Status ~~~~~~ man:lttng-list(1):: - List tracing sessions, domains, channels, and events. + {cmd_descr_list}. man:lttng-status(1):: - Get the status of the current tracing session. + {cmd_descr_status}. Control ~~~~~~~ man:lttng-snapshot(1):: - Snapshot buffers of current tracing session. + {cmd_descr_snapshot}. man:lttng-start(1):: - Start tracing. + {cmd_descr_start}. man:lttng-stop(1):: - Stop tracing. + {cmd_descr_stop}. Resource tracking ~~~~~~~~~~~~~~~~~ man:lttng-track(1):: - Track specific system resources. + {cmd_descr_track}. man:lttng-untrack(1):: - Untrack specific system resources. + {cmd_descr_untrack}. Miscellaneous ~~~~~~~~~~~~~ man:lttng-calibrate(1):: - Quantify LTTng overhead. + {cmd_descr_calibrate}. man:lttng-help(1):: - Display help information about a command. + {cmd_descr_help}. man:lttng-version(1):: - Show version information. + {cmd_descr_version}. man:lttng-view(1):: - Start trace viewer. + {cmd_descr_view}. include::common-cmd-footer.txt[] -- 2.34.1