HTML docs

Joseph S. Myers jsm28@cam.ac.uk
Fri Apr 11 22:52:00 GMT 2003


On Fri, 11 Apr 2003, Mike Stump wrote:

> > I take it the patch does pass "make html" at toplevel?
> 
> No.  Unrelated errors in the .texi files prevent that for me.  I tried 
> to fix one of the problems, but people didn't want to put in hacks to 
> make it just work, but rather they preferred to simply mandate a newer 
> possibly unwritten version of makeinfo.

When did you report the problems to the Texinfo maintainers?  They've
generally been pretty responsive to problems shown up by GCC manuals, and
new releases are quite frequent.

> + If you would like to generate online html documentation, do @samp{cd

"HTML" in text, not "html".

> + @var{objdir}; make html} and html will be generated for the manuals in

Likewise.

> ! available for DVI-formatted documentation, @code{make htm} for
> ! HTML-formatted documentation and @code{make generated-manpages} to
> ! generate man pages.

"make html", not "make htm".

> ! @command{makeinfo --html} and PostScript manuals by @command{texi2dvi}
> ! and @command{dvips}.  All Texinfo files that are parts of manuals must
> ! be checked into CVS, even if they are generated files, for the
> ! generation of online manuals to work.
>   
>   The installation manual, @file{doc/install.texi}, is also provided on
>   the GCC web site.  The HTML version is generated by the script
> --- 332,341 ----
>   more than once in the source tree.)  The manual file
>   @file{@var{name}.texi} should only include other files in its own
>   directory or in @file{doc/include}.  HTML manuals will be generated by
> ! @command{makeinfo --html} via @command{make html} and PostScript
> ! manuals by @command{texi2dvi} and @command{dvips}.  All Texinfo files
> ! that are parts of manuals must be checked into CVS, even if they are
> ! generated files, for the generation of online manuals to work.

This change is inaccurate; update_web_docs does not use the Makefiles, it
generates the manuals directly having checked out the Texinfo sources and
texinfo.tex only.

> + @item html
> + Build HTML documentation for the front end, in the build directory.

docobjdir is not, by default in the FSF tree, in the build directory.

> + .PHONY: html
> + html: $(docobjdir)/HTML/gcc-$(version)/gcc/index.html $(docobjdir)/HTML/gcc-$(version)/cpp/index.html $(docobjdir)/HTML/gcc-$(version)/gccinstall/index.html $(docobjdir)/HTML/gcc-$(version)/gccint/index.html $(docobjdir)/HTML/gcc-$(version)/cppinternals/index.html lang.html
> + 
> + htmldir = $(docobjdir)/HTML/gcc-$(version)

I think the dependencies above should use $(htmldir).

With these corrections I think the patch is OK by me, but a build system
maintainer will need to review the corrected patch.

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



More information about the Gcc-patches mailing list