public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Doug Evans <xdje42@gmail.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH, doc RFA] Add guile gdb command support
Date: Thu, 22 May 2014 15:40:00 -0000	[thread overview]
Message-ID: <83k39dn7ne.fsf@gnu.org> (raw)
In-Reply-To: <m34n0jhqy7.fsf@sspiff.org>

> From: Doug Evans <xdje42@gmail.com>
> Date: Wed, 21 May 2014 12:28:16 -0700
> 
> This patch adds gdb command support for guile.

Thanks.

> +@var{name} is the name of the command.

This will look wrong in print, because "name" is not capitalized by
TeX, just typeset in cursive typeface.  I would start with "The
@var{name} argument is ..." or some such.

> +@var{invoke} is a procedure of three arguments: @var{self}, @var{args}

Likewise here.

> +@var{completer} is either @code{#f}, one of the @samp{COMPLETE_} constants

And here.

> +@var{prefix} is a boolean flag indicating whether the new

And here.

> +@var{doc-string} is help text for the new command.

And here.

> +There is no support for multi-line commands.

What is a "multi-line command"?  Perhaps mention an example.

> +If the return value is a <gdb:iterator> object, it is iterated over to
                            ^^^^^^^^^^^^^^
@code markup here, please.

> +@item COMMAND_USER
> +The command is a general purpose command for the user, and typically
> +does not fit in one of the other categories.
> +Type @kbd{help user-defined} at the @value{GDBN} prompt to see
> +a list of commands in this category, as well as the list of gdb macros
> +(@pxref{Sequences}).

I think "help user-defined" lists commands defined by the user, in
which case the text above is inaccurate.

OK with those fixes.

  reply	other threads:[~2014-05-22 15:40 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-21 19:28 Doug Evans
2014-05-22 15:40 ` Eli Zaretskii [this message]
2014-05-22 16:39   ` Eli Zaretskii
2014-06-02  0:13   ` Doug Evans
2014-06-02 15:33     ` Eli Zaretskii
2014-06-03  7:33       ` Doug Evans
2014-06-03  8:33         ` Ludovic Courtès

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=83k39dn7ne.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=xdje42@gmail.com \
    /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).