Date: Mon, 20 Jan 2003 08:25:22 +0200 (IST)
From: Eli Zaretskii <eliz AT is DOT elta DOT co DOT il>
X-Sender: eliz AT is
To: Charles Sandmann <sandmann AT clio DOT rice DOT edu>
cc: DJGPP developers <djgpp-workers AT delorie DOT com>
Subject: Re: src/stub/stubdocs.txi
In-Reply-To: <10301200055.AA27206@clio.rice.edu>
Message-ID: <Pine.SUN.3.91.1030120081843.21625L-100000@is>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Reply-To: djgpp-workers AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: djgpp-workers AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk


On Sun, 19 Jan 2003, Charles Sandmann wrote:

> New file; included by ../utils/utils.tex

Thanks!

> @node go32-v2, stubify, , Top
> @chapter go32-v2
> 
> @code{go32-v2} is a utility which allows you to run unstubbed
> @acronym{COFF} images.

Program names should in general have the @command markup, not @code.  
(The effect is the same as of this writing, but I think it's better to 
use the correct markup anyway.)  Please also use @command (and other 
relevant markups) in the @chapter and @section lines; only @node should 
not have any @-commands in it.

I'd prefer a "@pindex @command{go32-v2}" entry right after the @chapter 
line.

> If you rename it to @file{go32.exe} and put on your @code{PATH}

PATH is an environment variable, so @env is better than @code.

> If you define the environment variable @env{GO32_V2_DEBUG}, @code{go32-v2}

I'd suggest a @vindex entry for every environment variable we mention 
here.

> @chapter stubify
> 
> Usage: @code{stubify} [@code{-v}] [@code{-g}] @file{files}

The usage should either be in a @smallexample or have the @kbd markup.

> extension.  The resulting file will have @code{.exe} extension.

I think .exe should be in @file.

> @node stubedit, exe2coff, stubify, Top
> @chapter stubedit

I think this chapter should have @cindex entries for stack size 
modification and other user-meaningful changes that stubedit can do.