This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Add support for --with-system-gdbinit
> Date: Wed, 21 Jan 2009 11:53:48 +0100
> From: Jerome Guitton <guitton@adacore.com>
> Cc: gdb-patches@sourceware.org
>
> Index: doc/gdb.texinfo
> ===================================================================
> RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
> retrieving revision 1.545
> diff -u -p -r1.545 gdb.texinfo
> --- doc/gdb.texinfo 14 Jan 2009 11:47:07 -0000 1.545
> +++ doc/gdb.texinfo 21 Jan 2009 10:52:02 -0000
This part is approved, with a few minor comments:
> +Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was
There's no need to use @dfn for the same term more than once. Once
the term is introduced, you should use it without the @dfn markup.
> +@value{GDBN} can be configured to have a system-wide @dfn{init file};
Likewise.
> +If the default location of this init file contains the prefix,
^^^^^^^^^^
It took me a while to understand what is meant by "the prefix". I
think we should explain this explicitly, as referring to $prefix.
> +it will be subject to relocation. Suppose that @value{GDBN} has been
^^
Two spaces after a period that ends a sentence, please.
> +configured with @kbd{--prefix=$prefix} and
> +@kbd{--with-system-gdbinit=$prefix/etc/gdbinit}; if @value{GDBN} is
It is better to use @option here, not @kbd, since you are not
describing keyboard input.
> +installed somewhere else (say: in @file{$install/bin}), the system
> +init file will be looked for relatively to this new location: in our
> +case, it will be @file{$install/bin/../etc/gdbinit}.
This is a bit confusing, because you say
if @value{GDBN} is installed somewhere else (say: in @file{$install/bin})
This subtly introduces the bin/ subdirectory and requires the reader
to know that "@value{GDBN} is installed" refers to the GDB _binary_,
not to GDB as a package. The latter is, of course, installed in
$prefix and moved to $install.
Can you rewrite this bit to explain that GDB is moved from $prefix to
$install, and then the system-wide init file is looked for as
$install/etc/gdbinit instead of $prefix/etc/gdbinit?
> +At the contrary, if the default location does not contain the prefix,
^^^^^^^^^^^^^^^
"By contrast" is better here.
> +it will not be relocated. E.g.@: if @value{GDBN} has been configured with
^^
Two spaces.
Thanks.