* [PATCH] guile: Fix documentation typos.
@ 2014-02-16 21:46 Ludovic Courtès
2014-02-17 4:55 ` Eli Zaretskii
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2014-02-16 21:46 UTC (permalink / raw)
To: gdb-patches
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}
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] guile: Fix documentation typos.
2014-02-16 21:46 [PATCH] guile: Fix documentation typos Ludovic Courtès
@ 2014-02-17 4:55 ` Eli Zaretskii
2014-02-17 15:59 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Eli Zaretskii @ 2014-02-17 4:55 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: gdb-patches
> 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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] guile: Fix documentation typos.
2014-02-17 4:55 ` Eli Zaretskii
@ 2014-02-17 15:59 ` Ludovic Courtès
2014-02-17 18:39 ` Doug Evans
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2014-02-17 15:59 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: gdb-patches
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’.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] guile: Fix documentation typos.
2014-02-17 15:59 ` Ludovic Courtès
@ 2014-02-17 18:39 ` Doug Evans
2014-02-17 22:32 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Doug Evans @ 2014-02-17 18:39 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: Eli Zaretskii, gdb-patches
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2014-02-17 22:32 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-02-16 21:46 [PATCH] guile: Fix documentation typos Ludovic Courtès
2014-02-17 4:55 ` Eli Zaretskii
2014-02-17 15:59 ` Ludovic Courtès
2014-02-17 18:39 ` Doug Evans
2014-02-17 22:32 ` Ludovic Courtès
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox