Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: gdb-patches@sourceware.org
Subject: [PATCH] guile: Fix documentation typos.
Date: Sun, 16 Feb 2014 21:46:00 -0000	[thread overview]
Message-ID: <87vbwespcb.fsf@gnu.org> (raw)

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}


             reply	other threads:[~2014-02-16 21:46 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-02-16 21:46 Ludovic Courtès [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87vbwespcb.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox