| Summary: | valgrind.1 manpage contains unknown ??? strings for some core option references | ||
|---|---|---|---|
| Product: | [Developer tools] valgrind | Reporter: | Mark Wielaard <mark> |
| Component: | general | Assignee: | Julian Seward <jseward> |
| Status: | RESOLVED FIXED | ||
| Severity: | normal | CC: | mfranc, philippe.waroquiers |
| Priority: | NOR | ||
| Version First Reported In: | 3.9.0.SVN | ||
| Target Milestone: | --- | ||
| Platform: | Other | ||
| OS: | Linux | ||
| Latest Commit: | Version Fixed/Implemented In: | ||
| Sentry Crash Report: | |||
| Attachments: | Share gdbserver, vgdb, monitor, comment and pthreads-perf-sched xrefs. | ||
Created attachment 77756 [details] Share gdbserver, vgdb, monitor, comment and pthreads-perf-sched xrefs. Separate out ids, labels and urls for shared manual and manpages usage as entities. With this patch the manpage contains the expected text and a list of URLs at the end to the manual on the website. The same section as above now shows: See Debugging your program using Valgrind's gdbserver and GDB for a detailed description. If the embedded gdbserver is enabled but no gdb is currently being used, the vgdb command line utility can send "monitor commands" to Valgrind from a shell. The Valgrind core provides a set of Valgrind monitor commands. With the See Also section extended as: Debugging your program using Valgrind's gdbserver and GDB[1] vgdb[2], Valgrind monitor commands[3], [...] And the NOTES section has: NOTES 1. Debugging your program using Valgrind's gdbserver and GDB http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.gdbserver 2. vgdb http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.vgdb 3. Valgrind monitor commands http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.valgrind-monitor-commands (In reply to comment #1) > Created attachment 77756 [details] > Share gdbserver, vgdb, monitor, comment and pthreads-perf-sched xrefs. > > Separate out ids, labels and urls for shared manual and manpages usage as > entities. > > With this patch the manpage contains the expected text and a list of URLs at > the end to the manual on the website. The same section as above now shows: I tried the patch, which gives a better man page. I also build the html doc, which is ok. However, I cannot test the printed doc (I could never persuade make print-docs to work). Are these changes also working for the .ps and .pdf manual ? (In reply to comment #2) > However, I cannot test the printed doc (I could never persuade > make print-docs to work). > > Are these changes also working for the .ps and .pdf manual ? make print-docs doesn't work for me either without manual intervention. But if I run pdfxmltex index.fo by hand to get around the error (seems to be some image issue on the frontpage?) then the output looks good (except for the front page) and the links between the sections work fine too (when using evince as viewer). (In reply to comment #3) > (In reply to comment #2) > > However, I cannot test the printed doc (I could never persuade > > make print-docs to work). > > > > Are these changes also working for the .ps and .pdf manual ? > > make print-docs doesn't work for me either without manual intervention. > But if I run pdfxmltex index.fo by hand to get around the error (seems to be > some image issue on the frontpage?) then the output looks good (except for > the front page) and the links between the sections work fine too (when using > evince as viewer). Thanks for the feedback/test and patch. Committed revision 13314 (In reply to comment #4) > Thanks for the feedback/test and patch. > Committed revision 13314 Thanks. Would you mind also taking a look at the related documentation issues in bug 315959 and bug 316145? |
When generating the valgrind.1 manpage it xsl:includes the core argument options list. Some options xref other parts of the manual that isn't included in the manpages. This causes the manual page to contain things like: See ??? for a detailed description. If the embedded gdbserver is enabled but no gdb is currently being used, the ??? command line utility can send "monitor commands" to Valgrind from a shell. The Valgrind core provides a set of ???. Reproducible: Always