Mirror of the gdb mailing list
 help / color / mirror / Atom feed
From: Jim Blandy <jimb@red-bean.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: gdb@sources.redhat.com
Subject: Re: Formatting of packet descriptions in GDB manual
Date: Sat, 12 Nov 2005 23:07:00 -0000	[thread overview]
Message-ID: <8f2776cb0511121507s401c9bb0xe4faa8ca9dd89680@mail.gmail.com> (raw)
In-Reply-To: <u4q6h32bk.fsf@gnu.org>

On 11/12/05, Eli Zaretskii <eliz@gnu.org> wrote:
> > I tried that first --- but notice that each @item has explanatory text
> > after the packet, like "--- remove hardware breakpoint".
>
> This is a @table, so that text should be in the next line, not on the
> @item line.  In many cases, this text is redundant anyway, since what
> follows the @item line repeats the explanation.

Bless your heart.  That's what I actually wanted to do, but not badly
enough to bother picking a fight over it.

> Because each individual character might be of some importance,
> mnemonic if not anything else.  But that's a guess, I really don't
> have a good answer for this question.

I just see our job as defining a syntax.  There's no tokenization
going on here; those characters must appear in that exact sequence.

> Perhaps we should use blanks between those @var's, but explain in the
> text that there shouldn't be blanks in the real packet, and give an
> example to demonstrate that

BLANKS???  What's WRONG with you???

Of course --- that'd work perfectly.


  reply	other threads:[~2005-11-12 23:07 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-12  0:25 Jim Blandy
2005-11-12  7:07 ` Eli Zaretskii
2005-11-12  8:47   ` Jim Blandy
2005-11-12 22:53     ` Eli Zaretskii
2005-11-12 23:07       ` Jim Blandy [this message]
2005-11-13 17:12       ` Daniel Jacobowitz
2005-11-13 22:10         ` Eli Zaretskii
2005-11-14  2:29           ` Daniel Jacobowitz
2005-11-14  4:29             ` Eli Zaretskii
2005-11-14 13:49               ` Daniel Jacobowitz
2005-11-16  5:47                 ` Jim Blandy
2005-11-16  6:54                   ` 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=8f2776cb0511121507s401c9bb0xe4faa8ca9dd89680@mail.gmail.com \
    --to=jimb@red-bean.com \
    --cc=eliz@gnu.org \
    --cc=gdb@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