From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 27651 invoked by alias); 16 Nov 2010 14:32:07 -0000 Received: (qmail 27624 invoked by uid 22791); 16 Nov 2010 14:32:06 -0000 X-SWARE-Spam-Status: No, hits=-2.5 required=5.0 tests=ALL_TRUSTED,AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from localhost (HELO sourceware.org) (127.0.0.1) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 16 Nov 2010 14:32:02 +0000 From: "pmuldoon at redhat dot com" To: gdb-prs@sourceware.org Subject: [Bug python/12175] show_doc for gdb.Parameter has strange behaviour X-Bugzilla-Reason: CC X-Bugzilla-Type: changed X-Bugzilla-Watch-Reason: None X-Bugzilla-Product: gdb X-Bugzilla-Component: python X-Bugzilla-Keywords: X-Bugzilla-Severity: normal X-Bugzilla-Who: pmuldoon at redhat dot com X-Bugzilla-Status: ASSIGNED X-Bugzilla-Priority: P2 X-Bugzilla-Assigned-To: pmuldoon at redhat dot com X-Bugzilla-Target-Milestone: --- X-Bugzilla-Changed-Fields: Message-ID: In-Reply-To: References: X-Bugzilla-URL: http://sourceware.org/bugzilla/ Auto-Submitted: auto-generated Content-Type: text/plain; charset="UTF-8" MIME-Version: 1.0 Date: Tue, 16 Nov 2010 14:35:00 -0000 Mailing-List: contact gdb-prs-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-prs-owner@sourceware.org X-SW-Source: 2010-q4/txt/msg00134.txt.bz2 http://sourceware.org/bugzilla/show_bug.cgi?id=12175 --- Comment #2 from Phil Muldoon 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.