From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 21016 invoked by alias); 26 Mar 2007 17:08:49 -0000 Received: (qmail 21003 invoked by uid 22791); 26 Mar 2007 17:08:47 -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; Mon, 26 Mar 2007 18:08:35 +0100 Received: from localhost ([127.0.0.1]) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1HVsgL-00072i-Eu for gdb-patches@sources.redhat.com; Mon, 26 Mar 2007 09:08:33 -0800 Received: from mailapp.tensilica.com ([127.0.0.1]) by localhost (mailapp [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 26588-01 for ; Mon, 26 Mar 2007 09:08:33 -0800 (PST) Received: from heron.hq.tensilica.com ([192.168.11.123]) by mailapp.tensilica.com with esmtp (Exim 4.34) id 1HVsgL-00072c-2d for gdb-patches@sources.redhat.com; Mon, 26 Mar 2007 09:08:33 -0800 Received: from [192.168.11.123] (heron.hq.tensilica.com [192.168.11.123]) by heron.hq.tensilica.com (Postfix) with ESMTP id 11AD6AC66C for ; Mon, 26 Mar 2007 10:08:33 -0700 (PDT) Message-ID: <4607FE10.8000402@tensilica.com> Date: Mon, 26 Mar 2007 17:08: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 hyphenation and matters of style in docs Content-Type: multipart/mixed; boundary="------------060905030402010506080606" 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/msg00233.txt.bz2 This is a multi-part message in MIME format. --------------060905030402010506080606 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Content-length: 1244 I've got a few more doc patches left. This one gets into some things that are a little bit more a matter of style, at least in regard to the best way to fix the problems. I've been trying to make fairly minimal changes here (although I did add some whitespace fixes to this patch after seeing Eli's request for that), but in some cases I wondered whether more substantial changes would be better, e.g., to avoid use of hyphenated adjectives. Personally, I think this patch is fine, so I guess I'm just trying to explain why I split out these changes into a separate patch -- they seemed more likely to generate some comments. 2007-03-26 Bob Wilson * gdb.texinfo (Contributors, Continuing and Stepping) (Fortran Defaults, HPPA, TUI, TUI Commands, Configure Options) (General Query Packets, File-I/O remote protocol extension) (Protocol basics, The F reply packet, write) (Protocol-specific representation of datatypes, Memory transfer): Fix hyphenation, punctuation and grammar problems. (Cygwin Native): Likewise. Also fix misuse of @pxref and use 'section' instead of 'subsection' in the text. (Non-debug DLL symbols): Avoid 'subsubsection' in the text. (i386): Remove period from section name. --------------060905030402010506080606 Content-Type: text/plain; name="gdb-doc-style.patch" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="gdb-doc-style.patch" Content-length: 8943 Index: gdb.texinfo =================================================================== RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v retrieving revision 1.394 diff -u -r1.394 gdb.texinfo --- gdb.texinfo 26 Mar 2007 15:51:17 -0000 1.394 +++ gdb.texinfo 26 Mar 2007 16:46:10 -0000 @@ -491,7 +491,7 @@ frame IDs, independent frame sniffers, and the sentinel frame. Mark Kettenis implemented the @sc{dwarf 2} unwinder, Jeff Johnston the libunwind unwinder, and Andrew Cagney the dummy, sentinel, tramp, and -trad unwinders. The architecture specific changes, each involving a +trad unwinders. The architecture-specific changes, each involving a complete rewrite of the architecture's frame code, were carried out by Jim Blandy, Joel Brobecker, Kevin Buettner, Andrew Cagney, Stephane Carrez, Randolph Chung, Orjan Friberg, Richard Henderson, Daniel @@ -4120,7 +4120,7 @@ implies that @code{until} can be used to skip over recursive function invocations. For instance in the code below, if the current location is line @code{96}, issuing @code{until 99} will execute the program up to -line @code{99} in the same invocation of factorial, i.e. after the inner +line @code{99} in the same invocation of factorial, i.e., after the inner invocations have returned. @smallexample @@ -9651,8 +9651,8 @@ @cindex Special Fortran commands -@value{GDBN} had some commands to support Fortran specific feature, -such as common block displaying. +@value{GDBN} has some commands to support Fortran-specific features, +such as displaying common blocks. @table @code @cindex @code{COMMON} blocks, Fortran @@ -13664,16 +13664,15 @@ @cindex Cygwin-specific commands @value{GDBN} supports native debugging of MS Windows programs, including -DLLs with and without symbolic debugging information. There are various -additional Cygwin-specific commands, described in this subsection. The -subsubsection @pxref{Non-debug DLL symbols} describes working with DLLs -that have no debugging symbols. - +DLLs with and without symbolic debugging information. There are various +additional Cygwin-specific commands, described in this section. +Working with DLLs that have no debugging symbols is described in +@ref{Non-debug DLL symbols}. @table @code @kindex info w32 @item info w32 -This is a prefix of MS Windows specific commands which print +This is a prefix of MS Windows-specific commands which print information about the target system and important OS structures. @item info w32 selector @@ -13686,7 +13685,7 @@ @kindex info dll @item info dll -This is a Cygwin specific alias of info shared. +This is a Cygwin-specific alias of @code{info shared}. @kindex dll-symbols @item dll-symbols @@ -13778,19 +13777,19 @@ Very often on windows, some of the DLLs that your program relies on do not include symbolic debugging information (for example, -@file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging +@file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging symbols in a DLL, it relies on the minimal amount of symbolic -information contained in the DLL's export table. This subsubsection +information contained in the DLL's export table. This section describes working with such symbols, known internally to @value{GDBN} as ``minimal symbols''. Note that before the debugged program has started execution, no DLLs -will have been loaded. The easiest way around this problem is simply to +will have been loaded. The easiest way around this problem is simply to start the program --- either by setting a breakpoint or letting the -program run once to completion. It is also possible to force +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 @ref{Files}, or the -@code{dll-symbols} command in @ref{Cygwin Native}. Currently, +@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. @@ -15540,7 +15539,7 @@ @end menu @node i386 -@subsection x86 Architecture-specific issues. +@subsection x86 Architecture-specific issues @table @code @item set struct-convention @var{mode} @@ -15730,7 +15729,7 @@ @table @code @item set debug hppa @kindex set debug hppa -This command determines whether HPPA architecture specific debugging +This command determines whether HPPA architecture-specific debugging messages are to be displayed. @item show debug hppa @@ -16820,7 +16819,7 @@ * TUI Overview:: TUI overview * TUI Keys:: TUI key bindings * TUI Single Key Mode:: TUI single key mode -* TUI Commands:: TUI specific commands +* TUI Commands:: TUI-specific commands * TUI Configuration:: TUI configuration variables @end menu @@ -17114,7 +17113,7 @@ @node TUI Commands -@section TUI specific commands +@section TUI-specific commands @cindex TUI commands The TUI has specific commands to control the text windows. @@ -22535,7 +22534,7 @@ Use this option to make configurations in directories separate from the @value{GDBN} source directories. Among other things, you can use this to build (or maintain) several configurations simultaneously, in separate -directories. @code{configure} writes configuration specific files in +directories. @code{configure} writes configuration-specific files in the current directory, but arranges for them to use the source in the directory @var{dirname}. @code{configure} creates directories under the working directory in parallel to the source directories below @@ -23781,7 +23780,7 @@ thread local variable. (This offset is obtained from the debug information associated with the variable.) -@var{lm} is the (big endian, hex encoded) OS/ABI specific encoding of the +@var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the the load module associated with the thread local storage. For example, a @sc{gnu}/Linux system will pass the link map address of the shared object associated with the thread local storage under consideration. @@ -24516,7 +24515,7 @@ * The Ctrl-C message:: * Console I/O:: * List of supported calls:: -* Protocol specific representation of datatypes:: +* Protocol-specific representation of datatypes:: * Constants:: * File-I/O Examples:: @end menu @@ -24586,7 +24585,7 @@ All parameters to the system call. Pointers are given as addresses in the target memory address space. Pointers to strings are given as pointer/length pair. Numerical values are given as they are. -Numerical control flags are given in a protocol specific representation. +Numerical control flags are given in a protocol-specific representation. @end itemize @@ -24671,11 +24670,13 @@ @table @samp -@item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call specific attachment} +@item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call specific +attachment} @var{retcode} is the return code of the system call as hexadecimal value. -@var{errno} is the @code{errno} set by the call, in protocol specific representation. +@var{errno} is the @code{errno} set by the call, in protocol-specific +representation. This parameter can be omitted if the call was successful. @var{Ctrl-C flag} is only sent if the user requested a break. In this @@ -24694,7 +24695,7 @@ @end smallexample @noindent -assuming 4 is the protocol specific representation of @code{EINTR}. +assuming 4 is the protocol-specific representation of @code{EINTR}. @end table @@ -25006,7 +25007,7 @@ @item EFBIG An attempt was made to write a file that exceeds the -host specific maximum file size allowed. +host-specific maximum file size allowed. @item ENOSPC No space on device to write the data. @@ -25344,9 +25345,9 @@ protocol. @end table -@node Protocol specific representation of datatypes -@subsection Protocol specific representation of datatypes -@cindex protocol specific representation of datatypes, in file-i/o protocol +@node Protocol-specific representation of datatypes +@subsection Protocol-specific representation of datatypes +@cindex protocol-specific representation of datatypes, in file-i/o protocol @menu * Integral datatypes:: @@ -25406,7 +25407,7 @@ @cindex memory transfer, in file-i/o protocol Structured data which is transferred using a memory read or write (for -example, a @code{struct stat}) is expected to be in a protocol specific format +example, a @code{struct stat}) is expected to be in a protocol-specific format with all scalar multibyte datatypes being big endian. Translation to this representation needs to be done both by the target before the @code{F} packet is sent, and by @value{GDBN} before --------------060905030402010506080606--