summaryrefslogtreecommitdiffstats
path: root/devtools/docs/user/debugger/how_to/step_through_code/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'devtools/docs/user/debugger/how_to/step_through_code/index.rst')
-rw-r--r--devtools/docs/user/debugger/how_to/step_through_code/index.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/devtools/docs/user/debugger/how_to/step_through_code/index.rst b/devtools/docs/user/debugger/how_to/step_through_code/index.rst
new file mode 100644
index 0000000000..85d4c5c325
--- /dev/null
+++ b/devtools/docs/user/debugger/how_to/step_through_code/index.rst
@@ -0,0 +1,42 @@
+=================
+Step through code
+=================
+
+When the debugger is stopped at a breakpoint, you can step through it using four buttons in the :ref:`toolbar <debugger-ui-tour-toolbar>`:
+
+.. image:: breakpoint_toolbar.png
+
+In order, the buttons are:
+
+
+- Play: run to the next breakpoint
+- Step over: advance to the next line in the same function.
+- Step in: advance to the next line in the function, unless on a function call, in which case enter the function being called
+- Step out: run to the end of the current function, in which case, the debugger will skip the return value from a function, returning execution to the caller
+
+
+Split console
+*************
+
+When paused, you can press the Esc key to open and close the split console to gain more insight into errors and variables:
+
+.. image:: split_console.png
+ :class: border
+
+
+Pause on breakpoints overlay
+****************************
+
+Since Firefox 70, when your code is paused on a breakpoint an overlay appears on the viewport of the tab you are debugging.
+
+.. image:: debugger-overlay.png
+ :alt: border
+
+
+This lets you know what kind of breakpoint the code is paused on (breakpoint, event breakpoint, etc.), and also provides a step button and a play button. The thinking here is that if you've got your DevTools open in a separate window, as many people do, it can be easier to have the buttons available right there to move the code forward while you are looking at the result.
+
+
+Inline variable preview
+***********************
+
+New in Firefox 71, the :ref:`source pane <debugger_ui_tour_source_pane>` now gives you an instant preview of the variables on each line of code you've stepped through. See :ref:`Set a breakpoint > Inline variable preview <debugger-how-to-set-a-breakpoint-variable-preview>` for more information.