X-Authentication-Warning:	delorie.com: mail set sender to djgpp-workers-bounces using -f
X-Recipient:	djgpp-workers AT delorie DOT com
X-Authenticated:	#27081556
X-Provags-ID:	V01U2FsdGVkX18BPRN96YwBNRmQoRwyXwd8/T740MZ4+2jYfMPB2G
	VsbRIexkg2V7Qj
Message-ID:	<002701c97e28$a36ea9a0$2202a8c0@computername>
From:	"Juan Manuel Guerrero" <juan DOT guerrero AT gmx DOT de>
To:	"Eli Zaretskii" <eliz AT gnu DOT org>
Cc:	<djgpp-workers AT delorie DOT com>
References:	<200901232346 DOT n0NNk61M003848 AT delorie DOT com> <uvds5t53c DOT fsf AT gnu DOT org>
Subject:	Re: djgpp: djgpp/src/libc/ansi/stdio/printf.txh
Date:	Sat, 24 Jan 2009 14:35:35 +0100
MIME-Version:	1.0
X-Priority:	3
X-MSMail-Priority:	Normal
X-Mailer:	Microsoft Outlook Express 6.00.2800.1106
X-MimeOLE:	Produced By Microsoft MimeOLE V6.00.2800.1106
X-Y-GMX-Trusted:	0
X-FuHaFi:	0.55
Reply-To:	djgpp-workers AT delorie DOT com

----- Original Message ----- 
From: "Eli Zaretskii" <eliz AT gnu DOT org>
To: "Juan Manuel Guerrero" <juan DOT guerrero AT gmx DOT de>
Cc: <djgpp-workers AT delorie DOT com>
Sent: Saturday, January 24, 2009 10:40 AM
Subject: Re: djgpp: djgpp/src/libc/ansi/stdio/printf.txh


> > Date: Fri, 23 Jan 2009 18:46:06 -0500
> > From: "cvs-juan DOT guerrero AT delorie DOT com" <cvs AT delorie DOT com>
> > 
> > ! int printf(const char *@var{format}, @dots{});
> >   @end example
> >   
> > --- 6,10 ----
> >   #include <stdio.h>
> >   
> > ! int printf(const char *format, @dots{});
> >   @end example
> 
> Why was this part of the change needed?  I think it's wrong: "format"
> is part of the function's argument list, so it should have the @var
> markup, as any other formal parameter.

The reason why I have removed this from the lines inside the @subheading Syntax
was to have them all identical.  An inspection of the .txh files shows that the
@var markup is used inside the @subheading Description but never inside the
@subheading Syntax.  I personally have no preferences but it was nice if one
single style is defined as defintive style to be used.  In that case all .txh
files can be changed accordingly.
As an arbitrary exapmle.  This is a verbatim copy of the relevant section from
atof.txh:

@subheading Syntax

@example
#include <stdlib.h>

double atof(const char *string);
@end example

As can be seen the @var markup is not used at all there and this is valid for
all .txh files I have inspected.  IMHO the code line looks better without the
markup effect because the C coder ussualy uses lower case characters, so the
syntax line looks more naturaly.  Anyway, I have no preferences, but to avoid
future inconveniences a definitive rule how to handle this issue should be
established and then all .txh files should be changed accordingly.


Regards,
Juan M. Guerrero

- Raw text -