From 21b35b3a08845c9feef6da46409cd48af86fd700 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 6 May 2021 14:14:08 -0400 Subject: [PATCH] doc/man: follow man-pages(7) for section names/order and for "SEE ALSO" MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Changes, following the "Sections within a manual page" section of man-pages(7): * Rename the "ENVIRONMENT VARIABLES" section to "ENVIRONMENT". * Rename the "COPYRIGHTS" section to "COPYRIGHT". * Move the "EXIT STATUS" section immediately after the "OPTIONS" section. * Remove the "BUGS" section. Such a section indicates known bugs (why would you ever have such a section anyway?). The "RESOURCES" section now contains the URL of our bug tracker. * Sort the manual pages by section, and then by name in the "SEE ALSO" section. Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau Change-Id: I3d91073ec876efd98dcc723ddf40272c814663dd --- doc/man/common-cmd-footer.txt | 40 ++++++++++++++-------------- doc/man/common-footer.txt | 19 +++++-------- doc/man/lttng-add-context.1.txt | 4 +-- doc/man/lttng-add-trigger.1.txt | 4 +-- doc/man/lttng-clear.1.txt | 2 +- doc/man/lttng-create.1.txt | 12 ++++----- doc/man/lttng-destroy.1.txt | 4 +-- doc/man/lttng-disable-channel.1.txt | 4 +-- doc/man/lttng-disable-event.1.txt | 4 +-- doc/man/lttng-disable-rotation.1.txt | 3 ++- doc/man/lttng-enable-channel.1.txt | 4 +-- doc/man/lttng-enable-event.1.txt | 4 +-- doc/man/lttng-enable-rotation.1.txt | 4 +-- doc/man/lttng-event-rule.7.txt | 4 +-- doc/man/lttng-list-triggers.1.txt | 4 +-- doc/man/lttng-load.1.txt | 4 +-- doc/man/lttng-metadata.1.txt | 4 +-- doc/man/lttng-relayd.8.txt | 32 +++++++++++----------- doc/man/lttng-remove-trigger.1.txt | 4 +-- doc/man/lttng-rotate.1.txt | 4 +-- doc/man/lttng-save.1.txt | 4 +-- doc/man/lttng-sessiond.8.txt | 28 +++++++++---------- doc/man/lttng-set-session.1.txt | 3 +-- doc/man/lttng-snapshot.1.txt | 4 +-- doc/man/lttng-start.1.txt | 4 +-- doc/man/lttng-status.1.txt | 4 +-- doc/man/lttng-stop.1.txt | 4 +-- doc/man/lttng-track.1.txt | 4 +-- doc/man/lttng-untrack.1.txt | 4 +-- 29 files changed, 109 insertions(+), 114 deletions(-) diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt index cd0ce8b76..86b4a8188 100644 --- a/doc/man/common-cmd-footer.txt +++ b/doc/man/common-cmd-footer.txt @@ -1,5 +1,23 @@ -ENVIRONMENT VARIABLES ---------------------- +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Command error + +*2*:: + Undefined command + +*3*:: + Fatal error + +*4*:: + Command warning (something went wrong during the command) + + +ENVIRONMENT +----------- `LTTNG_ABORT_ON_ERROR`:: Set to `1` to abort the process after the first error is encountered. @@ -64,22 +82,4 @@ NOTE: `$LTTNG_HOME` defaults to the value of the `HOME` environment variable. -EXIT STATUS ------------ -*0*:: - Success - -*1*:: - Command error - -*2*:: - Undefined command - -*3*:: - Fatal error - -*4*:: - Command warning (something went wrong during the command) - - include::common-footer.txt[] diff --git a/doc/man/common-footer.txt b/doc/man/common-footer.txt index a51d64734..0815ab60c 100644 --- a/doc/man/common-footer.txt +++ b/doc/man/common-footer.txt @@ -1,23 +1,18 @@ -BUGS ----- -If you encounter any issue or usability problem, please report it on the -https://bugs.lttng.org/projects/lttng-tools[LTTng bug tracker]. - - RESOURCES --------- * https://lttng.org[LTTng project website] * https://lttng.org/docs[LTTng documentation] -* http://git.lttng.org[Git repositories] -* http://github.com/lttng[GitHub organization] -* http://ci.lttng.org/[Continuous integration] -* http://lists.lttng.org[Mailing list] for support and +* https://bugs.lttng.org[LTTng bug tracker] +* https://git.lttng.org[Git repositories] +* https://github.com/lttng[GitHub organization] +* https://ci.lttng.org/[Continuous integration] +* https://lists.lttng.org/[Mailing list] for support and development: `lttng-dev@lists.lttng.org` * irc://irc.oftc.net/lttng[IRC channel]: `#lttng` on `irc.oftc.net` -COPYRIGHTS ----------- +COPYRIGHT +--------- This program is part of the LTTng-tools project. LTTng-tools is distributed under the diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index a5ca19ef5..b1d11e931 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -167,5 +167,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-enable-channel(1) +man:lttng-enable-channel(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-add-trigger.1.txt b/doc/man/lttng-add-trigger.1.txt index 5694d28d6..aee2380b3 100644 --- a/doc/man/lttng-add-trigger.1.txt +++ b/doc/man/lttng-add-trigger.1.txt @@ -309,6 +309,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-list-triggers(1), -man:lttng-remove-trigger(1) +man:lttng-remove-trigger(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt index 34714f699..f60a55b96 100644 --- a/doc/man/lttng-clear.1.txt +++ b/doc/man/lttng-clear.1.txt @@ -76,6 +76,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-create(1), +man:lttng-concepts(7), man:lttng-relayd(8) diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index daac924f7..f3420a010 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -368,15 +368,15 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-destroy(1), man:lttng-enable-channel(1), -man:lttng-list(8), -man:lttng-relayd(8), +man:lttng-list(1), man:lttng-rotate(1), man:lttng-save(1), -man:lttng-sessiond(8), man:lttng-set-session(1), man:lttng-start(1), -man:lttng-status(8), -man:lttng-track(1) +man:lttng-status(1), +man:lttng-track(1), +man:lttng-concepts(7), +man:lttng-relayd(8), +man:lttng-sessiond(8) diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt index 5084485fd..bed0a0053 100644 --- a/doc/man/lttng-destroy.1.txt +++ b/doc/man/lttng-destroy.1.txt @@ -88,6 +88,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-create(1), -man:lttng-list(1) +man:lttng-list(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt index 164dfdd2f..9492a3903 100644 --- a/doc/man/lttng-disable-channel.1.txt +++ b/doc/man/lttng-disable-channel.1.txt @@ -67,5 +67,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-enable-channel(1) +man:lttng-enable-channel(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt index 82cea0988..7ace9d1b4 100644 --- a/doc/man/lttng-disable-event.1.txt +++ b/doc/man/lttng-disable-event.1.txt @@ -156,6 +156,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-enable-event(1), -man:lttng-list(1) +man:lttng-list(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index 0c23031a6..0fc53afeb 100644 --- a/doc/man/lttng-disable-rotation.1.txt +++ b/doc/man/lttng-disable-rotation.1.txt @@ -62,4 +62,5 @@ SEE ALSO -------- man:lttng(1), man:lttng-enable-rotation(1), -man:lttng-rotate(1) +man:lttng-rotate(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index 271ada1ce..4da752f34 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -354,6 +354,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-disable-channel(1), -man:lttng-list(1) +man:lttng-list(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index 5b096227e..439099b7f 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -854,9 +854,9 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-disable-event(1), man:lttng-enable-channel(1), man:lttng-list(1), man:lttng-start(1), -man:lttng-track(1) +man:lttng-track(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt index d8ec88e75..f965ed973 100644 --- a/doc/man/lttng-enable-rotation.1.txt +++ b/doc/man/lttng-enable-rotation.1.txt @@ -117,7 +117,7 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-create(1), man:lttng-disable-rotation(1), -man:lttng-rotate(1) +man:lttng-rotate(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-event-rule.7.txt b/doc/man/lttng-event-rule.7.txt index 3fad65c86..3af260440 100644 --- a/doc/man/lttng-event-rule.7.txt +++ b/doc/man/lttng-event-rule.7.txt @@ -763,5 +763,5 @@ SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), -man:lttng-list(1) +man:lttng-list(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-list-triggers.1.txt b/doc/man/lttng-list-triggers.1.txt index 83919a2c6..7d99869f2 100644 --- a/doc/man/lttng-list-triggers.1.txt +++ b/doc/man/lttng-list-triggers.1.txt @@ -34,5 +34,5 @@ SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), -man:lttng-remove-trigger(1) +man:lttng-remove-trigger(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt index f5cc3e203..545bc3628 100644 --- a/doc/man/lttng-load.1.txt +++ b/doc/man/lttng-load.1.txt @@ -109,5 +109,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-save(1) +man:lttng-save(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt index 220225b31..6911f9fb8 100644 --- a/doc/man/lttng-metadata.1.txt +++ b/doc/man/lttng-metadata.1.txt @@ -39,5 +39,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-regenerate(1) +man:lttng-regenerate(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt index 694eb4995..90cc1547d 100644 --- a/doc/man/lttng-relayd.8.txt +++ b/doc/man/lttng-relayd.8.txt @@ -280,8 +280,20 @@ option:-V, option:--version:: Show version and quit. -ENVIRONMENT VARIABLES ---------------------- +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Error + +*3*:: + Fatal error + + +ENVIRONMENT +----------- `LTTNG_ABORT_ON_ERROR`:: Set to `1` to abort the process after the first error is encountered. @@ -378,23 +390,11 @@ Override this path with the option:--output option. NOTE: `$LTTNG_HOME` defaults to `$HOME`. -EXIT STATUS ------------ -*0*:: - Success - -*1*:: - Error - -*3*:: - Fatal error - - include::common-footer.txt[] SEE ALSO -------- +man:babeltrace2(1), man:lttng(1), -man:lttng-sessiond(8), -man:babeltrace2(1) +man:lttng-sessiond(8) diff --git a/doc/man/lttng-remove-trigger.1.txt b/doc/man/lttng-remove-trigger.1.txt index 59d5da122..faf67b2f8 100644 --- a/doc/man/lttng-remove-trigger.1.txt +++ b/doc/man/lttng-remove-trigger.1.txt @@ -49,5 +49,5 @@ SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), -man:lttng-list-triggers(1) +man:lttng-list-triggers(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt index baebea94b..50cb3102b 100644 --- a/doc/man/lttng-rotate.1.txt +++ b/doc/man/lttng-rotate.1.txt @@ -96,6 +96,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-disable-rotation(1), -man:lttng-enable-rotation(1) +man:lttng-enable-rotation(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt index baf51fded..36ef1d673 100644 --- a/doc/man/lttng-save.1.txt +++ b/doc/man/lttng-save.1.txt @@ -78,5 +78,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-load(1) +man:lttng-load(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt index e9ec73d16..4a8b4b6b2 100644 --- a/doc/man/lttng-sessiond.8.txt +++ b/doc/man/lttng-sessiond.8.txt @@ -302,8 +302,20 @@ option:-V, option:--version:: Show version and quit. -ENVIRONMENT VARIABLES ---------------------- +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Error + +*3*:: + Fatal error + + +ENVIRONMENT +----------- `LTTNG_ABORT_ON_ERROR`:: Set to `1` to abort the process after the first error is encountered. @@ -409,18 +421,6 @@ See the <> section above to learn more. NOTE: `$LTTNG_HOME` defaults to `$HOME`. -EXIT STATUS ------------ -*0*:: - Success - -*1*:: - Error - -*3*:: - Fatal error - - include::common-footer.txt[] diff --git a/doc/man/lttng-set-session.1.txt b/doc/man/lttng-set-session.1.txt index 6c04caf92..10f710abe 100644 --- a/doc/man/lttng-set-session.1.txt +++ b/doc/man/lttng-set-session.1.txt @@ -41,6 +41,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-create(1), -man:lttng-destroy(1) +man:lttng-concepts(7) diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index 94bf7c9f5..27c1e3d9c 100644 --- a/doc/man/lttng-snapshot.1.txt +++ b/doc/man/lttng-snapshot.1.txt @@ -193,5 +193,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-create(1) +man:lttng-create(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index 53b1c8aa7..9cc721de7 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -50,7 +50,7 @@ SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), man:lttng-create(1), man:lttng-enable-event(1), -man:lttng-stop(1) +man:lttng-stop(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt index 81f755d57..5f136f1aa 100644 --- a/doc/man/lttng-status.1.txt +++ b/doc/man/lttng-status.1.txt @@ -40,7 +40,7 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), man:lttng-create(1), man:lttng-list(1), -man:lttng-set-session(1) +man:lttng-set-session(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt index c6f63c36c..4715872fe 100644 --- a/doc/man/lttng-stop.1.txt +++ b/doc/man/lttng-stop.1.txt @@ -71,8 +71,8 @@ SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), man:lttng-create(1), man:lttng-enable-event(1), man:lttng-rotate(1), -man:lttng-start(1) +man:lttng-start(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt index 0e6cfceba..d2768b12c 100644 --- a/doc/man/lttng-track.1.txt +++ b/doc/man/lttng-track.1.txt @@ -297,5 +297,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-untrack(1) +man:lttng-untrack(1), +man:lttng-concepts(7) diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index 01e82b1b4..d00b89214 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -245,5 +245,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-concepts(7), -man:lttng-track(1) +man:lttng-track(1), +man:lttng-concepts(7) -- 2.34.1