[rfc] README, doc/gdb.texinfo: warn against '.../configure/gdb-N.N/gdb/configure'
Eli Zaretskii
eliz@is.elta.co.il
Thu Jan 16 05:57:00 GMT 2003
On Wed, 15 Jan 2003, Michael Elizabeth Chastain wrote:
> mec> +In particular, if you run the first @code{configure} from the
> mec> +@file{gdb} subordinate directory of the @file{gdb-@var{version-number}}
> mec> +directory, you will omit the configuration of @file{bfd},
> mec> +@file{readline}, and other subordinate directories.
>
> eli> Here, I suggest to use ``sibling directories'' as the collective term
> eli> for `bfd', `readline' and other subdirectories of gdb-VERSION.
>
> I don't want to do this.
>
> Documentation is for humans, not other computer programs. Humans learn
> by example. When I write `bfd' and `readline', it's clear what I'm
> talking about. If I write `sibling directories', then the readers will
> be confused.
>
> Talking about `siblings of gdb' does not help because the directory name
> `gdb' is already overloaded. The whole section already talks about
> `gdb-VERSION' and its subdirectories, including `gdb', but people still
> run `configure' in the wrong directory and then come to us for help.
>
> And I think there is no problem with getting specific about `bfd' and
> `readline' because this section already specifically mentions these
> names as subdirectories of `gdb-VERSION'.
I think I didn't explain myself clearly, because I didn't mean to ask to
remove the names `bfd' and `readline'. I was just suggesting to say
something like this:
[...] you will omit the configuration of @file{bfd},
@file{readline}, and other sibling directories of the `gdb'
subdirectory.
Thanks.
More information about the Gdb-patches
mailing list