Re: Patch to gdb.texinfo

Eli Zaretskii
2000-03-13T00:59:00Z

> Please apply this patch to gdb.texinfo (revision 1.1.1.14).
> This fixes several typos and markup inconsistences.

Thanks! A few comments:

> @kindex quit @r{[}@var{expression}@r{]}
> @kindex q
> @item quit
> +@item quit @r{[}@var{expression}@r{]}

This should be @itemx, not @item (since this is in a @table). Or did
you intend to remove "@item quit"?

> -String constants are a sequence of character constants surrounded
> -by double quotes (@code{"}).
> +String constants are a sequence of character constants (without
> +single quotes) surrounded by double quotes (@code{"}).

I think "without single quotes" is ambiguous. I suggest "not
including single quote characters @samp{'}" instead. I also suggest
to use @samp, not @code here. A bare @code is IMHO not suitable for
character constants, as it lacks the delimiting quotes.

> -For complicated cases, you can specify an arbitrary number of @r{-T}@var{section} @var{address}
> +For complicated cases, you can specify an arbitrary number of @samp{@r{-T}@var{section} @var{address}}

I don't see the rationale for this change. Could you please explain?
From dima@Chg.RU Mon Mar 13 01:06:00 2000
From: Dmitry Sivachenko <dima@Chg.RU>
To: eliz@is.elta.co.il
Cc: gdb-patches@sourceware.cygnus.com
Subject: Re: Patch to gdb.texinfo
Date: Mon, 13 Mar 2000 01:06:00 -0000
Message-id: <200003130906.MAA63437@netserv1.chg.ru>
References: <200003121611.TAA45044@netserv1.chg.ru> <200003130859.DAA25938@indy.delorie.com>
X-SW-Source: 2000-03/msg00222.html
Content-length: 1170

> @kindex quit @r{[}@var{expression}@r{]}
> @kindex q
> @item quit
> +@item quit @r{[}@var{expression}@r{]}

This should be @itemx, not @item (since this is in a @table). Or did
you intend to remove "@item quit"?

Yes, you are right. It's my typo.

> -String constants are a sequence of character constants surrounded
> -by double quotes (@code{"}).
> +String constants are a sequence of character constants (without
> +single quotes) surrounded by double quotes (@code{"}).

I think "without single quotes" is ambiguous. I suggest "not
including single quote characters @samp{'}" instead. I also suggest
to use @samp, not @code here. A bare @code is IMHO not suitable for
character constants, as it lacks the delimiting quotes.

I agree.

> -For complicated cases, you can specify an arbitrary number of @r{-T}@var{section} @var{address}
> +For complicated cases, you can specify an arbitrary number of @samp{@r{-T}@var{section} @var{address}}

I don't see the rationale for this change. Could you please explain?

Look at the printable copy. Single quotes around `-Tsection address'
looks better.

--dima