[PATCH] guile: Fix documentation typos.

[PATCH] guile: Fix documentation typos.

[Ludovic Courtès]

Hello,

The patch below fixes a couple of typos in the Guile API documentation.

Thanks,
Ludo’.

2014-02-16  Ludovic Courtès  <ludo@gnu.org>

	* doc/guile.texi (Writing a Guile Pretty-Printer) <example>:
	Remove 'string-begins-with' procedure.  Add 'pretty-printer'
	parameter to 'str-lookup-function' procedure.  Look for
	the "std::string<" prefix.
	(Frames In Guile): Add 'frame' parameter to 'frame-read-var'.
	Adjust description.

diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 924f97a..ceb98dc 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -1545,14 +1545,11 @@ And here is an example showing how a lookup function for the printer
 example above might be written.
 
 @smallexample
-(define (string-begins-with str prefix)
-  (= (string-prefix-length str prefix) (string-length prefix)))
-
-(define (str-lookup-function value)
+(define (str-lookup-function pretty-printer value)
   (let ((tag (type-tag (value-type value))))
     (and tag
-         (string-begins-with tag "my::string<")
-         (make-std-string-printer value))))
+         (string-prefix? "std::string<" tag)
+         (make-my-string-printer value))))
 @end smallexample
 
 Then to register this printer in the global printer list:
@@ -1893,8 +1890,8 @@ Return the frame's @code{<gdb:sal>} (symtab and line) object.
 @xref{Symbol Tables In Guile}.
 @end deffn
 
-@deffn {Scheme Procedure} frame-read-var variable @r{[}#:block block@r{]}
-Return the value of @var{variable} in this frame.  If the optional
+@deffn {Scheme Procedure} frame-read-var frame variable @r{[}#:block block@r{]}
+Return the value of @var{variable} in @var{frame}.  If the optional
 argument @var{block} is provided, search for the variable from that
 block; otherwise start at the frame's current block (which is
 determined by the frame's current program counter).  @var{variable}

Re: [PATCH] guile: Fix documentation typos.

[Eli Zaretskii]

> From: ludo@gnu.org (Ludovic Courtès)
> Date: Sun, 16 Feb 2014 22:46:28 +0100
> 
> The patch below fixes a couple of typos in the Guile API documentation.
> 
> Thanks,
> Ludo’.
> 
> 2014-02-16  Ludovic Courtès  <ludo@gnu.org>
> 
> 	* doc/guile.texi (Writing a Guile Pretty-Printer) <example>:
> 	Remove 'string-begins-with' procedure.  Add 'pretty-printer'
> 	parameter to 'str-lookup-function' procedure.  Look for
> 	the "std::string<" prefix.
> 	(Frames In Guile): Add 'frame' parameter to 'frame-read-var'.
> 	Adjust description.

OK, and thanks.

Re: [PATCH] guile: Fix documentation typos.

[Ludovic Courtès]

Eli Zaretskii <eliz@gnu.org> skribis:

>> From: ludo@gnu.org (Ludovic Courtès)
>> Date: Sun, 16 Feb 2014 22:46:28 +0100
>> 
>> The patch below fixes a couple of typos in the Guile API documentation.
>> 
>> Thanks,
>> Ludo’.
>> 
>> 2014-02-16  Ludovic Courtès  <ludo@gnu.org>
>> 
>> 	* doc/guile.texi (Writing a Guile Pretty-Printer) <example>:
>> 	Remove 'string-begins-with' procedure.  Add 'pretty-printer'
>> 	parameter to 'str-lookup-function' procedure.  Look for
>> 	the "std::string<" prefix.
>> 	(Frames In Guile): Add 'frame' parameter to 'frame-read-var'.
>> 	Adjust description.
>
> OK, and thanks.

Pushed, thanks!

Ludo’.

Re: [PATCH] guile: Fix documentation typos.

[Doug Evans]

On Mon, Feb 17, 2014 at 7:59 AM, Ludovic Courtès <ludo@gnu.org> wrote:
> Eli Zaretskii <eliz@gnu.org> skribis:
>
>>> From: ludo@gnu.org (Ludovic Courtès)
>>> Date: Sun, 16 Feb 2014 22:46:28 +0100
>>>
>>> The patch below fixes a couple of typos in the Guile API documentation.
>>>
>>> Thanks,
>>> Ludo'.
>>>
>>> 2014-02-16  Ludovic Courtès  <ludo@gnu.org>
>>>
>>>      * doc/guile.texi (Writing a Guile Pretty-Printer) <example>:
>>>      Remove 'string-begins-with' procedure.  Add 'pretty-printer'
>>>      parameter to 'str-lookup-function' procedure.  Look for
>>>      the "std::string<" prefix.
>>>      (Frames In Guile): Add 'frame' parameter to 'frame-read-var'.
>>>      Adjust description.
>>
>> OK, and thanks.
>
> Pushed, thanks!
>
> Ludo'

Thanks for the fix!

I moved the ChangeLog entry from gdb/ChangeLog to gdb/doc/ChangeLog.

Re: [PATCH] guile: Fix documentation typos.

[Ludovic Courtès]

Doug Evans <xdje42@gmail.com> skribis:

> I moved the ChangeLog entry from gdb/ChangeLog to gdb/doc/ChangeLog.

Oh right, sorry about that.

Ludo’.