From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-112714-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 10026 invoked by alias); 22 May 2014 15:40:44 -0000
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
Received: (qmail 10016 invoked by uid 89); 22 May 2014 15:40:43 -0000
Authentication-Results: sourceware.org; auth=none
X-Virus-Found: No
X-Spam-SWARE-Status: No, score=-2.8 required=5.0 tests=AWL,BAYES_00,SPF_SOFTFAIL autolearn=no version=3.3.2
X-HELO: mtaout25.012.net.il
Received: from mtaout25.012.net.il (HELO mtaout25.012.net.il) (80.179.55.181) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 22 May 2014 15:40:42 +0000
Received: from conversion-daemon.mtaout25.012.net.il by mtaout25.012.net.il (HyperSendmail v2007.08) id <0N5Z00300F3X7V00@mtaout25.012.net.il> for gdb-patches@sourceware.org; Thu, 22 May 2014 18:37:32 +0300 (IDT)
Received: from HOME-C4E4A596F7 ([87.69.4.28]) by mtaout25.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0N5Z003G4FEKDV10@mtaout25.012.net.il>; Thu, 22 May 2014 18:37:32 +0300 (IDT)
Date: Thu, 22 May 2014 15:40:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [PATCH, doc RFA] Add guile gdb command support
In-reply-to: <m34n0jhqy7.fsf@sspiff.org>
To: Doug Evans <xdje42@gmail.com>
Cc: gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83k39dn7ne.fsf@gnu.org>
References: <m34n0jhqy7.fsf@sspiff.org>
X-IsSubscribed: yes
X-SW-Source: 2014-05/txt/msg00552.txt.bz2

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