diff --git a/devtools/docs/user/debugger/how_to/ignore_a_source/debugger-ignore.png b/devtools/docs/user/debugger/how_to/ignore_a_source/debugger-ignore.png deleted file mode 100644 index 76e154469c1bb..0000000000000 Binary files a/devtools/docs/user/debugger/how_to/ignore_a_source/debugger-ignore.png and /dev/null differ diff --git a/devtools/docs/user/debugger/how_to/ignore_a_source/index.rst b/devtools/docs/user/debugger/how_to/ignore_a_source/index.rst deleted file mode 100644 index ae9f230441999..0000000000000 --- a/devtools/docs/user/debugger/how_to/ignore_a_source/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -=============== -Ignore a source -=============== - -In modern web development, we often rely on libraries like `jQuery `_, `Ember `_, or `Angular `_, and 99% of the time we can safely assume that they “just work”. We don’t care about the internal implementation of these libraries. However, a library’s abstraction leaks during debugging sessions when you are forced to step through its stack frames in order to reach your own code. However, you can tell the debugger to ignore the details of selected sources. - -You can enable or disable ignoring a source file in a couple of ways: - - -- In the :ref:`source list pane `, right-click the filename and choose **Ignore source** (or **Unignore source**). -- If the source file is displayed in the :ref:`source pane `, click the "eye" icon at the bottom. - -.. image:: debugger-ignore.png - :alt: Screenshot showing the context menu item to ignore a source file, and highlighting the "ignore" icon. - :class: border - -When a source file is ignored: - - -- Any breakpoints it may have defined are disabled. -- When “Pause on Exceptions” is enabled in the :ref:`Debugger settings `, the debugger won’t pause when an exception is thrown in the ignored source; instead it waits until (and if) the stack unwinds to a frame in a source that isn’t ignored. -- The debugger skips through ignored sources when stepping. diff --git a/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-line.png b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-line.png new file mode 100644 index 0000000000000..7b3b30eda349b Binary files /dev/null and b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-line.png differ diff --git a/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-lines.png b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-lines.png new file mode 100644 index 0000000000000..a880e26345b08 Binary files /dev/null and b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-lines.png differ diff --git a/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-source.png b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-source.png new file mode 100644 index 0000000000000..38e8e40975ad0 Binary files /dev/null and b/devtools/docs/user/debugger/how_to/ignoring_sources/ignore-source.png differ diff --git a/devtools/docs/user/debugger/how_to/ignoring_sources/index.rst b/devtools/docs/user/debugger/how_to/ignoring_sources/index.rst new file mode 100644 index 0000000000000..fe0ad186f2f65 --- /dev/null +++ b/devtools/docs/user/debugger/how_to/ignoring_sources/index.rst @@ -0,0 +1,54 @@ +================ +Ignoring sources +================ + +In modern web development, we often rely on libraries like `jQuery `_, `Ember `_, or `Angular `_, and 99% of the time we can safely assume that they “just work”. We don’t care about the internal implementation of these libraries. However, a library’s abstraction leaks during debugging sessions when you are forced to step through its stack frames in order to reach your own code. However, you can tell the debugger to ignore the details of selected sources. + +What happens when source(s) or line(s) are ignored: + +- Any breakpoints defined are disabled and are not hit on execution. +- When “Pause on Exceptions” is enabled in the :ref:`Debugger settings `, the debugger won’t pause when an exception is thrown in the ignored source; instead it waits until (and if) the stack unwinds to a frame in a source that isn’t ignored. +- The debugger skips through ignored sources when stepping. +- Any ``debugger`` statements are skipped when stepping. +- Any frames related to the source/line/lines won't be visible in the call stack. + +Ignore a source +**************** + +To enable or disable ignoring a source file: + + +- In the :ref:`source list pane `, right-click the filename and choose **Ignore source** (or **Unignore source**). +- If the source file is displayed in the :ref:`source pane `, click the "crossed out source" icon at the bottom. + +.. image:: ignore-source.png + :alt: Screenshot showing the context menu item to ignore a source file, and highlighting the "ignore" icon. + :width: 1150px + :class: border + + +Ignore a single line +********************** + +To ignore a single line in a source file: + +- When the source file is displayed in the :ref:`source pane `, right-click the content on the specific line and choose **Ignore line** (or **Unignore line**) +- Also right-click on the gutter at the specific line and choose **Ignore line** (or **Unignore line**) + +.. image:: ignore-line.png + :alt: Screenshot showing the context menu item to ignore a single line in source file. + :width: 1150px + :class: border + + +Ignore multiple lines +*********************** + +To ignore multiple lines in a source file: + +- When the source file is displayed in the :ref:`source pane `, select the specific lines, then right-click on the selection and choose **Ignore lines** (or **Unignore lines**) + +.. image:: ignore-lines.png + :alt: Screenshot showing the context menu item to ignore a selection of lines in a source file. + :width: 1150px + :class: border diff --git a/devtools/docs/user/debugger/how_to/index.rst b/devtools/docs/user/debugger/how_to/index.rst index 0bd290243ae83..6e4e1678ec0e4 100644 --- a/devtools/docs/user/debugger/how_to/index.rst +++ b/devtools/docs/user/debugger/how_to/index.rst @@ -9,7 +9,7 @@ These articles describe how to use the debugger. - :doc:`Debug eval sources ` - :doc:`Disable breakpoints ` - :doc:`Highlight and inspect DOM nodes ` -- :doc:`Ignore a source ` +- :doc:`Ignoring sources ` - :doc:`Open the debugger ` - :doc:`Pretty-print a minified file ` - :doc:`Search ` diff --git a/devtools/docs/user/debugger/index.rst b/devtools/docs/user/debugger/index.rst index 6db1e386ff5da..e67ff59412ead 100644 --- a/devtools/docs/user/debugger/index.rst +++ b/devtools/docs/user/debugger/index.rst @@ -50,7 +50,7 @@ Control execution What can you do after execution pauses? - :doc:`Step through code ` -- :doc:`Black box a source ` +- :doc:`Ignoring sources ` - `Debug worker threads `_ - :doc:`Debug eval sources `