[PATCH] doc: Document the peek and pk procedures.

  • Open
  • quality assurance status badge
Details
4 participants
  • jgart
  • Juliana Sims
  • Maxim Cournoyer
  • Simon Tournier
Owner
unassigned
Submitted by
Juliana Sims
Severity
normal
Merged with
J
J
Juliana Sims wrote on 20 Jun 20:54 +0200
(address . bug-guile@gnu.org)(name . Juliana Sims)(address . juli@incana.org)
20240620185415.9088-1-juli@incana.org
* doc/ref/api-debug.texi: Document the peek and pk procedures.
---
doc/ref/api-debug.texi | 187 +++++++++++++++++++++++++++++++++++++++--
1 file changed, 179 insertions(+), 8 deletions(-)

Toggle diff (213 lines)
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
index faa0c40bd..486473cdb 100644
--- a/doc/ref/api-debug.texi
+++ b/doc/ref/api-debug.texi
@@ -1,27 +1,198 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
-@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2010, 2011, 2012, 2013, 2014, 2018, 2021
+@c Copyright (C) 1996-1997, 2000-2004, 2007, 2010-2014, 2018, 2021, 2024
@c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@node Debugging
@section Debugging Infrastructure
-@cindex Debugging
-In order to understand Guile's debugging facilities, you first need to
-understand a little about how Guile represents the Scheme control stack.
-With that in place we explain the low level trap calls that the virtual
-machine can be configured to make, and the trap and breakpoint
-infrastructure that builds on top of those calls.
+@cindex debugging
+Guile provides facilities for simple print-based debugging as well as
+more advanced debugging features. In order to understand Guile's
+advanced debugging facilities, one first must understand a little about
+how Guile represents the Scheme control stack. With that in place, we
+can explain the low level trap calls that the virtual machine can be
+configured to make, and the trap and breakpoint infrastructure that
+builds on top of those calls.
@menu
+* Simple Debugging:: Print-based debugging.
* Evaluation Model:: Evaluation and the Scheme stack.
* Source Properties:: From expressions to source locations.
-* Programmatic Error Handling:: Debugging when an error occurs.
+* Programmatic Error Handling:: Debugging when an error occurs.
* Traps:: Breakpoints, tracepoints, oh my!
* GDB Support:: C-level debugging with GDB.
@end menu
+
+@node Simple Debugging
+@subsection Simple Debugging
+
+Guile offers powerful tools for introspection and debugging at the REPL,
+covered in the rest of this section and elsewhere in this manual
+(@pxref{Interactive Debugging}). Here we deal with a more primitive
+approach, commonly called ``print debugging.'' Let's be honest: for most
+of us, this is our first line of debugging. And Guile doesn't judge us
+for it! Instead, Guile provides a powerful and convenient tool to
+facilitate print debugging: the @code{peek} procedure, more commonly
+known as @code{pk} (pronounced by naming the letters).
+
+@deffn {Scheme Procedure} peek stuff @dots{}
+@deffnx {Scheme Procedure} pk stuff @dots{}
+Print @var{stuff} to the current output port using @code{write}. Return
+the last argument.
+@end deffn
+
+@code{pk} allows us to look at the state of our code as it runs without
+having to step through it or break the normal code flow. Let's take a
+look at how one might use it. Let's say we have a procedure to make a
+smore, perhaps as part of a mod for a cozy space exploration game.
+
+@lisp
+(define (make-smore marshmallow graham-crackers chocolate fire)
+ "Toast @var{mashmallow} over @var{fire} then sandwich it and
+@var{chocolate} between @var{graham-crackers}."
+ (let ((toasted-marshmallow
+ (toast marshmallow fire)))
+ (unless (or (burned? toasted-marshmallow)
+ (undercooked? toasted-marshmallow))
+ (cons (car graham-crackers)
+ (cons toasted-marshmallow
+ (cons chocolate
+ (cons (cdr graham-crackers) '())))))))
+@end lisp
+
+We've run this procedure a few times, and it isn't doing what we expect.
+Instead of getting a tasty smore, we get nothing. Let's use @code{pk} to
+find out what's going on.
+
+@lisp
+(pk (make-smore (grab-one marshmallow-bag)
+ (cons graham-cracker graham-cracker)
+ campfire))
+
+;;; (#<unspecified>)
+@end lisp
+
+@code{#<unspecified>} is a value in Guile which indicates that no Scheme
+standard specifies a return value for whatever is returning it. In this
+case, it probably means that our @code{unless} check is not proving
+true, so the procedure returns nothing. Let's add a @code{pk} around the
+call to @code{toast} and see what happens.
+
+@lisp
+(define (make-smore marshmallow graham-crackers chocolate fire)
+ "Toast @var{mashmallow} over @var{fire} then sandwich it and
+@var{chocolate} between @var{graham-crackers}."
+ (let ((toasted-marshmallow
+ ;; Let's see what state the toasted-marshmallow is in
+ (pk 'toasted-marshmallow (toast marshmallow fire))))
+ (unless (or (burned? toasted-marshmallow)
+ (undercooked? toasted-marshmallow))
+ (cons (car graham-crackers)
+ (cons toasted-marshmallow
+ (cons chocolate
+ (cons (cdr graham-crackers) '())))))))
+
+(make-smore (grab-one marshmallow-bag)
+ (cons graham-cracker graham-cracker)
+ campfire)
+
+;;; (toasted-marshmallow #<<marshmallow> state: raw>)
+@end lisp
+
+Our marshmallow isn't getting cooked at all! Let's see if we can find
+out why. We'll check on the state of @var{fire} since we know that
+@code{toast} just operates on the state of the fire and of the
+marshmallow. @code{toasted-marshmallow} matches the state we expect for
+a fresh marshmallow, so the problem is probably with the fire.
+
+@lisp
+(define (make-smore marshmallow graham-crackers chocolate fire)
+ "Toast @var{mashmallow} over @var{fire} then sandwich it and
+@var{chocolate} between @var{graham-crackers}."
+ (let ((toasted-marshmallow
+ ;; Now we'll check on the fire, too
+ (pk 'toasted-marshmallow (toast marshmallow (pk 'fire fire)))))
+ (unless (or (burned? toasted-marshmallow)
+ (undercooked? toasted-marshmallow))
+ (cons (car graham-crackers)
+ (cons toasted-marshmallow
+ (cons chocolate
+ (cons (cdr graham-crackers) '())))))))
+
+(make-smore (grab-one marshmallow-bag)
+ (cons graham-cracker graham-cracker)
+ campfire)
+
+;;; (fire #<<fire> state: unlit>)
+
+;;; (toasted-marshmallow #<<marshmallow> state: raw>)
+@end lisp
+
+Oh, well that makes sense! A fire can't cook a marshmallow if it isn't
+lit!
+
+Notice that the result of evaluating the @code{pk} around @code{fire} is
+printed before the one around @code{toast}. This is just the result of
+the normal process of evaluating s-expressions from the inside out. We
+highlight it because it can be confusing at first, especially with more
+@code{pk}s in more complex code.
+
+Let's add a guard to light the fire and run our procedure again.
+
+@lisp
+(define (make-smore marshmallow graham-crackers chocolate fire)
+ "Toast @var{mashmallow} over @var{fire} then sandwich it and
+@var{chocolate} between @var{graham-crackers}."
+ (let ((toasted-marshmallow
+ (toast marshmallow fire)))
+ (unless (lit? fire)
+ (light fire))
+ (unless (or (burned? toasted-marshmallow)
+ (undercooked? toasted-marshmallow))
+ (cons (car graham-crackers)
+ (cons toasted-marshmallow
+ (cons chocolate
+ (cons (cdr graham-crackers) '())))))))
+
+(make-smore (grab-one marshmallow-bag)
+ (cons graham-cracker graham-cracker)
+ campfire)
+@result{} (#<<graham-cracker>> #<<marshmallow> state: cooked> #<<chocolate>> #<<graham-cracker>>)
+@end lisp
+
+Yay! Now it works, and we have a tasty smore!
+
+As we demonstrated, you can pass in any number of arguments and the
+result of evaluating the last argument is the value returned from
+@code{pk}. This is handy to, as we showed, wrap code in-line without
+needing to add extra steps along the way while still providing
+informative labels about what, exactly, is getting printed. We could as
+easily have put @code{pk}s completely on their own, rather than wrapping
+other code. This is commonly used to, for example, test if a given
+procedure or part of a procedure is entered. Earlier, we could have put
+a @code{pk} in the body of the @code{unless} clause to let us know if we
+entered it, such as:
+
+@lisp
+(define (make-smore ...)
+ ...
+ (unless ...
+ (pk 'inside-unless)
+ ...))
+@end lisp
+
+As a final note, labels don't have to be symbols. @code{pk} will happily
+print any object we pass it. We could have used strings or anything else
+we wanted alongside the code we were interested in.
+
+Hopefully this silly little example has shown the utility of @code{pk}.
+Now that it's in your toolbox, go forth, newly empowered, and happy
+hacking!
+
+
@node Evaluation Model
@subsection Evaluation and the Scheme Stack
--
2.45.1
M
M
Maxim Cournoyer wrote on 2 Jul 05:54 +0200
(name . Juliana Sims)(address . juli@incana.org)(address . 71684@debbugs.gnu.org)
87jzi45tyn.fsf@gmail.com
Hi Juliana!

Juliana Sims <juli@incana.org> writes:

Toggle quote (2 lines)
> * doc/ref/api-debug.texi: Document the peek and pk procedures.

This looks very useful! Thanks for authoring it.

Toggle quote (34 lines)
> ---
> doc/ref/api-debug.texi | 187 +++++++++++++++++++++++++++++++++++++++--
> 1 file changed, 179 insertions(+), 8 deletions(-)
>
> diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
> index faa0c40bd..486473cdb 100644
> --- a/doc/ref/api-debug.texi
> +++ b/doc/ref/api-debug.texi
> @@ -1,27 +1,198 @@
> @c -*-texinfo-*-
> @c This is part of the GNU Guile Reference Manual.
> -@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2010, 2011, 2012, 2013, 2014, 2018, 2021
> +@c Copyright (C) 1996-1997, 2000-2004, 2007, 2010-2014, 2018, 2021, 2024
> @c Free Software Foundation, Inc.
> @c See the file guile.texi for copying conditions.
>
> @node Debugging
> @section Debugging Infrastructure
>
> -@cindex Debugging
> -In order to understand Guile's debugging facilities, you first need to
> -understand a little about how Guile represents the Scheme control stack.
> -With that in place we explain the low level trap calls that the virtual
> -machine can be configured to make, and the trap and breakpoint
> -infrastructure that builds on top of those calls.
> +@cindex debugging
> +Guile provides facilities for simple print-based debugging as well as
> +more advanced debugging features. In order to understand Guile's
> +advanced debugging facilities, one first must understand a little about
> +how Guile represents the Scheme control stack. With that in place, we
> +can explain the low level trap calls that the virtual machine can be
> +configured to make, and the trap and breakpoint infrastructure that
> +builds on top of those calls.

The typographical convention for Texinfo/Guile documentation is to use
two spaces to separate sentences.

Toggle quote (8 lines)
>
> @menu
> +* Simple Debugging:: Print-based debugging.
> * Evaluation Model:: Evaluation and the Scheme stack.
> * Source Properties:: From expressions to source locations.
> -* Programmatic Error Handling:: Debugging when an error occurs.
> +* Programmatic Error Handling:: Debugging when an error occurs.

To be valid, Texinfo menu entry description must be indented at least 2
spaces from the node name (so you should drop the above hunk). I use in
Emacs: Menu 'Texinfo -> Update all menus' to ease maintaining these, in
case it's useful.

Toggle quote (28 lines)
> * Traps:: Breakpoints, tracepoints, oh my!
> * GDB Support:: C-level debugging with GDB.
> @end menu
>
> +
> +@node Simple Debugging
> +@subsection Simple Debugging
> +
> +Guile offers powerful tools for introspection and debugging at the REPL,
> +covered in the rest of this section and elsewhere in this manual
> +(@pxref{Interactive Debugging}). Here we deal with a more primitive
> +approach, commonly called ``print debugging.'' Let's be honest: for most
> +of us, this is our first line of debugging. And Guile doesn't judge us
> +for it! Instead, Guile provides a powerful and convenient tool to
> +facilitate print debugging: the @code{peek} procedure, more commonly
> +known as @code{pk} (pronounced by naming the letters).
> +
> +@deffn {Scheme Procedure} peek stuff @dots{}
> +@deffnx {Scheme Procedure} pk stuff @dots{}
> +Print @var{stuff} to the current output port using @code{write}. Return
> +the last argument.
> +@end deffn
> +
> +@code{pk} allows us to look at the state of our code as it runs without
> +having to step through it or break the normal code flow. Let's take a
> +look at how one might use it. Let's say we have a procedure to make a
> +smore, perhaps as part of a mod for a cozy space exploration game.

I think using an impersonal tone would match better the style of the
rest of the manual (for example, replacing the above with "@code{pk}
allows looking at the state of a program as it runs without having to
[...]) -- that is, removing the 'we' and 'us'. I find it otherwise
reads a bit more like a tutorial (it's more engaging with the reader,
which isn't bad, but it clashes with the rest of this reference manual).

Toggle quote (116 lines)
> +@lisp
> +(define (make-smore marshmallow graham-crackers chocolate fire)
> + "Toast @var{mashmallow} over @var{fire} then sandwich it and
> +@var{chocolate} between @var{graham-crackers}."
> + (let ((toasted-marshmallow
> + (toast marshmallow fire)))
> + (unless (or (burned? toasted-marshmallow)
> + (undercooked? toasted-marshmallow))
> + (cons (car graham-crackers)
> + (cons toasted-marshmallow
> + (cons chocolate
> + (cons (cdr graham-crackers) '())))))))
> +@end lisp
> +
> +We've run this procedure a few times, and it isn't doing what we expect.
> +Instead of getting a tasty smore, we get nothing. Let's use @code{pk} to
> +find out what's going on.
> +
> +@lisp
> +(pk (make-smore (grab-one marshmallow-bag)
> + (cons graham-cracker graham-cracker)
> + campfire))
> +
> +;;; (#<unspecified>)
> +@end lisp
> +
> +@code{#<unspecified>} is a value in Guile which indicates that no Scheme
> +standard specifies a return value for whatever is returning it. In this
> +case, it probably means that our @code{unless} check is not proving
> +true, so the procedure returns nothing. Let's add a @code{pk} around the
> +call to @code{toast} and see what happens.
> +
> +@lisp
> +(define (make-smore marshmallow graham-crackers chocolate fire)
> + "Toast @var{mashmallow} over @var{fire} then sandwich it and
> +@var{chocolate} between @var{graham-crackers}."
> + (let ((toasted-marshmallow
> + ;; Let's see what state the toasted-marshmallow is in
> + (pk 'toasted-marshmallow (toast marshmallow fire))))
> + (unless (or (burned? toasted-marshmallow)
> + (undercooked? toasted-marshmallow))
> + (cons (car graham-crackers)
> + (cons toasted-marshmallow
> + (cons chocolate
> + (cons (cdr graham-crackers) '())))))))
> +
> +(make-smore (grab-one marshmallow-bag)
> + (cons graham-cracker graham-cracker)
> + campfire)
> +
> +;;; (toasted-marshmallow #<<marshmallow> state: raw>)
> +@end lisp
> +
> +Our marshmallow isn't getting cooked at all! Let's see if we can find
> +out why. We'll check on the state of @var{fire} since we know that
> +@code{toast} just operates on the state of the fire and of the
> +marshmallow. @code{toasted-marshmallow} matches the state we expect for
> +a fresh marshmallow, so the problem is probably with the fire.
> +
> +@lisp
> +(define (make-smore marshmallow graham-crackers chocolate fire)
> + "Toast @var{mashmallow} over @var{fire} then sandwich it and
> +@var{chocolate} between @var{graham-crackers}."
> + (let ((toasted-marshmallow
> + ;; Now we'll check on the fire, too
> + (pk 'toasted-marshmallow (toast marshmallow (pk 'fire fire)))))
> + (unless (or (burned? toasted-marshmallow)
> + (undercooked? toasted-marshmallow))
> + (cons (car graham-crackers)
> + (cons toasted-marshmallow
> + (cons chocolate
> + (cons (cdr graham-crackers) '())))))))
> +
> +(make-smore (grab-one marshmallow-bag)
> + (cons graham-cracker graham-cracker)
> + campfire)
> +
> +;;; (fire #<<fire> state: unlit>)
> +
> +;;; (toasted-marshmallow #<<marshmallow> state: raw>)
> +@end lisp
> +
> +Oh, well that makes sense! A fire can't cook a marshmallow if it isn't
> +lit!
> +
> +Notice that the result of evaluating the @code{pk} around @code{fire} is
> +printed before the one around @code{toast}. This is just the result of
> +the normal process of evaluating s-expressions from the inside out. We
> +highlight it because it can be confusing at first, especially with more
> +@code{pk}s in more complex code.
> +
> +Let's add a guard to light the fire and run our procedure again.
> +
> +@lisp
> +(define (make-smore marshmallow graham-crackers chocolate fire)
> + "Toast @var{mashmallow} over @var{fire} then sandwich it and
> +@var{chocolate} between @var{graham-crackers}."
> + (let ((toasted-marshmallow
> + (toast marshmallow fire)))
> + (unless (lit? fire)
> + (light fire))
> + (unless (or (burned? toasted-marshmallow)
> + (undercooked? toasted-marshmallow))
> + (cons (car graham-crackers)
> + (cons toasted-marshmallow
> + (cons chocolate
> + (cons (cdr graham-crackers) '())))))))
> +
> +(make-smore (grab-one marshmallow-bag)
> + (cons graham-cracker graham-cracker)
> + campfire)
> +@result{} (#<<graham-cracker>> #<<marshmallow> state: cooked> #<<chocolate>> #<<graham-cracker>>)
> +@end lisp
> +
> +Yay! Now it works, and we have a tasty smore!

The examples were fun, but it's very verbose to explain what it does,
and the examples can't be evaluated at the REPL, which departs from the
rest of the manual. I think a simple example that can be evaluated at
the REPL may more succinctly express the effect of 'pk'.

Toggle quote (27 lines)
> +As we demonstrated, you can pass in any number of arguments and the
> +result of evaluating the last argument is the value returned from
> +@code{pk}. This is handy to, as we showed, wrap code in-line without
> +needing to add extra steps along the way while still providing
> +informative labels about what, exactly, is getting printed. We could as
> +easily have put @code{pk}s completely on their own, rather than wrapping
> +other code. This is commonly used to, for example, test if a given
> +procedure or part of a procedure is entered. Earlier, we could have put
> +a @code{pk} in the body of the @code{unless} clause to let us know if we
> +entered it, such as:
> +
> +@lisp
> +(define (make-smore ...)
> + ...
> + (unless ...
> + (pk 'inside-unless)
> + ...))
> +@end lisp
> +
> +As a final note, labels don't have to be symbols. @code{pk} will happily
> +print any object we pass it. We could have used strings or anything else
> +we wanted alongside the code we were interested in.
> +
> +Hopefully this silly little example has shown the utility of @code{pk}.
> +Now that it's in your toolbox, go forth, newly empowered, and happy
> +hacking!

The last sentence reads like the end of a blog post rather than a
section of the manual, at least to me. Perhaps I have too many gray
hairs :-)

If you agree to my feedback, I think a v2 with a switch to impersonal
verbs, as well as using the two spaces convention would be an easy
improvement. I'd personally prefer a simpler, perhaps boring example
that can be evaluated directly at the REPL to the more verbose (but
funny) smore adventure that I can't readily experiment with, but I'll
leave others to comment.

--
Thanks,
Maxim
J
J
Juliana Sims wrote on 2 Jul 18:28 +0200
[PATCH v2] doc: Document the peek and pk procedures.
(address . maxim.cournoyer@gmail.com)
20240702164418.11886-1-juli@incana.org
* doc/ref/api-debug.texi: Document the peek and pk procedures.
---

Hi Maxim,

Thanks for the quick review! I thought I'd made sure to double-space after
periods, but I guess my Emacs fill settings overwrote that when I made sure
everything flowed properly. The contemporary consensus on double spaces in
English is to not use them, and I write a lot so I have my text-mode settings
geared to that purpose. I used manual filling this time so hopefully that issue
has been resolved.

I didn't use Emacs to regenerate all the menus in this file because it produced
diffs in unrelated sections. Otherwise, I've taken all of your feedback into
account. If someone chimes in to say they really liked the smores example, we
can always build out from the first version of the patch. There was a lot of
code involved in making that actually work (three record types, two predicates,
and a utility function) so I don't think that's the right solution.

Best,
Juli

doc/ref/api-debug.texi | 120 +++++++++++++++++++++++++++++++++++++----
1 file changed, 109 insertions(+), 11 deletions(-)

Toggle diff (143 lines)
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
index faa0c40bd..76d636d13 100644
--- a/doc/ref/api-debug.texi
+++ b/doc/ref/api-debug.texi
@@ -1,27 +1,125 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
-@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2010, 2011, 2012, 2013, 2014, 2018, 2021
+@c Copyright (C) 1996-1997, 2000-2004, 2007, 2010-2014, 2018, 2021, 2024
@c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@node Debugging
@section Debugging Infrastructure
-@cindex Debugging
-In order to understand Guile's debugging facilities, you first need to
-understand a little about how Guile represents the Scheme control stack.
-With that in place we explain the low level trap calls that the virtual
-machine can be configured to make, and the trap and breakpoint
-infrastructure that builds on top of those calls.
+@cindex debugging
+Guile provides facilities for simple print-based debugging as well as
+more advanced debugging features. In order to understand Guile's
+advanced debugging facilities, one first must understand a little about
+how Guile represents the Scheme control stack. With that in place, we
+can explain the low level trap calls that the virtual machine can be
+configured to make, and the trap and breakpoint infrastructure that
+builds on top of those calls.
@menu
-* Evaluation Model:: Evaluation and the Scheme stack.
-* Source Properties:: From expressions to source locations.
+* Simple Debugging:: Print-based debugging.
+* Evaluation Model:: Evaluation and the Scheme stack.
+* Source Properties:: From expressions to source locations.
* Programmatic Error Handling:: Debugging when an error occurs.
-* Traps:: Breakpoints, tracepoints, oh my!
-* GDB Support:: C-level debugging with GDB.
+* Traps:: Breakpoints, tracepoints, oh my!
+* GDB Support:: C-level debugging with GDB.
@end menu
+
+@node Simple Debugging
+@subsection Simple Debugging
+
+Guile offers powerful tools for introspection and debugging at the REPL,
+covered in the rest of this section and elsewhere in this manual
+(@pxref{Interactive Debugging}). Here we deal with a more primitive
+approach, commonly called ``print debugging,'' which is a quick way to
+diagnose simple errors by printing values during a program's execution.
+Guile provides the @code{peek} procedure, more commonly known as
+@code{pk} (pronounced by naming the letters), as a convenient and
+powerful tool for this kind of debugging.
+
+@deffn {Scheme Procedure} peek stuff @dots{}
+@deffnx {Scheme Procedure} pk stuff @dots{}
+Print @var{stuff} to the current output port using @code{write}. Return
+the last argument.
+@end deffn
+
+@code{pk} improves on using @code{write} directly because it enables
+inspection of the state of code as it runs without breaking the normal
+code flow. It is also more convenient than a full debugger because it
+does not require the program to be stopped for inspection. Here is a
+basic example:
+
+@lisp
+(define fire 'burns)
+
+(pk fire)
+@result{}
+
+;;; (burns)
+burns
+@end
+
+Here is an example of inspecting a value in the midst of code flow:
+
+@lisp
+(map (lambda (v)
+ (if (number? v)
+ (number->string v)
+ (pk v)))
+ '(1 "2" "3" 4))
+@result{}
+
+;;; ("2")
+
+;;; ("3")
+("1" "2" "3" "4")
+@end
+
+A common technique when using @code{pk} is to label values with symbols
+to keep track of where they're coming from. There's no reason these
+labels need to be symbols; symbols are just convenient. Here's a
+slightly more complex example demonstrating that pattern:
+
+@lisp
+(define (pk-identity x)
+ (pk 'arg-to-identity x))
+
+(pk-identity 42)
+@result{}
+
+;;; (arg-to-identity 42)
+42
+@end
+
+@code{pk} has one small quirk of note. Currently, it only returns the
+first value returned from any multi-value returns. So for example:
+
+@lisp
+(pk 'vals (values 1 2 3))
+@result{}
+
+;;; (vals 1)
+1
+@end
+
+The way to get around this limitation is to bind such multi-value
+returns then inspect the results. Still, @code{pk} can only return a
+single value:
+
+@lisp
+(use-modules (srfi srfi-11))
+
+(let-values (((x y z)
+ (values 1 2 3)))
+ (pk 'vals x y z))
+@result{}
+
+;;; (vals 1 2 3)
+3
+@end
+
+
@node Evaluation Model
@subsection Evaluation and the Scheme Stack
--
2.45.1
M
M
Maxim Cournoyer wrote on 9 Jul 04:56 +0200
(name . Juliana Sims)(address . juli@incana.org)(address . 71684@debbugs.gnu.org)
87r0c3w9vs.fsf@gmail.com
Hi Juliana,

Juliana Sims <juli@incana.org> writes:

Toggle quote (12 lines)
> * doc/ref/api-debug.texi: Document the peek and pk procedures.
> ---
>
> Hi Maxim,
>
> Thanks for the quick review! I thought I'd made sure to double-space after
> periods, but I guess my Emacs fill settings overwrote that when I made sure
> everything flowed properly. The contemporary consensus on double spaces in
> English is to not use them, and I write a lot so I have my text-mode settings
> geared to that purpose. I used manual filling this time so hopefully that issue
> has been resolved.

Thanks! It's a peculiar/historical typography choice that seems rooted
in being able to navigate unambiguously between sentences in Emacs (and
elsewhere where implemented).

Toggle quote (3 lines)
> I didn't use Emacs to regenerate all the menus in this file because it produced
> diffs in unrelated sections.

Fair enough!

Toggle quote (6 lines)
> Otherwise, I've taken all of your feedback into
> account. If someone chimes in to say they really liked the smores example, we
> can always build out from the first version of the patch. There was a lot of
> code involved in making that actually work (three record types, two predicates,
> and a utility function) so I don't think that's the right solution.

Sounds good.

[...]


Toggle quote (68 lines)
> diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
> index faa0c40bd..76d636d13 100644
> --- a/doc/ref/api-debug.texi
> +++ b/doc/ref/api-debug.texi
> @@ -1,27 +1,125 @@
> @c -*-texinfo-*-
> @c This is part of the GNU Guile Reference Manual.
> -@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2010, 2011, 2012, 2013, 2014, 2018, 2021
> +@c Copyright (C) 1996-1997, 2000-2004, 2007, 2010-2014, 2018, 2021, 2024
> @c Free Software Foundation, Inc.
> @c See the file guile.texi for copying conditions.
>
> @node Debugging
> @section Debugging Infrastructure
>
> -@cindex Debugging
> -In order to understand Guile's debugging facilities, you first need to
> -understand a little about how Guile represents the Scheme control stack.
> -With that in place we explain the low level trap calls that the virtual
> -machine can be configured to make, and the trap and breakpoint
> -infrastructure that builds on top of those calls.
> +@cindex debugging
> +Guile provides facilities for simple print-based debugging as well as
> +more advanced debugging features. In order to understand Guile's
> +advanced debugging facilities, one first must understand a little about
> +how Guile represents the Scheme control stack. With that in place, we
> +can explain the low level trap calls that the virtual machine can be
> +configured to make, and the trap and breakpoint infrastructure that
> +builds on top of those calls.
>
> @menu
> -* Evaluation Model:: Evaluation and the Scheme stack.
> -* Source Properties:: From expressions to source locations.
> +* Simple Debugging:: Print-based debugging.
> +* Evaluation Model:: Evaluation and the Scheme stack.
> +* Source Properties:: From expressions to source locations.
> * Programmatic Error Handling:: Debugging when an error occurs.
> -* Traps:: Breakpoints, tracepoints, oh my!
> -* GDB Support:: C-level debugging with GDB.
> +* Traps:: Breakpoints, tracepoints, oh my!
> +* GDB Support:: C-level debugging with GDB.
> @end menu
>
> +
> +@node Simple Debugging
> +@subsection Simple Debugging
> +
> +Guile offers powerful tools for introspection and debugging at the REPL,
> +covered in the rest of this section and elsewhere in this manual
> +(@pxref{Interactive Debugging}). Here we deal with a more primitive
> +approach, commonly called ``print debugging,'' which is a quick way to
> +diagnose simple errors by printing values during a program's execution.
> +Guile provides the @code{peek} procedure, more commonly known as
> +@code{pk} (pronounced by naming the letters), as a convenient and
> +powerful tool for this kind of debugging.
> +
> +@deffn {Scheme Procedure} peek stuff @dots{}
> +@deffnx {Scheme Procedure} pk stuff @dots{}
> +Print @var{stuff} to the current output port using @code{write}. Return
> +the last argument.
> +@end deffn
> +
> +@code{pk} improves on using @code{write} directly because it enables
> +inspection of the state of code as it runs without breaking the normal
> +code flow. It is also more convenient than a full debugger because it
> +does not require the program to be stopped for inspection. Here is a
> +basic example:

I hadn't commented on that last sentence before, but if I knew how to
have the Guile debugger reliably break where I want it to (I don't, or
somehow haven't managed to have it work well), I don't think using 'pk',
which requires editing files before and after debugging, could be
described as more convenient :-).

Toggle quote (73 lines)
> +@lisp
> +(define fire 'burns)
> +
> +(pk fire)
> +@result{}
> +
> +;;; (burns)
> +burns
> +@end
> +
> +Here is an example of inspecting a value in the midst of code flow:
> +
> +@lisp
> +(map (lambda (v)
> + (if (number? v)
> + (number->string v)
> + (pk v)))
> + '(1 "2" "3" 4))
> +@result{}
> +
> +;;; ("2")
> +
> +;;; ("3")
> +("1" "2" "3" "4")
> +@end
> +
> +A common technique when using @code{pk} is to label values with symbols
> +to keep track of where they're coming from. There's no reason these
> +labels need to be symbols; symbols are just convenient. Here's a
> +slightly more complex example demonstrating that pattern:
> +
> +@lisp
> +(define (pk-identity x)
> + (pk 'arg-to-identity x))
> +
> +(pk-identity 42)
> +@result{}
> +
> +;;; (arg-to-identity 42)
> +42
> +@end
> +
> +@code{pk} has one small quirk of note. Currently, it only returns the
> +first value returned from any multi-value returns. So for example:
> +
> +@lisp
> +(pk 'vals (values 1 2 3))
> +@result{}
> +
> +;;; (vals 1)
> +1
> +@end
> +
> +The way to get around this limitation is to bind such multi-value
> +returns then inspect the results. Still, @code{pk} can only return a
> +single value:
> +
> +@lisp
> +(use-modules (srfi srfi-11))
> +
> +(let-values (((x y z)
> + (values 1 2 3)))
> + (pk 'vals x y z))
> +@result{}
> +
> +;;; (vals 1 2 3)
> +3
> +@end
> +
> +
> @node Evaluation Model
> @subsection Evaluation and the Scheme Stack

I like the new, 'evaluatable' examples :-). It's also a much shorter
read. Thanks for sending a v2!

I would commit this if I was a committer, but I am not, so here's at
least my reviewed trailer:

Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail>

--
Thanks,
Maxim
S
S
Simon Tournier wrote on 10 Jul 20:21 +0200
Re: bug#71684: [PATCH v2] doc: Document the peek and pk procedures.
(name . Juliana Sims)(address . juli@incana.org)
878qy9glbd.fsf@gmail.com
Hi,

On Tue, 02 Jul 2024 at 12:28, Juliana Sims <juli@incana.org> wrote:
Toggle quote (2 lines)
> * doc/ref/api-debug.texi: Document the peek and pk procedures.

Cool! Thanks.


Toggle quote (7 lines)
> Thanks for the quick review! I thought I'd made sure to double-space after
> periods, but I guess my Emacs fill settings overwrote that when I made sure
> everything flowed properly. The contemporary consensus on double spaces in
> English is to not use them, and I write a lot so I have my text-mode settings
> geared to that purpose. I used manual filling this time so hopefully that issue
> has been resolved.

Yeah, that’s because double-space after period fixes ambiguous cases as
this example: “The author J. R. R. Tolkien wrote The Hobbit. George
R. R. Martin wrote many fantasy books.” The brain is able to determine
it’s only two sentences, but it becomes more difficult otherwise; it
could count 7 sentences.


Anyway. :-)


Toggle quote (14 lines)
> +@lisp
> +(map (lambda (v)
> + (if (number? v)
> + (number->string v)
> + (pk v)))
> + '(1 "2" "3" 4))
> +@result{}
> +
> +;;; ("2")
> +
> +;;; ("3")
> +("1" "2" "3" "4")
> +@end

For what it is worth, I would suggest something as:

Toggle snippet (9 lines)
(map (lambda (v)
(if (number? v)
(number->string v)
(begin
(pk 'else v)
(pk (string-append "-" v "0")))))
'(1 "2" "3" 4))

For two reasons:

1. ’begin’ helps to mark a sequence of expressions; IMHO, that’s a good
habit when playing with ’pk’ for debugging purpose.

2. it exposes that ’stuff’ above can be anything.


Well, my suggestion could be two other examples in addition to the
current one instead of the complexification.

My 2 cents. :-)

Cheers,
simon
M
M
Maxim Cournoyer wrote on 10 Jul 21:48 +0200
(name . Simon Tournier)(address . zimon.toutoune@gmail.com)
877cdtuixm.fsf@gmail.com
Hi Simon,

Simon Tournier <zimon.toutoune@gmail.com> writes:

[...]

Toggle quote (35 lines)
>> +@lisp
>> +(map (lambda (v)
>> + (if (number? v)
>> + (number->string v)
>> + (pk v)))
>> + '(1 "2" "3" 4))
>> +@result{}
>> +
>> +;;; ("2")
>> +
>> +;;; ("3")
>> +("1" "2" "3" "4")
>> +@end
>
> For what it is worth, I would suggest something as:
>
> (map (lambda (v)
> (if (number? v)
> (number->string v)
> (begin
> (pk 'else v)
> (pk (string-append "-" v "0")))))
> '(1 "2" "3" 4))
>
> For two reasons:
>
> 1. ’begin’ helps to mark a sequence of expressions; IMHO, that’s a good
> habit when playing with ’pk’ for debugging purpose.
>
> 2. it exposes that ’stuff’ above can be anything.
>
>
> Well, my suggestion could be two other examples in addition to the
> current one instead of the complexification.

I think I'd prefer more simple examples than a single more complicated
one, if we go that route. I think the text explained 'peek' clearly
already, though, so I personally would opt to leave it as is, especially
since adding a 'begin' block to showcase multiple 'pk' calls goes
against the merit of peek of being least intrusive (it prints then
returns the value, so the code structure needs not be changed).

--
Thanks,
Maxim
S
S
Simon Tournier wrote on 11 Jul 10:59 +0200
(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)
878qy8i9sz.fsf@gmail.com
Hi Maxim,

On Wed, 10 Jul 2024 at 15:48, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:

Toggle quote (7 lines)
> I think I'd prefer more simple examples than a single more complicated
> one, if we go that route. I think the text explained 'peek' clearly
> already, though, so I personally would opt to leave it as is, especially
> since adding a 'begin' block to showcase multiple 'pk' calls goes
> against the merit of peek of being least intrusive (it prints then
> returns the value, so the code structure needs not be changed).

Well, I do not have a strong opinion on the topic. :-)

I would suggest to apply the ’pk’ on the other branch, something as:

Toggle snippet (8 lines)
(map (lambda (v)
(if (number? v)
(pk 'number v (number->string v))
v))
'(1 "2" "3" 4))


Cheers,
simon
J
J
Juliana Sims wrote on 16 Jul 04:46 +0200
(name . Simon Tournier)(address . zimon.toutoune@gmail.com)
CP3PGS.SGM0LJUASK8Q2@incana.org
Hi y'all,
Thanks for the (continued) reviews!

Toggle quote (7 lines)
> I hadn't commented on that last sentence before, but if I knew how to
> have the Guile debugger reliably break where I want it to (I don't, or
> somehow haven't managed to have it work well), I don't think using
> 'pk',
> which requires editing files before and after debugging, could be
> described as more convenient :-).

A fair point! I can change that wording in a next version of the patch.

Toggle quote (11 lines)
> I would suggest to apply the ’pk’ on the other branch, something
> as:
>
> --8<---------------cut here---------------start------------->8---
> (map (lambda (v)
> (if (number? v)
> (pk 'number v (number->string v))
> v))
> '(1 "2" "3" 4))
> --8<---------------cut here---------------end--------------->8---

I'm not sure I understand how this improves the demonstration of 'pk'.
What does this form of the example demonstrate that the version in the
patch does not? It's a minor change so I'm happy to make it; I just
want to ensure that we have the best possible version of the solution
to the problem you see.

Best,
Juli
J
J
jgart wrote on 23 Jul 17:24 +0200
Re: [PATCH] doc: Document the peek and pk procedures.
(address . 71684@debbugs.gnu.org)
87y15st9kz.fsf@dismail.de
hi,

this looks good to me. let's merge it y'all!
--
all best,
jgart
M
M
Maxim Cournoyer wrote on 13 Sep 17:42 +0200
Re: bug#71684: [PATCH v2] doc: Document the peek and pk procedures.
(name . Juliana Sims)(address . juli@incana.org)
87zfobtv9s.fsf@gmail.com
Hi Juliana,

Juliana Sims <juli@incana.org> writes:

Toggle quote (27 lines)
> Hi y'all,
> Thanks for the (continued) reviews!
>
>> I hadn't commented on that last sentence before, but if I knew how to
>> have the Guile debugger reliably break where I want it to (I don't, or
>> somehow haven't managed to have it work well), I don't think using
>> 'pk',
>> which requires editing files before and after debugging, could be
>> described as more convenient :-).
>
> A fair point! I can change that wording in a next version of the patch.
>
>> I would suggest to apply the ’pk’ on the other branch, something as:
>> --8<---------------cut here---------------start------------->8---
>> (map (lambda (v)
>> (if (number? v)
>> (pk 'number v (number->string v))
>> v))
>> '(1 "2" "3" 4))
>> --8<---------------cut here---------------end--------------->8---
>
> I'm not sure I understand how this improves the demonstration of 'pk'.
> What does this form of the example demonstrate that the version in the
> patch does not? It's a minor change so I'm happy to make it; I just
> want to ensure that we have the best possible version of the solution
> to the problem you see.

I'm not sure I understand the motivation too. To me the v2 patch looked
fine as-is.

--
Thanks,
Maxim
M
M
Maxim Cournoyer wrote on 13 Sep 17:47 +0200
(name . Juliana Sims)(address . juli@incana.org)(address . 71684@debbugs.gnu.org)
87v7yztv1c.fsf@gmail.com
Hi Juliana,

I hope you are still around.

[...]

Toggle quote (12 lines)
>> +@code{pk} improves on using @code{write} directly because it enables
>> +inspection of the state of code as it runs without breaking the normal
>> +code flow. It is also more convenient than a full debugger because it
>> +does not require the program to be stopped for inspection. Here is a
>> +basic example:
>
> I hadn't commented on that last sentence before, but if I knew how to
> have the Guile debugger reliably break where I want it to (I don't, or
> somehow haven't managed to have it work well), I don't think using 'pk',
> which requires editing files before and after debugging, could be
> described as more convenient :-).

I think your new addition above could be modified lightly like:

+@code{pk} improves on using @code{write} directly because it enables
+inspection of the state of code as it runs without breaking the normal
+code flow. It is also sometimes more practical than a full debugger
+because it does not require the program to be stopped for inspection.
+Here is a basic example:

With the above change, I'd like to see this in the Guile manual :-).
Would you be able to send an easily applicable v3? Then the last step
would be to tap on the shoulder of a committer in #guile.

--
Thanks,
Maxim
M
M
Maxim Cournoyer wrote on 13 Sep 17:48 +0200
control message for bug #71684
(address . control@debbugs.gnu.org)
87ttejtv0r.fsf@gmail.com
merge 71684 36002
quit
S
S
Simon Tournier wrote on 13 Sep 18:03 +0200
Re: bug#71684: [PATCH v2] doc: Document the peek and pk procedures.
(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)
CAJ3okZ1OoTWk3kvpNaCDMYCqRfUTkzXgYfe2R9UcWDvKSZ5e8A@mail.gmail.com
Hi,

On Fri, 13 Sept 2024 at 17:42, Maxim Cournoyer
<maxim.cournoyer@gmail.com> wrote:

Toggle quote (19 lines)
> >> I would suggest to apply the ’pk’ on the other branch, something as:
> >>
> >> --8<---------------cut here---------------start------------->8---
> >> (map (lambda (v)
> >> (if (number? v)
> >> (pk 'number v (number->string v))
> >> v))
> >> '(1 "2" "3" 4))
> >> --8<---------------cut here---------------end--------------->8---
> >
> > I'm not sure I understand how this improves the demonstration of 'pk'.
> > What does this form of the example demonstrate that the version in the
> > patch does not? It's a minor change so I'm happy to make it; I just
> > want to ensure that we have the best possible version of the solution
> > to the problem you see.
>
> I'm not sure I understand the motivation too. To me the v2 patch looked
> fine as-is.

Becasue it shows that you can put more than only one. Qui peut le
plus, peut le moins. ;-)

And it also shows that you can call stuff.

Well, IMHO, once 'pk' is clear for you, you do not see the difference.
However, the example I suggest appears to me that it provides more
information when learning.

Cheers,
simon
J
J
Juliana Sims wrote on 13 Sep 22:03 +0200
[PATCH v3] doc: Document the peek and pk procedures.
(address . zimon.toutoune@gmail.com)
20240913200453.2965-1-juli@incana.org
* doc/ref/api-debug.texi: Document the peek and pk procedures.
---

Hey y'all,

Thanks for the feedback! I've incorporated both suggestions in this new patch.

Best,
Juli

doc/ref/api-debug.texi | 120 +++++++++++++++++++++++++++++++++++++----
1 file changed, 109 insertions(+), 11 deletions(-)

Toggle diff (145 lines)
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
index faa0c40bd..df109d390 100644
--- a/doc/ref/api-debug.texi
+++ b/doc/ref/api-debug.texi
@@ -1,27 +1,125 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
-@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2010, 2011, 2012, 2013, 2014, 2018, 2021
+@c Copyright (C) 1996-1997, 2000-2004, 2007, 2010-2014, 2018, 2021, 2024
@c Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@node Debugging
@section Debugging Infrastructure
-@cindex Debugging
-In order to understand Guile's debugging facilities, you first need to
-understand a little about how Guile represents the Scheme control stack.
-With that in place we explain the low level trap calls that the virtual
-machine can be configured to make, and the trap and breakpoint
-infrastructure that builds on top of those calls.
+@cindex debugging
+Guile provides facilities for simple print-based debugging as well as
+more advanced debugging features. In order to understand Guile's
+advanced debugging facilities, one first must understand a little about
+how Guile represents the Scheme control stack. With that in place, we
+can explain the low level trap calls that the virtual machine can be
+configured to make, and the trap and breakpoint infrastructure that
+builds on top of those calls.
@menu
-* Evaluation Model:: Evaluation and the Scheme stack.
-* Source Properties:: From expressions to source locations.
+* Simple Debugging:: Print-based debugging.
+* Evaluation Model:: Evaluation and the Scheme stack.
+* Source Properties:: From expressions to source locations.
* Programmatic Error Handling:: Debugging when an error occurs.
-* Traps:: Breakpoints, tracepoints, oh my!
-* GDB Support:: C-level debugging with GDB.
+* Traps:: Breakpoints, tracepoints, oh my!
+* GDB Support:: C-level debugging with GDB.
@end menu
+
+@node Simple Debugging
+@subsection Simple Debugging
+
+Guile offers powerful tools for introspection and debugging at the REPL,
+covered in the rest of this section and elsewhere in this manual
+(@pxref{Interactive Debugging}). Here we deal with a more primitive
+approach, commonly called ``print debugging,'' which is a quick way to
+diagnose simple errors by printing values during a program's execution.
+Guile provides the @code{peek} procedure, more commonly known as
+@code{pk} (pronounced by naming the letters), as a convenient and
+powerful tool for this kind of debugging.
+
+@deffn {Scheme Procedure} peek stuff @dots{}
+@deffnx {Scheme Procedure} pk stuff @dots{}
+Print @var{stuff} to the current output port using @code{write}. Return
+the last argument.
+@end deffn
+
+@code{pk} improves on using @code{write} directly because it enables
+inspection of the state of code as it runs without breaking the normal
+code flow. It is also sometimes more practical than a full debugger
+because it does not require the program to be stopped for inspection.
+Here is a basic example:
+
+@lisp
+(define fire 'burns)
+
+(pk fire)
+@result{}
+
+;;; (burns)
+burns
+@end
+
+Here is an example of inspecting a value in the midst of code flow:
+
+@lisp
+(map (lambda (v)
+ (if (number? v)
+ (pk 'number->string (number->string v))
+ v))
+ '(1 "2" "3" 4))
+@result{}
+
+;;; ("1")
+
+;;; ("4")
+("1" "2" "3" "4")
+@end
+
+A common technique when using @code{pk} is to label values with symbols
+to keep track of where they're coming from. There's no reason these
+labels need to be symbols; symbols are just convenient. Here's a
+slightly more complex example demonstrating that pattern:
+
+@lisp
+(define (pk-identity x)
+ (pk 'arg-to-identity x))
+
+(pk-identity 42)
+@result{}
+
+;;; (arg-to-identity 42)
+42
+@end
+
+@code{pk} has one small quirk of note. Currently, it only returns the
+first value returned from any multi-value returns. So for example:
+
+@lisp
+(pk 'vals (values 1 2 3))
+@result{}
+
+;;; (vals 1)
+1
+@end
+
+The way to get around this limitation is to bind such multi-value
+returns then inspect the results. Still, @code{pk} can only return a
+single value:
+
+@lisp
+(use-modules (srfi srfi-11))
+
+(let-values (((x y z)
+ (values 1 2 3)))
+ (pk 'vals x y z))
+@result{}
+
+;;; (vals 1 2 3)
+3
+@end
+
+
@node Evaluation Model
@subsection Evaluation and the Scheme Stack

base-commit: d0790d766bedf08fb65231eff53f6c8044eb94f1
--
2.46.0
?
Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 71684@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 71684
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch