This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH, doc RFA]: Add guile progspace support


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


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]