From cc5c274102f86b028c67b4e2adbd95fbb214a87b Mon Sep 17 00:00:00 2001 From: Brooks Moses Date: Mon, 16 Oct 2006 19:51:55 +0000 Subject: [PATCH] sourcebuild.texi, [...]: Added mention of "make pdf" target, and Texinfo requirements for same. * doc/sourcebuild.texi, doc/makefile.texi, doc/install.texi: Added mention of "make pdf" target, and Texinfo requirements for same. From-SVN: r117792 --- gcc/ChangeLog | 6 ++++++ gcc/doc/install.texi | 14 +++++++++++--- gcc/doc/makefile.texi | 3 +++ gcc/doc/sourcebuild.texi | 21 ++++++++++++++------- 4 files changed, 34 insertions(+), 10 deletions(-) diff --git a/gcc/ChangeLog b/gcc/ChangeLog index 0a6dcdad38c..a03556d5e1b 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,9 @@ +2006-10-16 Brooks Moses + + * doc/sourcebuild.texi, doc/makefile.texi, doc/install.texi: + Added mention of "make pdf" target, and Texinfo requirements for + same. + 2006-10-16 DJ Delorie * config/s390/s390.c (s390_decompose_address): Allow symbol+offset diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi index e76de1f421c..3ed5bf4100f 100644 --- a/gcc/doc/install.texi +++ b/gcc/doc/install.texi @@ -390,14 +390,19 @@ releases. Necessary for running @command{makeinfo} when modifying @file{*.texi} files to test your changes. +Necessary for running @command{make dvi} or @command{make pdf} to +create printable documentation in DVI or PDF format. Texinfo version +4.8 or later is required for @command{make pdf}. + Necessary to build GCC documentation during development because the generated output files are not included in the SVN repository. They are included in releases. @item @TeX{} (any working version) -Necessary for running @command{texi2dvi}, used when running -@command{make dvi} to create DVI files. +Necessary for running @command{texi2dvi} and @command{texi2pdf}, which +are used when running @command{make dvi} or @command{make pdf} to create +DVI or PDF files, respectively. @item SVN (any version) @itemx SSH (any version) @@ -2166,7 +2171,10 @@ If you want to print the GCC manuals, do @samp{cd @var{objdir}; make dvi}. You will need to have @command{texi2dvi} (version at least 4.4) and @TeX{} installed. This creates a number of @file{.dvi} files in subdirectories of @file{@var{objdir}}; these may be converted for -printing with programs such as @command{dvips}. You can also +printing with programs such as @command{dvips}. Alternately, by using +@samp{make pdf} in place of @samp{make dvi}, you can create documentation +in the form of @file{.pdf} files; this requires @command{texi2pdf}, which +is included with Texinfo version 4.8 and later. You can also @uref{http://www.gnu.org/order/order.html,,buy printed manuals from the Free Software Foundation}, though such manuals may not be for the most recent version of GCC@. diff --git a/gcc/doc/makefile.texi b/gcc/doc/makefile.texi index 8dcf4969ae0..f4513b79d7a 100644 --- a/gcc/doc/makefile.texi +++ b/gcc/doc/makefile.texi @@ -21,6 +21,9 @@ calls @samp{make man} and @samp{make info}. @item dvi Produce DVI-formatted documentation. +@item pdf +Produce PDF-formatted documentation. + @item html Produce HTML-formatted documentation. diff --git a/gcc/doc/sourcebuild.texi b/gcc/doc/sourcebuild.texi index d7f18c5c154..16455208c64 100644 --- a/gcc/doc/sourcebuild.texi +++ b/gcc/doc/sourcebuild.texi @@ -305,9 +305,9 @@ needs fixing, @file{syslimits.h} is the fixed copy. @subsection Building Documentation The main GCC documentation is in the form of manuals in Texinfo -format. These are installed in Info format, and DVI versions may be -generated by @samp{make dvi} and HTML versions may be generated by -@command{make html}. In addition, some man pages are +format. These are installed in Info format; DVI versions may be +generated by @samp{make dvi}, PDF versions by @samp{make pdf}, and +HTML versions by @command{make html}. In addition, some man pages are generated from the Texinfo manuals, there are some other text files with miscellaneous documentation, and runtime libraries have their own documentation outside the @file{gcc} directory. FIXME: document the @@ -341,8 +341,10 @@ The GNU General Public License. A copy of @file{texinfo.tex} known to work with the GCC manuals. @end table -DVI formatted manuals are generated by @samp{make dvi}, which uses -@command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}). HTML +DVI-formatted manuals are generated by @samp{make dvi}, which uses +@command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}). +PDF-formatted manuals are generated by @samp{make pdf}, which uses +@command{texi2pdf} (via the Makefile macro @code{$(TEXI2PDF)}). HTML formatted manuals are generated by @command{make html}. Info manuals are generated by @samp{make info} (which is run as part of a bootstrap); this generates the manuals in the source directory, @@ -360,8 +362,9 @@ not themselves the root files of manuals, may have names that appear 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 -@samp{makeinfo --html} and PostScript manuals by @command{texi2dvi} -and @command{dvips}. All Texinfo files that are parts of manuals must +@samp{makeinfo --html}, PostScript manuals by @command{texi2dvi} +and @command{dvips}, and PDF manuals by @command{texi2pdf}. +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. @@ -588,6 +591,10 @@ for this, and should fail if an error occurs. Build DVI documentation for the front end, in the build directory. This should be done using @code{$(TEXI2DVI)}, with appropriate @option{-I} arguments pointing to directories of included files. +@item pdf +Build PDF documentation for the front end, in the build directory. +This should be done using @code{$(TEXI2PDF)}, with appropriate +@option{-I} arguments pointing to directories of included files. @item html Build HTML documentation for the front end, in the build directory. @item man -- 2.11.4.GIT