Mirror of the gdb mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: gdb@sourceware.org
Cc: karl@freefriends.org
Subject: Re: [remote] RFC: Replace qPart with qXfer
Date: Fri, 23 Jun 2006 20:10:00 -0000	[thread overview]
Message-ID: <uejxfagrd.fsf@gnu.org> (raw)
In-Reply-To: <20060623171419.GA28992@nevyn.them.org> (message from Daniel 	Jacobowitz on Fri, 23 Jun 2006 13:14:19 -0400)

> Date: Fri, 23 Jun 2006 13:14:19 -0400
> From: Daniel Jacobowitz <drow@false.org>
> 
> > >           Access the target's "auxiliary vector".  *Note auxiliary
> > >           vector: OS Information, and see *Note read-aux-vector-packet:
> >                                         ^^^
> > This "see" is redundant.  I suspect you used "see @ref"; if so, just
> > drop the "see" part.
> 
> [...]
> 
> Confused.  The example in the Texinfo manual suggests "see @ref", and
> says that you shouldn't just drop it, because e.g. "in *Note" is
> considered awkward.

The first example in the "ref" node indeed might sound as if it says
that, but the truth is that @ref exists precisely _because_ you might
sometimes want to omit the "see" part, because the sentence structure
requires that.

You shouldn't read that section of the Texinfo manual too literally,
all it wants to say is that you should think about how the sentence
will sound in both Info and printed versions, and apply your best
judgement as to what would be best.

Karl, is it possible to reword that section along these lines
(provided that you agree with my reasoning, of course)?

In the case in point, I think that "*Note FOO, and *Note BAR" sounds
better than with the extra "see".  You don't have the "in" in your
sentence, so the situation is different from what the manual
describes.  In the printed version, removing "see" will produce this:

  See Section X.YZ [OS Information], page 123, and Section A.BC
  [read-aux-vector], page 456.

which is okay, I think.


  reply	other threads:[~2006-06-23 18:06 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-06-22  8:42 Daniel Jacobowitz
2006-06-22  9:05 ` Vladimir Prus
2006-06-22 12:35   ` What's the difference between gdb arm targets? Dave Murphy
2006-06-22 12:39     ` Daniel Jacobowitz
2006-06-22 13:17   ` [remote] RFC: Replace qPart with qXfer Daniel Jacobowitz
2006-06-23 16:23 ` Eli Zaretskii
2006-06-23 18:06   ` Daniel Jacobowitz
2006-06-23 20:10     ` Eli Zaretskii [this message]
2006-06-24  2:24       ` Daniel Jacobowitz
2006-06-25  3:10       ` Karl Berry
2006-06-25  4:07         ` 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=uejxfagrd.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb@sourceware.org \
    --cc=karl@freefriends.org \
    /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