From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 24005 invoked by alias); 23 Mar 2007 23:41:56 -0000 Received: (qmail 23995 invoked by uid 22791); 23 Mar 2007 23:41:55 -0000 X-Spam-Check-By: sourceware.org Received: from hq.tensilica.com (HELO mailapp.tensilica.com) (65.205.227.29) by sourceware.org (qpsmtpd/0.31) with ESMTP; Fri, 23 Mar 2007 23:41:52 +0000 Received: from localhost ([127.0.0.1]) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1HUtOI-0000pD-Q8 for gdb-patches@sources.redhat.com; Fri, 23 Mar 2007 15:41:50 -0800 Received: from mailapp.tensilica.com ([127.0.0.1]) by localhost (mailapp [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 02946-02 for ; Fri, 23 Mar 2007 15:41:50 -0800 (PST) Received: from heron.hq.tensilica.com ([192.168.11.123]) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1HUtOI-0000p7-AR for gdb-patches@sources.redhat.com; Fri, 23 Mar 2007 15:41:50 -0800 Received: from [192.168.11.123] (heron.hq.tensilica.com [192.168.11.123]) by heron.hq.tensilica.com (Postfix) with ESMTP id 2D7B5AC66E for ; Fri, 23 Mar 2007 16:41:50 -0700 (PDT) Message-ID: <460465BD.100@tensilica.com> Date: Fri, 23 Mar 2007 23:41:00 -0000 From: Bob Wilson User-Agent: Thunderbird 1.5.0.10 (X11/20070306) MIME-Version: 1.0 To: gdb-patches@sources.redhat.com Subject: [PATCH] fix doc formatting Content-Type: multipart/mixed; boundary="------------050906060305050205020304" Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2007-03/txt/msg00214.txt.bz2 This is a multi-part message in MIME format. --------------050906060305050205020304 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Content-length: 849 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 * 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. --------------050906060305050205020304 Content-Type: text/plain; name="gdb-doc-formatting.patch" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="gdb-doc-formatting.patch" Content-length: 2861 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 --------------050906060305050205020304--