kastiglione created this revision.
kastiglione added reviewers: JDevlieghere, jingham.
kastiglione requested review of this revision.
Herald added a project: LLDB.
Herald added a subscriber: lldb-commits.
Debugging tests sometimes involves debugging the Python source. This adds a
paragraph to
the "Debugging Test Failures" section about using `pdb`, and also describes how
to run
lldb commands from pdb.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D99744
Files:
lldb/docs/resources/test.rst
Index: lldb/docs/resources/test.rst
===================================================================
--- lldb/docs/resources/test.rst
+++ lldb/docs/resources/test.rst
@@ -373,7 +373,20 @@
-----------------------
On non-Windows platforms, you can use the ``-d`` option to ``dotest.py`` which
-will cause the script to wait for a while until a debugger is attached.
+will cause the script to print out the pid of the test and wait for a while
+until a debugger is attached. Then run ``lldb -p <pid>`` to attach.
+
+To instead debug a test's python source, edit the test and insert
+``import pdb; pdb.set_trace()`` at the point you want to start debugging. In
+addition to pdb's debugging facilities, lldb commands can be executed with the
+help of an lldb alias. For example ``lldb bt`` and ``lldb v some_var``. Add
+this line to your ``~/.pdbrc``:
+
+::
+
+alias lldb self.dbg.HandleCommand("%*")
+
+::
Debugging Test Failures on Windows
``````````````````````````````````
Index: lldb/docs/resources/test.rst
===================================================================
--- lldb/docs/resources/test.rst
+++ lldb/docs/resources/test.rst
@@ -373,7 +373,20 @@
-----------------------
On non-Windows platforms, you can use the ``-d`` option to ``dotest.py`` which
-will cause the script to wait for a while until a debugger is attached.
+will cause the script to print out the pid of the test and wait for a while
+until a debugger is attached. Then run ``lldb -p <pid>`` to attach.
+
+To instead debug a test's python source, edit the test and insert
+``import pdb; pdb.set_trace()`` at the point you want to start debugging. In
+addition to pdb's debugging facilities, lldb commands can be executed with the
+help of an lldb alias. For example ``lldb bt`` and ``lldb v some_var``. Add
+this line to your ``~/.pdbrc``:
+
+::
+
+alias lldb self.dbg.HandleCommand("%*")
+
+::
Debugging Test Failures on Windows
``````````````````````````````````
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
