[PATCH] wrap long lines in doc

[PATCH] wrap long lines in doc

[Bob Wilson]

[-- Attachment #1: Type: text/plain, Size: 236 bytes --]

Surely this must qualify as obvious, but I'll hold off committing it since I 
promised to be cautious about that.

2007-03-26  Bob Wilson  <bob.wilson@acm.org>
	
	* gdb.texinfo (Omissions from Ada, Additions to Ada): Wrap long lines.
	

[-- Attachment #2: gdb-doc-wrap.patch --]
[-- Type: text/plain, Size: 3778 bytes --]

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 17:12:22 -0000
@@ -10462,10 +10462,11 @@
 
 @item
 The overloading algorithm is much more limited (i.e., less selective)
-than that of real Ada.  It makes only limited use of the context in which a subexpression
-appears to resolve its meaning, and it is much looser in its rules for allowing
-type matches.  As a result, some function calls will be ambiguous, and the user
-will be asked to choose the proper resolution.
+than that of real Ada.  It makes only limited use of the context in
+which a subexpression appears to resolve its meaning, and it is much
+looser in its rules for allowing type matches.  As a result, some
+function calls will be ambiguous, and the user will be asked to choose
+the proper resolution.
 
 @item
 The @code{new} operator is not implemented.
@@ -10490,19 +10491,19 @@
 
 @itemize @bullet
 @item
-If the expression @var{E} is a variable residing in memory 
-(typically a local variable or array element) and @var{N} is 
-a positive integer, then @code{@var{E}@@@var{N}} displays the values of
-@var{E} and the @var{N}-1 adjacent variables following it in memory as an array.  
-In Ada, this operator is generally not necessary, since its prime use
-is in displaying parts of an array, and slicing will usually do this in Ada.
-However, there are occasional uses when debugging programs
-in which certain debugging information has been optimized away.
+If the expression @var{E} is a variable residing in memory (typically
+a local variable or array element) and @var{N} is a positive integer,
+then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
+@var{N}-1 adjacent variables following it in memory as an array.  In
+Ada, this operator is generally not necessary, since its prime use is
+in displaying parts of an array, and slicing will usually do this in
+Ada.  However, there are occasional uses when debugging programs in
+which certain debugging information has been optimized away.
 
 @item
-@code{@var{B}::@var{var}} means ``the variable named @var{var} that appears
-in function or file @var{B}.''  When @var{B} is a file name, you must typically
-surround it in single quotes.
+@code{@var{B}::@var{var}} means ``the variable named @var{var} that
+appears in function or file @var{B}.''  When @var{B} is a file name,
+you must typically surround it in single quotes.
 
 @item 
 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
@@ -10513,8 +10514,8 @@
 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
 @end itemize
 
-In addition, @value{GDBN} provides a few other shortcuts and outright additions specific 
-to Ada:
+In addition, @value{GDBN} provides a few other shortcuts and outright
+additions specific to Ada:
 
 @itemize @bullet
 @item 
@@ -10549,8 +10550,8 @@
    "One line.["0a"]Next line.["0a"]"
 @end smallexample
 @noindent
-contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF}) after each
-period.
+contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
+after each period.
 
 @item
 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
@@ -10564,7 +10565,8 @@
 @item
 When printing arrays, @value{GDBN} uses positional notation when the 
 array has a lower bound of 1, and uses a modified named notation otherwise.
-For example, a one-dimensional array of three integers with a lower bound of 3 might print as
+For example, a one-dimensional array of three integers with a lower bound
+of 3 might print as
 
 @smallexample
 (3 => 10, 17, 1)

Re: [PATCH] wrap long lines in doc

[Eli Zaretskii]

> Date: Mon, 26 Mar 2007 10:20:21 -0700
> From: Bob Wilson <bwilson@tensilica.com>
> 
> Surely this must qualify as obvious

Yes; but it's also unneeded.

> 2007-03-26  Bob Wilson  <bob.wilson@acm.org>
> 	
> 	* gdb.texinfo (Omissions from Ada, Additions to Ada): Wrap long lines.

If all you did was type "M-q" in Emacs on each of these paragraphs,
please go ahead and commit this.

Thanks.

Re: [PATCH] wrap long lines in doc

[Bob Wilson]

Eli Zaretskii wrote:
>> Date: Mon, 26 Mar 2007 10:20:21 -0700
>> From: Bob Wilson <bwilson@tensilica.com>
>>
>> Surely this must qualify as obvious
> 
> Yes; but it's also unneeded.

?  Are you saying that I should have just committed this without asking 
permission or that I should have left the long lines?  I would have assumed the 
former except that I promised to be cautious about invoking the "obvious" rule 
after you objected to something I committed last fall (admittedly much less 
obvious than this).  I don't work on GDB often so I'm just trying to be careful.

> If all you did was type "M-q" in Emacs on each of these paragraphs,
> please go ahead and commit this.

Yes, that's all I did.  I will commit it.

--Bob

Re: [PATCH] wrap long lines in doc

[Eli Zaretskii]

> Date: Mon, 26 Mar 2007 13:29:38 -0700
> From: Bob Wilson <bwilson@tensilica.com>
> CC:  gdb-patches@sources.redhat.com
> 
> > Yes; but it's also unneeded.
> 
> ?  Are you saying that I should have just committed this without asking 
> permission or that I should have left the long lines?

I'm saying that it isn't worth the hassle to do such reformatting:
makeinfo and TeX do that for you when they produce output.  The
Texinfo sources are not required to be especially beautiful.

Of course, once you did that, I'm only grateful to accept the changes.

Thanks!

> I don't work on GDB often so I'm just trying to be careful.

Thank you.

Re: [PATCH] wrap long lines in doc

[Bob Wilson]

Eli Zaretskii wrote:
> I'm saying that it isn't worth the hassle to do such reformatting:
> makeinfo and TeX do that for you when they produce output.  The
> Texinfo sources are not required to be especially beautiful.

Sure, but C code doesn't need to be beautiful either and yet we have a 
convention about keeping the lines less than 80 columns.  I find wrapped lines 
hard to read, so I like to fix them.

Thanks for approving the change.