public inbox for gdb-prs@sourceware.org
help / color / mirror / Atom feed
From: "pedro at codesourcery dot com" <sourceware-bugzilla@sourceware.org>
To: gdb-prs@sourceware.org
Subject: [Bug python/12175] show_doc for gdb.Parameter has strange behaviour
Date: Tue, 16 Nov 2010 15:14:00 -0000	[thread overview]
Message-ID: <bug-12175-4717-unIIWzSsKZ@http.sourceware.org/bugzilla/> (raw)
In-Reply-To: <bug-12175-4717@http.sourceware.org/bugzilla/>

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

Pedro Alves <pedro at codesourcery dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |pedro at codesourcery dot
                   |                            |com

--- Comment #3 from Pedro Alves <pedro at codesourcery dot com> 2010-11-16 14:49:03 UTC ---
(In reply to comment #2)
On Tuesday 16 November 2010 14:32:01, pmuldoon at redhat dot com wrote:
> 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.

FYI, that's deprecated behavior that is going away at some point.
All commands should implement the necessary show-current-state callback so
that that fallback does not need to apply.  The reason that is broken is
that it only works for English...  At some point, I'd like to make a pass
through all commands in GDB, implement all the missing callbacks,
get rid of that fallback code, and put an assertion on place
making sure the command implements a show callback.

> 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?

I've no clue on the Python API, is there a way to implement the
"show" callback of a parameter?  If not, there should be.  If
yes, it should be a requirement to implement it, per the
rationale I mention above.

-- 
Pedro Alves

-- 
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.


  parent reply	other threads:[~2010-11-16 14:49 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-31 20:53 [Bug python/12175] New: " markflorisson88 at gmail dot com
2010-10-31 20:53 ` [Bug python/12175] " markflorisson88 at gmail dot com
2010-11-16 12:15 ` pmuldoon at redhat dot com
2010-11-16 12:16 ` pmuldoon at redhat dot com
2010-11-16 14:35 ` pmuldoon at redhat dot com
2010-11-16 15:14 ` pedro at codesourcery dot com [this message]
2010-11-16 15:30 ` pmuldoon at redhat dot com
2010-11-16 16:29 ` pedro at codesourcery dot com
2011-03-14 17:57 ` pmuldoon at redhat dot com
2011-03-16 10:29 ` pmuldoon at redhat dot com

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bug-12175-4717-unIIWzSsKZ@http.sourceware.org/bugzilla/ \
    --to=sourceware-bugzilla@sourceware.org \
    --cc=gdb-prs@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).