[Bug documentation/16968] New: bad formatting in many help pages for probes

["jlebon at redhat dot com" <sourceware-bugzilla at sourceware dot org>]

https://sourceware.org/bugzilla/show_bug.cgi?id=16968

            Bug ID: 16968
           Summary: bad formatting in many help pages for probes
           Product: systemtap
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: documentation
          Assignee: systemtap at sourceware dot org
          Reporter: jlebon at redhat dot com

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::'

-- 
You are receiving this mail because:
You are the assignee for the bug.