From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-112949-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 10627 invoked by alias); 2 Jun 2014 15:20:01 -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 10597 invoked by uid 89); 2 Jun 2014 15:19:59 -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,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL autolearn=no version=3.3.2
X-HELO: mtaout23.012.net.il
Received: from mtaout23.012.net.il (HELO mtaout23.012.net.il) (80.179.55.175) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 02 Jun 2014 15:19:58 +0000
Received: from conversion-daemon.a-mtaout23.012.net.il by a-mtaout23.012.net.il (HyperSendmail v2007.08) id <0N6J00100RL7ED00@a-mtaout23.012.net.il> for gdb-patches@sourceware.org; Mon, 02 Jun 2014 18:19:55 +0300 (IDT)
Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout23.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0N6J001GCRX7B180@a-mtaout23.012.net.il>; Mon, 02 Jun 2014 18:19:55 +0300 (IDT)
Date: Mon, 02 Jun 2014 15:20:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [PATCH, doc RFA]: Add guile progspace support
In-reply-to: <m3zjhwe58j.fsf@sspiff.org>
To: Doug Evans <xdje42@gmail.com>
Cc: gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83y4xf9w4t.fsf@gnu.org>
References: <m37g5fhr83.fsf@sspiff.org> <83lhttn88w.fsf@gnu.org> <m3zjhwe58j.fsf@sspiff.org>
X-IsSubscribed: yes
X-SW-Source: 2014-06/txt/msg00021.txt.bz2

> From: Doug Evans <xdje42@gmail.com>
> Cc: gdb-patches@sourceware.org
> Date: Sun, 01 Jun 2014 13:37:16 -0700
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >> From: Doug Evans <xdje42@gmail.com>
> >> Date: Wed, 21 May 2014 12:22:20 -0700
> >> 
> >> This patch adds guile progspace support.
> >
> > Thanks.
> >
> >> +@deffn {Scheme Procedure} progspace-filename progspace
> >> +Return the file name of @var{progspace} as a string.
> >> +If the program space does not have an associated file name,
> >> +then @code{#f} is returned.  This occurs, for example, when @value{GDBN}
> >> +is started without a program to debug.
> >
> > I guess this is the file name of the executable program running in the
> > progspace?  If so, why not tell that explicitly?  This text as written
> > begs the question what file is named by that string.  Also, is the
> > file absolute, relative, something else?  Is it just the value of
> > argv[0] in that program?  Etc. etc.
> 
> How about this?
> 
> +@deffn {Scheme Procedure} progspace-filename progspace
> +Return the file name of @var{progspace} as a string,
> +as an absolute path.
> +This is the name of file passed as the argument to the @code{file}
> +or @code{symbol-file} commands.
> +If the program space does not have an associated file name,
> +then @code{#f} is returned.  This occurs, for example, when @value{GDBN}
> +is started without a program to debug.
> +
> +A @code{gdb:invalid-object-error} exception is thrown if @var{progspace}
> +is invalid.
> +@end deffn

Allow me a slight rewording of the 1st sentence:

  Return the absolute file name of @var{progspace} as a string.

Also, "the name of the file" ("the" is missing).

Otherwise, OK.  Thanks.