This is the mail archive of the gdb@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Formatting of packet descriptions in GDB manual


On Sun, Nov 13, 2005 at 12:53:51AM +0200, Eli Zaretskii wrote:
> > >   @code{z}@code{3}@code{,}@var{addr}@code{,}@var{length}
> > >
> > > is it important to have `z', `3', and the comma typeset as 3 separate
> > > characters, or is it okay to see a single string `z3,'?  At the time I
> > > looked at this section, the answer was not clear to me.  You seem to
> > > indicate that it's okay to produce a single string here, but what do
> > > others think.

I don't think they need to be typeset separately.  In fact, I don't
want them to be.  You can't search for useful things in the info manual
this way - to use search (rather than index) to reach the particular
packet, you have to know where the quotes are and search for z'`3.
Yuck.

> 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

100% agree.

-- 
Daniel Jacobowitz
CodeSourcery, LLC


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]