Bug 16968 - bad formatting in many help pages for probes
Summary: bad formatting in many help pages for probes
Status: RESOLVED FIXED
Alias: None
Product: systemtap
Classification: Unclassified
Component: documentation (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: Unassigned
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-05-20 19:01 UTC by Jonathan Lebon
Modified: 2015-08-25 19:49 UTC (History)
2 users (show)

See Also:
Host:
Target:
Build:
Last reconfirmed:


Attachments
Add backtrace support for aarch64 (1.58 KB, patch)
2014-10-07 19:59 UTC, William Cohen
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jonathan Lebon 2014-05-20 19:01:56 UTC
There are many probe help pages which have their values squished into the 'Description' section, rather than the 'Value' section. For example:

https://sourceware.org/systemtap/tapsets/API-ioblock-end.html

Or, as a man page:

$ man 3stap probe::ioblock.end

Compare with a properly formatted one:

https://sourceware.org/systemtap/tapsets/API-ioscheduler-elv-add-request.html

Or, as a man page:

$ man 3stap probe::ioscheduler.elv_add_request

Most likely the formatting used in the comment blocks of these tapset functions is not correct.

PS: an easy way to iterate over all the 'probe::' man pages:

$ man -K 3stap 'probe::'
Comment 1 William Cohen 2014-10-07 19:59:41 UTC Comment hidden (spam)
Comment 2 William Cohen 2014-10-13 17:45:46 UTC Comment hidden (spam)
Comment 3 Felix Lu 2015-08-25 19:49:58 UTC
Fixed in commit 7441e8ec677e50f60acf90576fd190837d412ea6