Actions
Bug #1328
closedlttng-enable-event: lttng.org/man not rendering 'PROVIDER:NAME' correctly
Start date:
10/28/2021
Due date:
% Done:
0%
Estimated time:
Description
The man pages for `lttng-enable-event` do not render this correctly:
__PROVIDER__++:++__NAME__
some instances in the source files for 2.11-2.13:
- 2.13: * https://github.com/lttng/lttng-tools/blob/261e7f1360fffe91b0b690c8a0715f4f6d2c4a7e/doc/man/lttng-enable-event.1.txt#L275 * https://github.com/lttng/lttng-tools/blob/261e7f1360fffe91b0b690c8a0715f4f6d2c4a7e/doc/man/lttng-enable-event.1.txt#L563
- 2.12: * https://github.com/lttng/lttng-tools/blob/80a909e3c3a1f3003527db16953db5e97b633248/doc/man/lttng-enable-event.1.txt#L537
- 2.11: * https://github.com/lttng/lttng-tools/blob/dd8ce0acaf4c9166fd52779211aaf408fc0a1d13/doc/man/lttng-enable-event.1.txt#L537
It should render it as:
PROVIDER:NAME
(+ some formatting), but it renders it as:
:PROVIDERNAME
See under the following sections for 2.11-2.13 (or just search for ":PROVIDERNAME"):
- https://lttng.org/man/1/lttng-enable-event/v2.13/#doc-event-name-cond
- https://lttng.org/man/1/lttng-enable-event/v2.13/#doc-er-name
- https://lttng.org/man/1/lttng-enable-event/v2.12/#doc-opt--userspace-probe
- https://lttng.org/man/1/lttng-enable-event/v2.11/#doc-opt--userspace-probe
Also, note that a similar line ('sdt:PATH:PROVIDER:NAME' under '--userspace-probe=') is rendered fine for 2.11-2.13:
- https://lttng.org/man/1/lttng-enable-event/v2.11/#doc-opt--userspace-probe
- https://lttng.org/man/1/lttng-enable-event/v2.12/#doc-opt--userspace-probe
- https://lttng.org/man/1/lttng-enable-event/v2.13/#doc-opt--userspace-probe
source line for 2.13: https://github.com/lttng/lttng-tools/blob/261e7f1360fffe91b0b690c8a0715f4f6d2c4a7e/doc/man/lttng-enable-event.1.txt#L742
I don't think the exact setup to render man pages for lttng.org/man is public, so I couldn't try to fix it myself.
Actions