Commit cc5c2741 by Brooks Moses Committed by Brooks Moses

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
parent 0c6385dc
2006-10-16 Brooks Moses <bmoses@stanford.edu>
* 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 <dj@redhat.com> 2006-10-16 DJ Delorie <dj@redhat.com>
* config/s390/s390.c (s390_decompose_address): Allow symbol+offset * config/s390/s390.c (s390_decompose_address): Allow symbol+offset
......
...@@ -390,14 +390,19 @@ releases. ...@@ -390,14 +390,19 @@ releases.
Necessary for running @command{makeinfo} when modifying @file{*.texi} Necessary for running @command{makeinfo} when modifying @file{*.texi}
files to test your changes. 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 Necessary to build GCC documentation during development because the
generated output files are not included in the SVN repository. They are generated output files are not included in the SVN repository. They are
included in releases. included in releases.
@item @TeX{} (any working version) @item @TeX{} (any working version)
Necessary for running @command{texi2dvi}, used when running Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
@command{make dvi} to create DVI files. are used when running @command{make dvi} or @command{make pdf} to create
DVI or PDF files, respectively.
@item SVN (any version) @item SVN (any version)
@itemx SSH (any version) @itemx SSH (any version)
...@@ -2166,7 +2171,10 @@ If you want to print the GCC manuals, do @samp{cd @var{objdir}; make ...@@ -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) 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 and @TeX{} installed. This creates a number of @file{.dvi} files in
subdirectories of @file{@var{objdir}}; these may be converted for 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 @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 Free Software Foundation}, though such manuals may not be for the most
recent version of GCC@. recent version of GCC@.
......
...@@ -21,6 +21,9 @@ calls @samp{make man} and @samp{make info}. ...@@ -21,6 +21,9 @@ calls @samp{make man} and @samp{make info}.
@item dvi @item dvi
Produce DVI-formatted documentation. Produce DVI-formatted documentation.
@item pdf
Produce PDF-formatted documentation.
@item html @item html
Produce HTML-formatted documentation. Produce HTML-formatted documentation.
......
...@@ -305,9 +305,9 @@ needs fixing, @file{syslimits.h} is the fixed copy. ...@@ -305,9 +305,9 @@ needs fixing, @file{syslimits.h} is the fixed copy.
@subsection Building Documentation @subsection Building Documentation
The main GCC documentation is in the form of manuals in Texinfo The main GCC documentation is in the form of manuals in Texinfo
format. These are installed in Info format, and DVI versions may be format. These are installed in Info format; DVI versions may be
generated by @samp{make dvi} and HTML versions may be generated by generated by @samp{make dvi}, PDF versions by @samp{make pdf}, and
@command{make html}. In addition, some man pages are HTML versions by @command{make html}. In addition, some man pages are
generated from the Texinfo manuals, there are some other text files generated from the Texinfo manuals, there are some other text files
with miscellaneous documentation, and runtime libraries have their own with miscellaneous documentation, and runtime libraries have their own
documentation outside the @file{gcc} directory. FIXME: document the documentation outside the @file{gcc} directory. FIXME: document the
...@@ -341,8 +341,10 @@ The GNU General Public License. ...@@ -341,8 +341,10 @@ The GNU General Public License.
A copy of @file{texinfo.tex} known to work with the GCC manuals. A copy of @file{texinfo.tex} known to work with the GCC manuals.
@end table @end table
DVI formatted manuals are generated by @samp{make dvi}, which uses DVI-formatted manuals are generated by @samp{make dvi}, which uses
@command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}). HTML @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 formatted manuals are generated by @command{make html}. Info
manuals are generated by @samp{make info} (which is run as part of manuals are generated by @samp{make info} (which is run as part of
a bootstrap); this generates the manuals in the source directory, 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 ...@@ -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 more than once in the source tree.) The manual file
@file{@var{name}.texi} should only include other files in its own @file{@var{name}.texi} should only include other files in its own
directory or in @file{doc/include}. HTML manuals will be generated by directory or in @file{doc/include}. HTML manuals will be generated by
@samp{makeinfo --html} and PostScript manuals by @command{texi2dvi} @samp{makeinfo --html}, PostScript manuals by @command{texi2dvi}
and @command{dvips}. All Texinfo files that are parts of manuals must 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 be checked into CVS, even if they are generated files, for the
generation of online manuals to work. generation of online manuals to work.
...@@ -588,6 +591,10 @@ for this, and should fail if an error occurs. ...@@ -588,6 +591,10 @@ for this, and should fail if an error occurs.
Build DVI documentation for the front end, in the build directory. Build DVI documentation for the front end, in the build directory.
This should be done using @code{$(TEXI2DVI)}, with appropriate This should be done using @code{$(TEXI2DVI)}, with appropriate
@option{-I} arguments pointing to directories of included files. @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 @item html
Build HTML documentation for the front end, in the build directory. Build HTML documentation for the front end, in the build directory.
@item man @item man
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment