Re: RFA/doc: couple of small Obj-C documentation tweaks

Jason Molenda
2004-01-07T23:57:54Z

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

Hi Eli,

Thanks for spotting the additional corrections. I'm inexperienced with
texinfo so I want to run the patch past you before I commit. makeinfo
and texi2html don't give any warnings when processing this - I believe
it to be correct.

I re-fmt(1)'ed a couple of paragraphs that got too wide so the diff
looks larger than it really is.

[-- Attachment #2: pa.txt --]
[-- Type: text/plain, Size: 3582 bytes --]

2004-01-07 Jason Molenda (jmolenda@apple.com)

* doc/gdb.texinfo (Objective-C: "methodName" typeo.
Add @code/@var markup around names, as needed.
Minor syntax cleanup of _NSPrintForDebugger explanation.
Two spaces after periods. GDBN used instead of lit. "gdb".
Index entries added for print-object and _NSPrintForDebugger.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.185
diff -u -p -r1.185 gdb.texinfo
--- gdb.texinfo 28 Oct 2003 22:04:47 -0000 1.185
+++ gdb.texinfo 7 Jan 2004 23:54:25 -0000
@@ -8482,12 +8482,13 @@ A fully qualified Objective-C method nam
-[@var{Class} @var{methodName}]
@end smallexample

-where the minus sign is used to indicate an instance method and a plus
-sign (not shown) is used to indicate a class method. The
-class name @var{Class} and method name @var{methoName} are enclosed in
-brackets, similar to the way messages are specified in Objective-C source
-code. For example, to set a breakpoint at the @code{create} instance method of
-class @code{Fruit} in the program currently being debugged, enter:
+where the minus sign is used to indicate an instance method and a
+plus sign (not shown) is used to indicate a class method. The class
+name @var{Class} and method name @var{methodName} are enclosed in
+brackets, similar to the way messages are specified in Objective-C
+source code. For example, to set a breakpoint at the @code{create}
+instance method of class @code{Fruit} in the program currently being
+debugged, enter:

@smallexample
break -[Fruit create]
@@ -8500,10 +8501,10 @@ enter:
list +[NSText initialize]
@end smallexample

-In the current version of GDB, the plus or minus sign is required. In
-future versions of GDB, the plus or minus sign will be optional, but you
-can use it to narrow the search. It is also possible to specify just a
-method name:
+In the current version of @value{GDBN}, the plus or minus sign is
+required. In future versions of @value{GDBN}, the plus or minus
+sign will be optional, but you can use it to narrow the search. It
+is also possible to specify just a method name:

@smallexample
break create
@@ -8524,20 +8525,23 @@ clear -[NSWindow makeKeyAndOrderFront:]

@node The Print Command with Objective-C
@subsubsection The Print Command With Objective-C
+@kindex print-object
+@kindex po @r{(@code{print-object})}
+@kindex _NSPrintForDebugger

-The print command has also been extended to accept methods. For example:
+The print command has also been extended to accept methods. For example:

@smallexample
-print -[object hash]
+print -[@var{object} hash]
@end smallexample

@cindex print an Objective-C object description
-will tell gdb to send the -hash message to object and print the
-result. Also an additional command has been added, @code{print-object}
-or @code{po} for short, which is meant to print the description of an
-object. However, this command may only work with certain Objective-C
-libraries that have a particular hook function, called
-@code{_NSPrintForDebugger} defined.
+will tell @value{GDBN} to send the @code{hash} message to @var{object}
+and print the result. Also, an additional command has been added,
+@code{print-object} or @code{po} for short, which is meant to print
+the description of an object. However, this command may only work
+with certain Objective-C libraries that have a particular hook
+function, @code{_NSPrintForDebugger}, defined.