doc/man: use double quotes when referring to internal section
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 14 Jun 2021 17:05:37 +0000 (13:05 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Wed, 7 Jul 2021 21:31:33 +0000 (17:31 -0400)
commit7d2597248dc33f15e91305f2b48fd27f1db090b4
treeef5ad5d2512c506a2e9816627fb9a67741983262
parentf1cb70fba7cb2517a53acca393e2ef594d97f071
doc/man: use double quotes when referring to internal section

This patch adds double quotes to all the manual page internal section
references using their full name. Those references often have the
following AsciiDoc form:

    See the <<id,Full section name>> section below.

With this patch, this would be converted to:

    See the ``<<id,Full section name>>'' section below.

In the rendered manual page, before this patch:

    See the Full section name section below.
            ¯¯¯¯ ¯¯¯¯¯¯¯ ¯¯¯¯
With this patch:

    See the “Full section name” section below.

The purpose of this patch is, thanks to the change in
`doc/man/manpage.xsl`, to remove the italic style for the text of
internal links. Because there's no way to create dynamic internal links
in a manual page, this style causes internal links to look weird when
they're not a full section name, for example:

    Note that the trigger doesn't need to [...]
                  ¯¯¯¯¯¯¯
The HTML rendering of LTTng-tools manual pages can still benefit from
internal links. This patch makes it possible to add more internal links
without degrading the visual style of manual pages when rendered in a
terminal.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I1a5ef7eab7ff1e66c137e16b51a9c9074e43f583
30 files changed:
doc/man/common-daemon-cfg.txt
doc/man/lttng-add-context.1.txt
doc/man/lttng-add-trigger.1.txt
doc/man/lttng-clear.1.txt
doc/man/lttng-concepts.7.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-event-rule.7.txt
doc/man/lttng-list.1.txt
doc/man/lttng-load.1.txt
doc/man/lttng-regenerate.1.txt
doc/man/lttng-relayd.8.txt
doc/man/lttng-remove-trigger.1.txt
doc/man/lttng-rotate.1.txt
doc/man/lttng-save.1.txt
doc/man/lttng-sessiond.8.txt
doc/man/lttng-snapshot.1.txt
doc/man/lttng-start.1.txt
doc/man/lttng-stop.1.txt
doc/man/lttng-track.1.txt
doc/man/lttng-untrack.1.txt
doc/man/lttng-view.1.txt
doc/man/lttng.1.txt
doc/man/manpage.xsl
This page took 0.02834 seconds and 4 git commands to generate.