This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[PATCH] fix doc formatting
- From: Bob Wilson <bwilson at tensilica dot com>
- To: gdb-patches at sources dot redhat dot com
- Date: Fri, 23 Mar 2007 16:41:49 -0700
- Subject: [PATCH] fix doc formatting
A few changes related to use of texinfo macros....
In the "Help" section, the forced line break causes the Info output to be
garbled and I can't see any reason for it -- the Info, HTML and PDF outputs all
look fine to me without it.
In that same section, some of the sample output lines have been wrapped to fit
in the @smallbook format. The indentation for the wrapped lines is inconsistent
and makes the text hard to read. I changed the indentation to look nice, which
doesn't match the real unwrapped output from GDB but at least is easier to read.
The other changes should be obvious.
2007-03-23 Bob Wilson <bob.wilson@acm.org>
* gdb.texinfo (Help): Fix formatting of examples.
(Variables): Use @ifnotinfo instead of @iftex.
(Non-debug DLL symbols): Use @ref instead of @pxref.
(Sparclet File): Use @samp instead of quotes.
Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.389
diff -u -r1.389 gdb.texinfo
--- gdb.texinfo 26 Feb 2007 20:10:17 -0000 1.389
+++ gdb.texinfo 23 Mar 2007 23:23:51 -0000
@@ -1572,7 +1572,7 @@
stack -- Examining the stack
status -- Status inquiries
support -- Support facilities
-tracepoints -- Tracing of program execution without@*
+tracepoints -- Tracing of program execution without
stopping the program
user-defined -- User-defined commands
@@ -1599,9 +1599,9 @@
@c Line break in "show" line falsifies real output, but needed
@c to fit in smallbook page size.
info -- Generic command for showing things
- about the program being debugged
+ about the program being debugged
show -- Generic command for showing things
- about the debugger
+ about the debugger
Type "help" followed by command name for full
documentation.
@@ -1629,9 +1629,9 @@
@smallexample
@c @group
set symbol-reloading -- Set dynamic symbol table reloading
- multiple times in one run
+ multiple times in one run
show symbol-reloading -- Show dynamic symbol table reloading
- multiple times in one run
+ multiple times in one run
@c @end group
@end smallexample
@@ -5556,10 +5556,10 @@
using the colon-colon (@code{::}) notation:
@cindex colon-colon, context for variables/functions
-@iftex
+@ifnotinfo
@c info cannot cope with a :: index entry, but why deprive hard copy readers?
@cindex @code{::}, context for variables/functions
-@end iftex
+@end ifnotinfo
@smallexample
@var{file}::@var{variable}
@var{function}::@var{variable}
@@ -13804,8 +13804,8 @@
start the program --- either by setting a breakpoint or letting the
program run once to completion. It is also possible to force
@value{GDBN} to load a particular DLL before starting the executable ---
-see the shared library information in @pxref{Files} or the
-@code{dll-symbols} command in @pxref{Cygwin Native}. Currently,
+see the shared library information in @ref{Files}, or the
+@code{dll-symbols} command in @ref{Cygwin Native}. Currently,
explicitly loading symbols from a DLL with no debugging information will
cause the symbol names to be duplicated in @value{GDBN}'s lookup table,
which may adversely affect symbol lookup performance.
@@ -15242,7 +15242,7 @@
@value{GDBN} locates
the file by searching the directories listed in the command search
path.
-If the file was compiled with debug information (option "-g"), source
+If the file was compiled with debug information (option @samp{-g}), source
files will be searched as well.
@value{GDBN} locates
the source files by searching the directories listed in the directory search