Skip to content

R
riscv-gcc-1
Commit 7ba4ca63 by Matt Kraai Committed by Matt Kraai
Options

install.texi: Use @command and @samp for single- and multi-word commands respectively. 

	* doc/install.texi: Use @command and @samp for single- and
	multi-word commands respectively.
	* doc/makefile.texi: Likewise.
	* doc/sourcebuild.texi: Likewise.

From-SVN: r65364
parent f8d4be57
Showing with 30 additions and 23 deletions
gcc/ChangeLog
2003-04-07 Matt Kraai <kraai@alumni.cmu.edu>
* doc/install.texi: Use @command and @samp for single- and
multi-word commands respectively.
* doc/makefile.texi: Likewise.
* doc/sourcebuild.texi: Likewise.
2003-04-07 Christian Ehrhardt <ehrhardt@mathematik.uni-ulm.de> 2003-04-07 Christian Ehrhardt <ehrhardt@mathematik.uni-ulm.de>
Richard Henderson <rth@redhat.com> Richard Henderson <rth@redhat.com>
......
gcc/doc/install.texi
...@@ -281,7 +281,7 @@ file system, the shell's built-in @command{pwd} command will return ...@@ -281,7 +281,7 @@ file system, the shell's built-in @command{pwd} command will return
temporary pathnames. Using these can lead to various sorts of build temporary pathnames. Using these can lead to various sorts of build
problems. To avoid this issue, set the @env{PWDCMD} environment problems. To avoid this issue, set the @env{PWDCMD} environment
variable to an automounter-aware @command{pwd} command, e.g., variable to an automounter-aware @command{pwd} command, e.g.,
@command{pawd} or @command{amq -w}, during the configuration and build @command{pawd} or @samp{amq -w}, during the configuration and build
phases. phases.
First, we @strong{highly} recommend that GCC be built into a First, we @strong{highly} recommend that GCC be built into a
...@@ -346,7 +346,7 @@ implies that the host defaults to @var{target}. ...@@ -346,7 +346,7 @@ implies that the host defaults to @var{target}.
@heading Options specification @heading Options specification
Use @var{options} to override several configure time options for Use @var{options} to override several configure time options for
GCC@. A list of supported @var{options} follows; @command{configure GCC@. A list of supported @var{options} follows; @samp{configure
--help} may list other options, but those not listed below may not --help} may list other options, but those not listed below may not
work and should not normally be used. work and should not normally be used.
...@@ -976,7 +976,7 @@ Other broken versions may recompile parts of the compiler when ...@@ -976,7 +976,7 @@ Other broken versions may recompile parts of the compiler when
installing the compiler.) installing the compiler.)
Some commands executed when making the compiler may fail (return a Some commands executed when making the compiler may fail (return a
nonzero status) and be ignored by @code{make}. These failures, which nonzero status) and be ignored by @command{make}. These failures, which
are often due to files that were not found, are expected, and can safely are often due to files that were not found, are expected, and can safely
be ignored. be ignored.
...@@ -1839,7 +1839,7 @@ target in an integral value on the host cannot be performed. Building ...@@ -1839,7 +1839,7 @@ target in an integral value on the host cannot be performed. Building
cross-compilers on the Alpha for 32-bit machines has only been tested in cross-compilers on the Alpha for 32-bit machines has only been tested in
a few cases and may not work properly. a few cases and may not work properly.
@code{make compare} may fail on old versions of DEC Unix unless you add @samp{make compare} may fail on old versions of DEC Unix unless you add
@option{-save-temps} to @code{CFLAGS}. On these systems, the name of the @option{-save-temps} to @code{CFLAGS}. On these systems, the name of the
assembler input file is stored in the object file, and that makes assembler input file is stored in the object file, and that makes
comparison fail if it differs between the @code{stage1} and comparison fail if it differs between the @code{stage1} and
...@@ -2630,7 +2630,7 @@ bootstrap. Binaries are available from the OSU-CIS archive, at ...@@ -2630,7 +2630,7 @@ bootstrap. Binaries are available from the OSU-CIS archive, at
@heading @anchor{m68k-crds-unos}m68k-crds-unos @heading @anchor{m68k-crds-unos}m68k-crds-unos
Use @samp{configure unos} for building on Unos. Use @samp{configure unos} for building on Unos.
The Unos assembler is named @code{casm} instead of @code{as}. For some The Unos assembler is named @command{casm} instead of @command{as}. For some
strange reason linking @file{/bin/as} to @file{/bin/casm} changes the strange reason linking @file{/bin/as} to @file{/bin/casm} changes the
behavior, and does not work. So, when installing GCC, you should behavior, and does not work. So, when installing GCC, you should
install the following script as @file{as} in the subdirectory where install the following script as @file{as} in the subdirectory where
...@@ -2704,9 +2704,9 @@ kept up to date. gdb does not understand that native HP-UX format, so ...@@ -2704,9 +2704,9 @@ kept up to date. gdb does not understand that native HP-UX format, so
you must use gas if you wish to use gdb. you must use gas if you wish to use gdb.
On HP-UX version 8.05, but not on 8.07 or more recent versions, the On HP-UX version 8.05, but not on 8.07 or more recent versions, the
@code{fixproto} shell script triggers a bug in the system shell. If you @command{fixproto} shell script triggers a bug in the system shell. If you
encounter this problem, upgrade your operating system or use BASH (the encounter this problem, upgrade your operating system or use BASH (the
GNU shell) to run @code{fixproto}. This bug will cause the fixproto GNU shell) to run @command{fixproto}. This bug will cause the fixproto
program to report an error of the form: program to report an error of the form:
@example @example
...@@ -2776,7 +2776,7 @@ subsystem must be installed from the IDO CD-ROM supplied by Silicon ...@@ -2776,7 +2776,7 @@ subsystem must be installed from the IDO CD-ROM supplied by Silicon
Graphics. It is also available for download from Graphics. It is also available for download from
@uref{http://www.sgi.com/developers/devtools/apis/ido.html,,http://www.sgi.com/developers/devtools/apis/ido.html}. @uref{http://www.sgi.com/developers/devtools/apis/ido.html,,http://www.sgi.com/developers/devtools/apis/ido.html}.
@code{make compare} may fail on version 5 of IRIX unless you add @samp{make compare} may fail on version 5 of IRIX unless you add
@option{-save-temps} to @code{CFLAGS}. On these systems, the name of the @option{-save-temps} to @code{CFLAGS}. On these systems, the name of the
assembler input file is stored in the object file, and that makes assembler input file is stored in the object file, and that makes
comparison fail if it differs between the @code{stage1} and comparison fail if it differs between the @code{stage1} and
...@@ -3245,14 +3245,14 @@ On System V, if you get an error like this, ...@@ -3245,14 +3245,14 @@ On System V, if you get an error like this,
that too indicates a problem with disk space, ulimit, or @code{MAXUMEM}. that too indicates a problem with disk space, ulimit, or @code{MAXUMEM}.
On a System V release 4 system, make sure @file{/usr/bin} precedes On a System V release 4 system, make sure @file{/usr/bin} precedes
@file{/usr/ucb} in @code{PATH}. The @code{cc} command in @file{/usr/ucb} in @code{PATH}. The @command{cc} command in
@file{/usr/ucb} uses libraries which have bugs. @file{/usr/ucb} uses libraries which have bugs.
@html @html
<hr /> <hr />
@end html @end html
@heading @anchor{vax-dec-ultrix}vax-dec-ultrix @heading @anchor{vax-dec-ultrix}vax-dec-ultrix
Don't try compiling with VAX C (@code{vcc}). It produces incorrect code Don't try compiling with VAX C (@command{vcc}). It produces incorrect code
in some cases (for example, when @code{alloca} is used). in some cases (for example, when @code{alloca} is used).
@html @html
......
gcc/doc/makefile.texi
...@@ -13,18 +13,18 @@ This is the default target. Depending on what your build/host/target ...@@ -13,18 +13,18 @@ This is the default target. Depending on what your build/host/target
configuration is, it coordinates all the things that need to be built. configuration is, it coordinates all the things that need to be built.
@item doc @item doc
Produce info-formatted documentation. Also, @code{make dvi} is Produce info-formatted documentation. Also, @samp{make dvi} is
available for DVI-formatted documentation, and @code{make available for DVI-formatted documentation, and @samp{make
generated-manpages} to generate man pages. generated-manpages} to generate man pages.
@item mostlyclean @item mostlyclean
Delete the files made while building the compiler. Delete the files made while building the compiler.
@item clean @item clean
That, and all the other files built by @code{make all}. That, and all the other files built by @samp{make all}.
@item distclean @item distclean
That, and all the files created by @code{configure}. That, and all the files created by @command{configure}.
@item extraclean @item extraclean
That, and any temporary or intermediate files, like emacs backup files. That, and any temporary or intermediate files, like emacs backup files.
...@@ -43,7 +43,7 @@ Deletes installed files. ...@@ -43,7 +43,7 @@ Deletes installed files.
@item check @item check
Run the testsuite. This creates a @file{testsuite} subdirectory that Run the testsuite. This creates a @file{testsuite} subdirectory that
has various @file{.sum} and @file{.log} files containing the results of has various @file{.sum} and @file{.log} files containing the results of
the testing. You can run subsets with, for example, @code{make check-gcc}. the testing. You can run subsets with, for example, @samp{make check-gcc}.
You can specify specific tests by setting RUNTESTFLAGS to be the name You can specify specific tests by setting RUNTESTFLAGS to be the name
of the @file{.exp} file, optionally followed by (for some tests) an equals of the @file{.exp} file, optionally followed by (for some tests) an equals
and a file wildcard, like: and a file wildcard, like:
...@@ -59,7 +59,7 @@ installed, such as TCL or dejagnu. ...@@ -59,7 +59,7 @@ installed, such as TCL or dejagnu.
Builds gcc three times---once with the native compiler, once with the Builds gcc three times---once with the native compiler, once with the
native-built compiler it just built, and once with the compiler it built native-built compiler it just built, and once with the compiler it built
the second time. In theory, the last two should produce the same the second time. In theory, the last two should produce the same
results, which @code{make compare} can check. Each step of this process results, which @samp{make compare} can check. Each step of this process
is called a ``stage'', and the results of each stage @var{N} is called a ``stage'', and the results of each stage @var{N}
(@var{N} = 1@dots{}3) are copied to a subdirectory @file{stage@var{N}/}. (@var{N} = 1@dots{}3) are copied to a subdirectory @file{stage@var{N}/}.
...@@ -81,7 +81,7 @@ special invocation, using this target means you don't have to keep track ...@@ -81,7 +81,7 @@ special invocation, using this target means you don't have to keep track
of which stage you're on or what invocation that stage needs. of which stage you're on or what invocation that stage needs.
@item cleanstrap @item cleanstrap
Removed everything (@code{make clean}) and rebuilds (@code{make bootstrap}). Removed everything (@samp{make clean}) and rebuilds (@samp{make bootstrap}).
@item stage@var{N} (@var{N} = 1@dots{}4) @item stage@var{N} (@var{N} = 1@dots{}4)
For each stage, moves the appropriate files to the @file{stage@var{N}} For each stage, moves the appropriate files to the @file{stage@var{N}}
......
gcc/doc/sourcebuild.texi
...@@ -155,7 +155,7 @@ various languages, @file{@var{language}.po}. This directory also ...@@ -155,7 +155,7 @@ various languages, @file{@var{language}.po}. This directory also
contains @file{gcc.pot}, the template for these message catalogues, contains @file{gcc.pot}, the template for these message catalogues,
@file{exgettext}, a wrapper around @command{gettext} to extract the @file{exgettext}, a wrapper around @command{gettext} to extract the
messages from the GCC sources and create @file{gcc.pot}, which is run messages from the GCC sources and create @file{gcc.pot}, which is run
by @command{make gcc.pot}, and @file{EXCLUDES}, a list of files from by @samp{make gcc.pot}, and @file{EXCLUDES}, a list of files from
which messages should not be extracted. which messages should not be extracted.
@item testsuite @item testsuite
...@@ -278,7 +278,7 @@ needs fixing, @file{syslimits.h} is the fixed copy. ...@@ -278,7 +278,7 @@ needs fixing, @file{syslimits.h} is the fixed copy.
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, and DVI versions may be
generated by @command{make dvi}. In addition, some man pages are generated by @samp{make dvi}. 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
...@@ -312,9 +312,9 @@ The GNU General Public License. ...@@ -312,9 +312,9 @@ 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 @command{make dvi}, which uses DVI formatted manuals are generated by @samp{make dvi}, which uses
@command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}). Info @command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}). Info
manuals are generated by @command{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,
using @command{makeinfo} via the Makefile macro @code{$(MAKEINFO)}, using @command{makeinfo} via the Makefile macro @code{$(MAKEINFO)},
and they are included in release distributions. and they are included in release distributions.
...@@ -330,7 +330,7 @@ not themselves the root files of manuals, may have names that appear ...@@ -330,7 +330,7 @@ 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
@command{makeinfo --html} and PostScript manuals by @command{texi2dvi} @samp{makeinfo --html} and PostScript manuals by @command{texi2dvi}
and @command{dvips}. All Texinfo files that are parts of manuals must and @command{dvips}. 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.
...@@ -544,7 +544,7 @@ Build an @command{etags} @file{TAGS} file in the language subdirectory ...@@ -544,7 +544,7 @@ Build an @command{etags} @file{TAGS} file in the language subdirectory
in the source tree. in the source tree.
@item info @item info
Build info documentation for the front end, in the source directory. Build info documentation for the front end, in the source directory.
This target is only called by @command{make bootstrap} if a suitable This target is only called by @samp{make bootstrap} if a suitable
version of @command{makeinfo} is available, so does not need to check version of @command{makeinfo} is available, so does not need to check
for this, and should fail if an error occurs. for this, and should fail if an error occurs.
@item dvi @item dvi
......
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