Next:Man Page Generation, Up:Building Documentation [Contents][Index]
The manuals for GCC as a whole, and the C and C++ front ends, are infilesdoc/*.texi. Other front ends have their own manuals infileslanguage/*.texi. Common filesdoc/include/*.texi are provided which may be included inmultiple manuals; the following files are indoc/include:
The GNU Free Documentation License.
The section “Funding Free Software”.
Common definitions for manuals.
The GNU General Public License.
A copy oftexinfo.tex known to work with the GCC manuals.
DVI-formatted manuals are generated by ‘make dvi’, which usestexi2dvi (via the Makefile macro$(TEXI2DVI)).PDF-formatted manuals are generated by ‘make pdf’, which usestexi2pdf (via the Makefile macro$(TEXI2PDF)). HTMLformatted manuals are generated by ‘make html’. Infomanuals are generated by ‘make info’ (which is run as part ofa bootstrap); this generates the manuals in the source directory,usingmakeinfo via the Makefile macro$(MAKEINFO),and they are included in release distributions.
Manuals are also provided on the GCC web site, in both HTML andPostScript forms. This is done via the scriptmaintainer-scripts/update_web_docs_git. Each manual to beprovided online must be listed in the definition ofMANUALS inthat file; a filename.texi must only appear once in thesource tree, and the output manual must have the same name as thesource file. (However, other Texinfo files, included in manuals butnot themselves the root files of manuals, may have names that appearmore than once in the source tree.) The manual filename.texi should only include other files in its owndirectory or indoc/include. HTML manuals will be generated by‘makeinfo --html’, PostScript manuals bytexi2dvianddvips, and PDF manuals bytexi2pdf.All Texinfo files that are parts of manuals mustbe version-controlled, even if they are generated files, for thegeneration of online manuals to work.
The installation manual,doc/install.texi, is also provided onthe GCC web site. The HTML version is generated by the scriptdoc/install.texi2html.
Next:Man Page Generation, Up:Building Documentation [Contents][Index]