Sender: rich AT phekda DOT freeserve DOT co DOT uk
Message-ID: <3A6B1D8C.86A1ADF1@phekda.freeserve.co.uk>
Date: Sun, 21 Jan 2001 17:34:04 +0000
From: Richard Dawe <rich AT phekda DOT freeserve DOT co DOT uk>
X-Mailer: Mozilla 4.51 [en] (X11; I; Linux 2.2.17 i586)
X-Accept-Language: de,fr
MIME-Version: 1.0
To: djgpp-workers AT delorie DOT com
Subject: Re: Describe @portability in develop.txi [Was: Re: mkdoc patch, take 2]
References: <Pine DOT SUN DOT 3 DOT 91 DOT 1000711100538 DOT 19180B-100000 AT is> <396B6BB3 DOT 49C1F993 AT phekda DOT freeserve DOT co DOT uk> <3A6B08A1 DOT D3F04FDE AT phekda DOT freeserve DOT co DOT uk> <2950-Sun21Jan2001190611+0200-eliz AT is DOT elta DOT co DOT il>
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Reply-To: djgpp-workers AT delorie DOT com

Hello.

Eli Zaretskii wrote:
> It might be better to use @acronym for ANSI and POSIX.  It's not a
> requirement, though; it's up to you.  (Personally, I think @acronym
> looks much better in print.)

'@acronym' appeared in texinfo 4.0, according to the news file
(gnu/texinfo4.0/news). Do we require texinfo 4.0 to build DJGPP now?

> This cross-reference won't work.  You need a 4-argument form of
> @pxref, not a 3-argument form.  See the Texinfo manual, under @xref.

Thanks, I've fixed & tested those links now. There's a new diff below. OK
to commit now?

Thanks, bye, Rich =]

*** src/docs/kb/develop.txi.orig        Sun Jan 21 15:25:48 2001
--- src/docs/kb/develop.txi     Sun Jan 21 17:26:34 2001
***************
*** 96,101 ****
--- 96,127 ----
  @end itemize
  
  @item
+ Under the subheading @samp{Portability}, @samp{@@portability} should be
+ used to indicate whether a feature is specified in the ANSI C and POSIX
+ standards.  For example:
+ 
+ @example
+ @@subheading Portability
+ 
+ @@portability !ansi, posix
+ @end example
+ 
+ Please note that @samp{@@portability} is not used to indicate whether
+ the DJGPP implementation complies with the standards listed.  Instead,
+ @samp{@@port-note} may be used to describe implementation-specific
details:
+ 
+ @example
+ @@port-note ansi The buffer size limit is imposed by DJGPP.
+ @end example
+ 
+ @samp{@@portability} and @samp{@@port-note} are DJGPP-specific
extensions
+ of texinfo (@pxref{Top, , texinfo, texinfo}) that are expanded into
normal
+ texinfo by @code{mkdoc}.  @code{mkdoc} is part of the DJGPP sources.  It
is
+ used to build the C library documentation (@pxref{Top, , libc, libc}).
+ Therefore, @samp{@@portability} and @samp{@@port-note} should only be
used
+ in DJGPP's C library documentation.
+ 
+ @item
  Finally, for some relevant texinfo technique, look at the source
  of this page in the DJGPP sources--- AT file{src/docs/kb/contrib.txi}.
  @end itemize