[Bug documentation/14929] New: staperrors man page

[Bug documentation/14929] New: staperrors man page

[fche at redhat dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

             Bug #: 14929
           Summary: staperrors man page
           Product: systemtap
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: documentation
        AssignedTo: systemtap@sourceware.org
        ReportedBy: fche@redhat.com
    Classification: Unclassified


Often, systemtap errors are too complicated to explain within the stderr
message, and are inconveniently documented only as random tips on the wiki. 
Let's collect them in installed staperrors man pages, starting from pages such
as http://sourceware.org/systemtap/wiki/TipContextVariables, explaining some of
the more annoying ones.  We could tag error messages that are known specially
documented with a code at the call site.  Perhaps something like this:

% stap FOO.stp
semantic error: not accessible at this address (0x2b3e0, dieoffset: 0xaeff1):
identifier '$new' at ./sctp.stap:2:61
elaboration at man 3stap error::context
source: printf("sctp_assoc_update updates asoc peer rwnd to %d\n", 
$new->peer->rwnd);
^

% man 3stap error::context
... some tips ...

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

[Bug documentation/14929] staperrors man page

[nhorman at tuxdriver dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

Neil Horman <nhorman at tuxdriver dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |nhorman at tuxdriver dot
                   |                            |com

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

[Bug documentation/14929] staperrors man page

[smakarov at redhat dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

Serguei Makarov <smakarov at redhat dot com> changed:

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

--- Comment #1 from Serguei Makarov <smakarov at redhat dot com> 2012-12-07 20:46:53 UTC ---
Added groundwork to refer the user to manpages from the error message, in the
form of parse_error_manpage and semantic_error_manpage subclasses.

By the way, do we also want to refer the user to manpages for some of the
runtime errors that can arise in the actual compiled systemtap module?
Naturally, that would require a separate bit or bits of code.

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

[Bug documentation/14929] staperrors man page

[nhorman at tuxdriver dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

--- Comment #2 from Neil Horman <nhorman at tuxdriver dot com> 2012-12-09 16:53:30 UTC ---
If possible, I think that would be a nice feature add, given that the compiled
code is a little removed from the script sytax.

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

[Bug documentation/14929] staperrors man page

[fche at redhat dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

Frank Ch. Eigler <fche at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED

--- Comment #3 from Frank Ch. Eigler <fche at redhat dot com> 2013-01-28 22:22:28 UTC ---
Let's consider this first cut at error/warning man pages done with commit
1f35f4d.

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

[Bug documentation/14929] staperrors man page

[fche at redhat dot com]

http://sourceware.org/bugzilla/show_bug.cgi?id=14929

--- Comment #4 from Frank Ch. Eigler <fche at redhat dot com> 2013-02-06 18:55:55 UTC ---
*** Bug 14184 has been marked as a duplicate of this bug. ***

-- 
Configure bugmail: http://sourceware.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.