doc/man: lttng(1) command pages: always include `common-footer.txt`
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 6 May 2021 18:45:26 +0000 (14:45 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Mon, 10 May 2021 19:17:02 +0000 (15:17 -0400)
commit55e0699466ecc7e7a52b3ca54a806f2faf9bb59e
tree4a739de1c8062982a288704ea007780b1b8348bb
parent21b35b3a08845c9feef6da46409cd48af86fd700
doc/man: lttng(1) command pages: always include `common-footer.txt`

The end of an lttng(1) command manual page source now looks like this:

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

    include::common-lttng-cmd-after-options.txt[]

    include::common-footer.txt[]

`common-lttng-cmd-after-options.txt` contains the "EXIT STATUS",
"ENVIRONMENT", and "FILES" sections.

`common-footer.txt` begins with the "RESOURCES" section.

This will make it possible to insert an "EXAMPLES" section between
`common-lttng-cmd-after-options.txt` and `common-footer.txt`.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I1eee42d7386f4671d9825e9d3e131e54f868ee39
38 files changed:
doc/man/Makefile.am
doc/man/README.md
doc/man/common-cmd-footer.txt [deleted file]
doc/man/common-cmd-help-options.txt [deleted file]
doc/man/common-lttng-cmd-after-options.txt [new file with mode: 0644]
doc/man/common-lttng-cmd-help-options.txt [new file with mode: 0644]
doc/man/common-lttng-cmd-options-head.txt [new file with mode: 0644]
doc/man/common-lttng-cmd-opts-head.txt [new file with mode: 0644]
doc/man/lttng-add-context.1.txt
doc/man/lttng-add-trigger.1.txt
doc/man/lttng-clear.1.txt
doc/man/lttng-create.1.txt
doc/man/lttng-destroy.1.txt
doc/man/lttng-disable-channel.1.txt
doc/man/lttng-disable-event.1.txt
doc/man/lttng-disable-rotation.1.txt
doc/man/lttng-enable-channel.1.txt
doc/man/lttng-enable-event.1.txt
doc/man/lttng-enable-rotation.1.txt
doc/man/lttng-help.1.txt
doc/man/lttng-list-triggers.1.txt
doc/man/lttng-list.1.txt
doc/man/lttng-load.1.txt
doc/man/lttng-metadata.1.txt
doc/man/lttng-regenerate.1.txt
doc/man/lttng-remove-trigger.1.txt
doc/man/lttng-rotate.1.txt
doc/man/lttng-save.1.txt
doc/man/lttng-set-session.1.txt
doc/man/lttng-snapshot.1.txt
doc/man/lttng-start.1.txt
doc/man/lttng-status.1.txt
doc/man/lttng-stop.1.txt
doc/man/lttng-track.1.txt
doc/man/lttng-untrack.1.txt
doc/man/lttng-version.1.txt
doc/man/lttng-view.1.txt
doc/man/lttng.1.txt
This page took 0.029495 seconds and 4 git commands to generate.