Re: [PATCH] fix hyphenation and matters of style in docs

[Bob Wilson <bwilson at tensilica dot com>]

On Apr 10, 2007, at 12:21 PM, Eli Zaretskii wrote:
> Either I didn't see or somehow managed to delete it inadvertently,
> since I don't have it in my INBOX.  Sorry for that.

No problem.

> Reviewing it now, I agree with the suggested changes, but have a few
> questions/requests:
>
>  . Please replace "@code{configure}" with "@file{configure}" or
>    "@command{configure}".

OK.  There were quite a few other  instances of this, so I went ahead  
and changed them all to @file{configure}.

>  . I don't understand this change:
>
>     -@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}
>
>    Maybe you wanted to say "call-specific attachment"? if so, I agree.

Hmm.  I think you're right -- I must have intended to add the hyphen,  
and regardless, that seems like the right thing to do.

>  . Since this patch was posted, the section names were rewritten to
>    use a consistent capitalization, but this one doesn't:
>
>     +@subsection Protocol-specific representation of datatypes

Right.

> With these gotchas taken care of, Bob, please commit the patch, and
> thanks.

OK, thanks.  I've committed the revised patch attached below.

> And thanks to Daniel for the heads-up.

Yes, thanks, Daniel!

gdb/doc/
        * 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.
        (Installing GDB, Requirements, Running Configure,  Separate  
Objdir)
        (Config Names, Configure Options): Use @file{configure}.

Attachment: gdb-doc-style.patch
Description: Binary data