From: Michael Elizabeth Chastain <mec@shout.net>
To: eliz@is.elta.co.il
Cc: gdb-patches@sources.redhat.com
Subject: Re: [rfc] README, doc/gdb.texinfo: warn against '.../configure/gdb-N.N/gdb/configure'
Date: Wed, 15 Jan 2003 19:42:00 -0000 [thread overview]
Message-ID: <200301151942.h0FJgjb29499@duracef.shout.net> (raw)
Hi Eli,
> I sugegst to use ``subdirectory'' instead of ``subordinate
> directory'', like this:
Done. I had a ``subordinate'' lying around somewhere in my brain's
L1 cache.
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'.
> It would also be nice to have some index entry for this text. For
> example:
>
> @cindex configuring @value{GDBN}, and source tree subdirectories
Done.
The CVS repository is not responding right now, so I can't make another
diff yet.
Michael C
next reply other threads:[~2003-01-15 19:42 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2003-01-15 19:42 Michael Elizabeth Chastain [this message]
2003-01-16 5:57 ` Eli Zaretskii
-- strict thread matches above, loose matches on Subject: below --
2003-01-16 16:52 Michael Elizabeth Chastain
2003-01-15 18:43 Michael Elizabeth Chastain
2003-01-15 18:59 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=200301151942.h0FJgjb29499@duracef.shout.net \
--to=mec@shout.net \
--cc=eliz@is.elta.co.il \
--cc=gdb-patches@sources.redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox