[Bug python/12175] show_doc for gdb.Parameter has strange behaviour

["pmuldoon at redhat dot com" <sourceware-bugzilla@sourceware.org>]

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

--- Comment #2 from Phil Muldoon <pmuldoon at redhat dot com> 2010-11-16 14:31:51 UTC ---
Well I was wrong, these are not bugs.  Just a weird implementation inside GDB:

Take your example:

class Param(gdb.Parameter):
    """some-param is a switch that does nothing at all.
You can set it and show it as much as you like."""
    show_doc = "Show the some-param switch"
    set_doc = "Set the some-param switch to on or off. "
Param("some-param", gdb.COMMAND_NONE, gdb.PARAM_BOOLEAN)

(gdb) show some-param
The some-param switch is off.
(gdb) help show some-param
Show the some-param switch
some-param is a switch that does nothing at all.
You can set it and show it as much as you like.
(gdb) help set some-param
Set the some-param switch to on or off. 
some-param is a switch that does nothing at all.
You can set it and show it as much as you like.

When you "show" a parameter, the show_doc documentation is used and then the
value appended at the end (in this case, "off").  GDB trims off the first five
letters of the show documentations (the "Show") so it can reuse it for both the
help text and the value assignment text.  Ditto for the Set.

So the example above "works".


The "command is not documented" is printed if either show_doc, set_doc or doc
is not set in the parameter.

Maybe we need a better explanation in the manual?

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