Skip to content

Commit e35c8a0

Browse files
author
Mark Wielaard
committed
Resolve id conflicts in See Also sections in valgrind and vgdb manpages.
Because the manpages are processed together they cannot contain the same ids. Both the valgrind and vgdb manpage reference the vgdb main manual URL. That conflicts even though the valgrind.1 and vgdb.1 manual page are separate. Prefixing the vgdb ids (with "vgdb-") works around the conflict. It still works fine, since in vgdb the references are only directly used in the "See Also" refsect. The labels and urls still come out as intended. With this fix make valid validates both the manual index.xml and manpages-index.xml without errors.
1 parent de93a35 commit e35c8a0

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

coregrind/docs/vgdb-manpage.xml

+8-3
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,18 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes:
5757
valgrind(1),
5858
<filename>&vg-docs-path;</filename> or
5959
<filename>&vg-docs-url;</filename>,
60-
<ulink id="&vg-gdbserver-id;"
60+
<!-- Note that the ids used have vgdb- prefixed. This is because the same
61+
ids are used in the valgrind.1 man page. That conflict even though
62+
the valgrind.1 and vgdb.1 manual page are generated separately. It
63+
still works fine, since in vgdb the references are only direct in this
64+
"See Also" refsect. The labels and urls still come out as intended. -->
65+
<ulink id="vgdb-&vg-gdbserver-id;"
6166
xreflabel="&vg-gdbserver-label;"
6267
url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink>
63-
<ulink id="&vg-vgdb-id;"
68+
<ulink id="vgdb-&vg-vgdb-id;"
6469
xreflabel="&vg-vgdb-label;"
6570
url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>,
66-
<ulink id="&vg-monitor-id;"
71+
<ulink id="vgdb-&vg-monitor-id;"
6772
xreflabel="&vg-monitor-label;"
6873
url="&vg-monitor-url;">&vg-monitor-label;</ulink>.
6974
</para>

0 commit comments

Comments
 (0)