From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-return-23124-listarch-gdb=sources.redhat.com@sourceware.org>
Received: (qmail 18002 invoked by alias); 8 Nov 2005 23:19:36 -0000
Mailing-List: contact gdb-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Subscribe: <mailto:gdb-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb/>
List-Post: <mailto:gdb@sourceware.org>
List-Help: <mailto:gdb-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-owner@sourceware.org
Received: (qmail 17671 invoked by uid 22791); 8 Nov 2005 23:19:33 -0000
Received: from romy.inter.net.il (HELO romy.inter.net.il) (192.114.186.66)
    by sourceware.org (qpsmtpd/0.30-dev) with ESMTP; Tue, 08 Nov 2005 23:19:33 +0000
Received: from HOME-C4E4A596F7 (IGLD-80-230-84-149.inter.net.il [80.230.84.149])
	by romy.inter.net.il (MOS 3.5.8-GR)
	with ESMTP id CXW29510 (AUTH halo1);
	Wed, 9 Nov 2005 01:19:27 +0200 (IST)
Date: Tue, 08 Nov 2005 23:19:00 -0000
Message-Id: <u7jbisp6n.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Andrew STUBBS <andrew.stubbs@st.com>
CC: gdb@sources.redhat.com
In-reply-to: <43709E94.4070004@st.com> (message from Andrew STUBBS on Tue, 08
	Nov 2005 12:48:20 +0000)
Subject: Re: $argc variable
Reply-to: Eli Zaretskii <eliz@gnu.org>
References: <436A0BD2.5080505@st.com> <20051107001800.GF19200@nevyn.them.org> <436F35E9.4070808@st.com> <20051107133538.GA2331@nevyn.them.org> <43709E94.4070004@st.com>
X-SW-Source: 2005-11/txt/msg00194.txt.bz2

> Date: Tue, 08 Nov 2005 12:48:20 +0000
> From: Andrew STUBBS <andrew.stubbs@st.com>
> Cc: GDB List <gdb@sources.redhat.com>

Btw, Andrew, why do you post patches to gdb@sources.redhat.com, rather
than to gdb-patches@ ?  The latter is the right place.

> In the documentation I changed a '@var' to '@code' because @var makes it 
> upper case in the info and I thought that misleading.

Upper case is not the problem: makeinfo produces an uppercase word
from @var since time immemoriam, so anyone who's used to read Info
manuals is already used to that.

The problem here is that it's simply wrong to use @var in this case,
because $arg0 etc. are literal strings, to be used verbatim in the
actual script, not placeholders that stand for something else.  So
your change is correct, although for the wrong reasons. ;-)

> -via @var{$arg0@dots{}$arg9}.  A trivial example:

However, there _is_ something wrong here: the $ part should be outside
@var, since it's a literal character:

  via @code{$@var{arg0}@dots{}$@var{arg9}}.

> +via @code{$arg0@dots{}$arg9}.  A trivial example:
>  
>  @smallexample
>  define adder
>    print $arg0 + $arg1 + $arg2
> +end
>  @end smallexample

In the example, I would suggest to use something other than arg0 etc.,
to avoid confusion with arg0..arg9 as placeholders in the paragraph
where you wanted to remove @var.

> +@kindex $argc

I'd replace this with "@cindex arguments for user-defined function".

Other than that, the documentation patch is okay with me.  Thanks.