Skip to content

Commit

Permalink
Add exceptions debugging docs to the user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmonettas committed Feb 1, 2024
1 parent 2c24578 commit db85e2a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 12 deletions.
14 changes: 9 additions & 5 deletions docs/user_guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -900,13 +900,17 @@ When clicking on a highlighted form two things can happen :

image::user_guide_images/loops.png[]

==== Exception debugging
==== Exceptions debugging

If you are using _ClojureStorm_ you can jump to the last captured exception by evaluating the `:ex` keyword on your repl. This
will position the debugger right before the exception so you can step backwards and explore the cause.
`FlowStorm` will report all functions that didn't return because an exception unwind the stack, even
when that exception was captured further and it didn't bubble up.

If you are using vanilla or using _FlowStorm_ with ClojureScript, most of the time you can accomplish the same by clicking the `Step last` button
right after the exception happens.
image::user_guide_images/exceptions.png[]

When an unwind situation is recorded a combobox will show up in the toolbar, containing all the functions names
together with the exceptions types. If you hover the mouse over any of them, a tooltip will display the exception message.

Clicking on any of them will position the stepper at that point in time so you can explore what happened before.

==== Locals

Expand Down
22 changes: 15 additions & 7 deletions docs/user_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ <h1>FlowStorm debugger User&#8217;s Guide</h1>
<li><a href="#_power_stepping">Power stepping</a></li>
<li><a href="#_searching">Searching</a></li>
<li><a href="#_loops">Loops</a></li>
<li><a href="#_exception_debugging">Exception debugging</a></li>
<li><a href="#_exceptions_debugging">Exceptions debugging</a></li>
<li><a href="#_locals">Locals</a></li>
<li><a href="#_stack">Stack</a></li>
<li><a href="#_value_panels">Value panels</a></li>
Expand Down Expand Up @@ -2207,14 +2207,22 @@ <h5 id="_loops"><a class="anchor" href="#_loops"></a><a class="link" href="#_loo
</div>
</div>
<div class="sect4">
<h5 id="_exception_debugging"><a class="anchor" href="#_exception_debugging"></a><a class="link" href="#_exception_debugging">Exception debugging</a></h5>
<h5 id="_exceptions_debugging"><a class="anchor" href="#_exceptions_debugging"></a><a class="link" href="#_exceptions_debugging">Exceptions debugging</a></h5>
<div class="paragraph">
<p>If you are using <em>ClojureStorm</em> you can jump to the last captured exception by evaluating the <code>:ex</code> keyword on your repl. This
will position the debugger right before the exception so you can step backwards and explore the cause.</p>
<p><code>FlowStorm</code> will report all functions that didn&#8217;t return because an exception unwind the stack, even
when that exception was captured further and it didn&#8217;t bubble up.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="user_guide_images/exceptions.png" alt="exceptions">
</div>
</div>
<div class="paragraph">
<p>When an unwind situation is recorded a combobox will show up in the toolbar, containing all the functions names
together with the exceptions types. If you hover the mouse over any of them, a tooltip will display the exception message.</p>
</div>
<div class="paragraph">
<p>If you are using vanilla or using <em>FlowStorm</em> with ClojureScript, most of the time you can accomplish the same by clicking the <code>Step last</code> button
right after the exception happens.</p>
<p>Clicking on any of them will position the stepper at that point in time so you can explore what happened before.</p>
</div>
</div>
<div class="sect4">
Expand Down Expand Up @@ -3587,7 +3595,7 @@ <h3 id="_internals_diagrams_and_documentation"><a class="anchor" href="#_interna
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-29 07:59:08 -0300
Last updated 2024-02-01 11:15:34 -0300
</div>
</div>
</body>
Expand Down
Binary file added docs/user_guide_images/exceptions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit db85e2a

Please sign in to comment.