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

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

[jlebon at redhat dot com]

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.

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

[wcohen at redhat dot com]

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

William Cohen <wcohen at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |wcohen at redhat dot com

--- Comment #1 from William Cohen <wcohen at redhat dot com> ---
Created attachment 7818
  --> https://sourceware.org/bugzilla/attachment.cgi?id=7818&action=edit
Add backtrace support for aarch64

This is an attempt to implement the backtrace support for aarch64.  The patch
should be reviewed by someone more knowledgable about the unwinder support such
as Mark Wielaard

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

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

[wcohen at redhat dot com]

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

--- Comment #2 from William Cohen <wcohen at redhat dot com> ---
Ignore comment #1 that was for a different PR.

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

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

[flu at redhat dot com]

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

Felix Lu <flu at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
                 CC|                            |flu at redhat dot com
         Resolution|---                         |FIXED

--- Comment #3 from Felix Lu <flu at redhat dot com> ---
Fixed in commit 7441e8ec677e50f60acf90576fd190837d412ea6

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