Re: Patch: Documenting tools necessary for GCC [take 2]

["Joseph S. Myers" <jsm28 at cam dot ac dot uk>]

On Fri, 6 Jun 2003, Kaveh R. Ghazi wrote:

> This time I've put it in the form of a patch against install.texi.  I
> added a new section called "Prerequisites" before "Downloading", and
> this passes "make info".  My markup is weak so be kind, I simply cut
> and pasted and poked until "make info" stopped complaining. :-)

You also need to update the install.texi2html script (to create the new
file), and test that that works.

> +@item A "working" POSIX compatible shell, or GNU bash

TeX quotes ``working'', here and below.

> +Necessary when running configure because some /bin/sh shells have bugs

@command{configure}, @command{/bin/sh}, here and below (and similar
cases).

> +to be sure.  Then set CONFIG_SHELL in your environment to your "good"

@env{CONFIG_SHELL}.

> +Necessary (only on some platforms) to untar the source code.  Many
> +system tar's will also work, only try GNU tar if you have problems.

Apostrophe isn't appropriate for plural, try "Many systems' @command{tar} 
programs".

> +Necessary when modifying configure.in, aclocal.m4, etc to regenerate

@file{configure.in}, @file{aclocal.m4}, here and below (and similar
cases).

> +Necessary when modifying gperf input files, e.g. gcc/cp/cfns.gperf to
> +regenerate its associated header file, e.g. gcc/cp/cfns.h.

codingconventions.html has a summary of common Texinfo style issues, in
this case that you should be using "e.g.@:".

> +@item expect version ???
> +@item tcl version ???

Multiple consecutive @item should have all but the first @itemx (here and
above and below).

> +Necessary to run the fixinc/ directory "make check".

@file{fixinc}, @command{make check}.

> +Necessary to regenerate the top level Makefile.am's from Makefile.tpl

No apostrophe for plural, @file{Makefile.am}s (and @file adds quotes).

> +Necessary when modifying *.y files.

@file{*.y}.

> +files are not included in the cvs repository.  They are included in

"CVS" (capitals), when used as an adjective like this.

> +@item texinfo version 4.2 (or later)

"Texinfo" (initial capital).

> +@item TeX (any working version)

@TeX{}.

-- 
Joseph S. Myers
jsm28@cam.ac.uk