[Bug documentation/13103] New: substr man page flubs 3rd arg

[Bug documentation/13103] New: substr man page flubs 3rd arg

[jkenisto at us dot ibm.com]

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

             Bug #: 13103
           Summary: substr man page flubs 3rd arg
           Product: systemtap
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: documentation
        AssignedTo: systemtap@sourceware.org
        ReportedBy: jkenisto@us.ibm.com
    Classification: Unclassified


http://sourceware.org/systemtap/man/function::substr.3stap.html

The SYNOPSIS and ARGUMENTS sections say that the 3rd arg to substr() is the
length, but the GENERAL SYNTAX and DESCRIPTION sections say it's the stop
position.

Reported by Max Asbock.

-- 
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/13103] substr man page flubs 3rd arg

[mjw at redhat dot com]

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

Mark Wielaard <mjw at redhat dot com> changed:

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

--- Comment #1 from Mark Wielaard <mjw at redhat dot com> 2011-08-17 07:59:05 UTC ---
The GENERAL SYNTAX line was fixed by:

commit 86518ac521bab619698f36c3ec6fd1fe76a8d38b
Author: William Cohen <wcohen@redhat.com>
Date:   Wed Dec 8 20:40:24 2010 -0500

    Edit tapset documentation comments

    Made the following changes to the documentation comments:
       - Remove the "General Syntax:" lines.
       - Remove trailing '.' for the summaries.
       - Make parameter information phrases rather than sentences

I just rewrote the DESCRIPTION section:

commit 5da8feffae62c98343630e87d2d7cc120415166c
Author: Mark Wielaard <mjw@redhat.com>
Date:   Wed Aug 17 09:55:33 2011 +0200

    PR13103 substr 3 argument length description is wrong.

diff --git a/tapset/string.stp b/tapset/string.stp
index 9d3e65b..c3ecc4d 100644
--- a/tapset/string.stp
+++ b/tapset/string.stp
@@ -25,8 +25,10 @@ function strlen:long(s:string) %{ /* pure */ /* unprivileged 
  * @start: starting position of the extracted string (first character is 0)
  * @length: length of string to return
  *
- * Description: Returns the substring of the up to the given length
- * starting at the given start position and ending at given stop position.
+ * Description: Returns the substring of the given string at the given
+ * start position with the given length (or smaller if the length of the
+ * original string is less than start + length, or length is bigger than
+ * MAXSTRINGLEN).
  */
 function substr:string(str:string,start:long, length:long) %{ /* pure */ /*
unp
        int64_t length = clamp_t(int64_t, THIS->length + 1, 0, MAXSTRINGLEN);

Now trying to figure out how to update the online copy of the manpages on
sourceware.

-- 
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/13103] substr man page flubs 3rd arg

[mjw at redhat dot com]

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

--- Comment #2 from Mark Wielaard <mjw at redhat dot com> 2011-08-17 08:19:14 UTC ---
(In reply to comment #1)

The procedure is described here:
http://sourceware.org/systemtap/wiki/SystemTapDocUpdates
But I cannot find the man2html program/package for fedora that is necessary.

-- 
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/13103] substr man page flubs 3rd arg

[mjw at redhat dot com]

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

Mark Wielaard <mjw at redhat dot com> changed:

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

--- Comment #3 from Mark Wielaard <mjw at redhat dot com> 2011-08-17 23:04:08 UTC ---
(In reply to comment #2)
> (In reply to comment #1)
> 
> The procedure is described here:
> http://sourceware.org/systemtap/wiki/SystemTapDocUpdates
> But I cannot find the man2html program/package for fedora that is necessary.

Found a copy in rhel6, but apparently man2html isn't being shipped anymore with
fedora. Anyway, new version uploaded:
http://sourceware.org/systemtap/man/function::substr.3stap.html

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