This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: [doc-patch]
- From: Volker Reichelt <reichelt at igpm dot rwth-aachen dot de>
- To: gcc-patches at gcc dot gnu dot org
- Date: Fri, 24 Jan 2003 18:03:41 +0100
- Subject: Re: [doc-patch]
Applied to 3.3 branch and mainline as below.
That's a corrected version of
http://gcc.gnu.org/ml/gcc-patches/2002-12/msg00733.html
Regards,
Volker
2003-01-24 Volker Reichelt <reichelt@igpm.rwth-aachen.de>
* doc/bugreport.texi: Use @command instead of @code for commands.
* doc/collect2.texi: Likewise.
* doc/headerdirs.texi: Likewise.
* doc/invoke.texi: Likewise.
* doc/standards.texi: Likewise.
* doc/tm.texi: Likewise.
* doc/trouble.texi: Likewise.
Index: doc/bugreport.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/bugreport.texi,v
retrieving revision 1.2
diff -u -p -r1.2 bugreport.texi
--- doc/bugreport.texi 27 Feb 2002 18:47:51 -0000 1.2
+++ doc/bugreport.texi 24 Jan 2003 15:56:33 -0000
@@ -376,9 +376,9 @@ we should be able to reproduce the crash
To simplify creation of bug reports, and to allow better tracking of
reports, we use the GNATS bug tracking system. Part of that system is
-the @code{gccbug} script. This is a Unix shell script, so you need a
+the @command{gccbug} script. This is a Unix shell script, so you need a
shell to run it. It is normally installed in the same directory where
-@code{gcc} is installed.
+@command{gcc} is installed.
The gccbug script is derived from send-pr, @pxref{using
send-pr,,Creating new Problem Reports,send-pr,Reporting Problems}. When
Index: doc/collect2.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/collect2.texi,v
retrieving revision 1.1
diff -u -p -r1.1 collect2.texi
--- doc/collect2.texi 18 Nov 2001 19:46:58 -0000 1.1
+++ doc/collect2.texi 24 Jan 2003 15:56:33 -0000
@@ -52,7 +52,7 @@ if specified.
@end itemize
``The compiler's search directories'' means all the directories where
-@code{gcc} searches for passes of the compiler. This includes
+@command{gcc} searches for passes of the compiler. This includes
directories that you specify with @option{-B}.
Cross-compilers search a little differently:
Index: doc/headerdirs.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/headerdirs.texi,v
retrieving revision 1.1
diff -u -p -r1.1 headerdirs.texi
--- doc/headerdirs.texi 18 Nov 2001 19:46:58 -0000 1.1
+++ doc/headerdirs.texi 24 Jan 2003 15:56:33 -0000
@@ -15,7 +15,7 @@ are already suitable for ISO C and GNU C
done).
@code{GPLUSPLUS_INCLUDE_DIR} means the same thing for native and cross. It
-is where @code{g++} looks first for header files. The C++ library
+is where @command{g++} looks first for header files. The C++ library
installs only target independent header files in that directory.
@code{LOCAL_INCLUDE_DIR} is used only by native compilers. GNU CC
Index: doc/invoke.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/invoke.texi,v
retrieving revision 1.228
diff -u -p -r1.228 invoke.texi
--- doc/invoke.texi 24 Jan 2003 15:45:53 -0000 1.228
+++ doc/invoke.texi 24 Jan 2003 15:56:34 -0000
@@ -3002,19 +3002,19 @@ Compress DWARF2 debugging information by
information about each symbol. This option only makes sense when
generating DWARF2 debugging information with @option{-gdwarf-2}.
-@cindex @code{prof}
+@cindex @command{prof}
@item -p
@opindex p
Generate extra code to write profile information suitable for the
-analysis program @code{prof}. You must use this option when compiling
+analysis program @command{prof}. You must use this option when compiling
the source files you want data about, and you must also use it when
linking.
-@cindex @code{gprof}
+@cindex @command{gprof}
@item -pg
@opindex pg
Generate extra code to write profile information suitable for the
-analysis program @code{gprof}. You must use this option when compiling
+analysis program @command{gprof}. You must use this option when compiling
the source files you want data about, and you must also use it when
linking.
@@ -3054,7 +3054,7 @@ optimization and code generation options
@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
Control Optimization}).
-The other use of @option{-fprofile-arcs} is for use with @code{gcov},
+The other use of @option{-fprofile-arcs} is for use with @command{gcov},
when it is used with the @option{-ftest-coverage} option.
With @option{-fprofile-arcs}, for each function of your program GCC
@@ -3074,11 +3074,11 @@ Create data files for the @command{gcov}
@table @gcctabopt
@item @var{auxname}.bb
-A mapping from basic blocks to line numbers, which @code{gcov} uses to
+A mapping from basic blocks to line numbers, which @command{gcov} uses to
associate basic block execution counts with line numbers.
@item @var{auxname}.bbg
-A list of all arcs in the program flow graph. This allows @code{gcov}
+A list of all arcs in the program flow graph. This allows @command{gcov}
to reconstruct the program flow graph, so that it can compute all basic
block and arc execution counts from the information in the
@file{@var{auxname}.da} file.
@@ -3967,7 +3967,7 @@ as well as AIX may have these optimizati
Only use these options when there are significant benefits from doing
so. When you specify these options, the assembler and linker will
create larger object and executable files and will also be slower.
-You will not be able to use @code{gprof} on all systems if you
+You will not be able to use @command{gprof} on all systems if you
specify this option and you may have problems with debugging if
you specify both this option and @option{-g}.
@@ -11174,16 +11174,16 @@ prototype information about standard sys
applies only to @code{protoize}.
@item -c @var{compilation-options}
-Use @var{compilation-options} as the options when running @code{gcc} to
+Use @var{compilation-options} as the options when running @command{gcc} to
produce the @samp{.X} files. The special option @option{-aux-info} is
-always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
+always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
Note that the compilation options must be given as a single argument to
@code{protoize} or @code{unprotoize}. If you want to specify several
-@code{gcc} options, you must quote the entire set of compilation options
+@command{gcc} options, you must quote the entire set of compilation options
to make them a single word in the shell.
-There are certain @code{gcc} arguments that you cannot use, because they
+There are certain @command{gcc} arguments that you cannot use, because they
would produce the wrong kind of output. These include @option{-g},
@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
the @var{compilation-options}, they are ignored.
@@ -11236,12 +11236,12 @@ Use the program @var{program} as the com
Work quietly. Most warnings are suppressed.
@item -v
-Print the version number, just like @option{-v} for @code{gcc}.
+Print the version number, just like @option{-v} for @command{gcc}.
@end table
If you need special compiler options to compile one of your program's
source files, then you should generate that file's @samp{.X} file
-specially, by running @code{gcc} on that source file with the
+specially, by running @command{gcc} on that source file with the
appropriate options and the option @option{-aux-info}. Then run
@code{protoize} on the entire set of files. @code{protoize} will use
the existing @samp{.X} file because it is newer than the source file.
Index: doc/standards.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/standards.texi,v
retrieving revision 1.9
diff -u -p -r1.9 standards.texi
--- doc/standards.texi 4 Sep 2002 17:35:59 -0000 1.9
+++ doc/standards.texi 24 Jan 2003 15:56:34 -0000
@@ -189,4 +189,4 @@ conformance and compatibility of the Ada
Fortran}, for details of the Fortran language supported by GCC@.
@xref{Compatibility,,Compatibility with the Java Platform, gcj, GNU gcj},
-for details of compatibility between @code{gcj} and the Java Platform.
+for details of compatibility between @command{gcj} and the Java Platform.
Index: doc/tm.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/tm.texi,v
retrieving revision 1.191
diff -u -p -r1.191 tm.texi
--- doc/tm.texi 19 Jan 2003 13:04:23 -0000 1.191
+++ doc/tm.texi 24 Jan 2003 15:56:36 -0000
@@ -404,7 +404,7 @@ the target makefile fragment or if none
@findex RELATIVE_PREFIX_NOT_LINKDIR
@item RELATIVE_PREFIX_NOT_LINKDIR
-Define this macro to tell @code{gcc} that it should only translate
+Define this macro to tell @command{gcc} that it should only translate
a @option{-B} prefix into a @option{-L} linker option if the prefix
indicates an absolute file name.
@@ -7038,7 +7038,7 @@ When arbitrary sections are available, t
upon how the code in @file{crtstuff.c} is called. On systems that
support a @dfn{.init} section which is executed at program startup,
parts of @file{crtstuff.c} are compiled into that section. The
-program is linked by the @code{gcc} driver like this:
+program is linked by the @command{gcc} driver like this:
@example
ld -o @var{output_file} crti.o crtbegin.o @dots{} -lgcc crtend.o crtn.o
Index: doc/trouble.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/trouble.texi,v
retrieving revision 1.13
diff -u -p -r1.13 trouble.texi
--- doc/trouble.texi 23 Dec 2002 23:02:49 -0000 1.13
+++ doc/trouble.texi 24 Jan 2003 15:56:36 -0000
@@ -886,9 +886,9 @@ int Foo::bar = 0;
@end example
Other C++ compilers may not correctly implement the standard behavior.
-As a result, when you switch to @code{g++} from one of these compilers,
+As a result, when you switch to @command{g++} from one of these compilers,
you may discover that a program that appeared to work correctly in fact
-does not conform to the standard: @code{g++} reports as undefined
+does not conform to the standard: @command{g++} reports as undefined
symbols any static data members that lack definitions.
@node Temporaries
===================================================================