[Lldb-commits] [lldb] e7db1ae - [lldb/Docs] Elaborate on reproducer testing

[Jonas Devlieghere via lldb-commits]

Author: Jonas Devlieghere
Date: 2020-04-08T20:10:52-07:00
New Revision: e7db1aec3bdb833832056894f5eba2f359a7c384

URL: https://github.com/llvm/llvm-project/commit/e7db1aec3bdb833832056894f5eba2f359a7c384
DIFF: https://github.com/llvm/llvm-project/commit/e7db1aec3bdb833832056894f5eba2f359a7c384.diff

LOG: [lldb/Docs] Elaborate on reproducer testing

Added: 
    

Modified: 
    lldb/docs/resources/reproducers.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/resources/reproducers.rst b/lldb/docs/resources/reproducers.rst
index c20c29892978..3475ad5e7197 100644
--- a/lldb/docs/resources/reproducers.rst
+++ b/lldb/docs/resources/reproducers.rst
@@ -98,25 +98,28 @@ Testing
 
 Reproducers are tested in the following ways:
 
- - Unit tests to cover the generic reproducer infrastructure.
- - Focused test cases in the ``test/Shell/Reproducer`` directory. These tests
-   serve as integration tests for the reproducers infrastructure, as well as
-   doing some sanity checking for basic debugger functionality.
-
-Additional testing is possible:
-
- - It's possible to unconditionally capture reproducers while running the
-   entire test suite by setting the ``LLDB_CAPTURE_REPRODUCER`` environment
-   variable. Assuming the reproducers behave correctly, this can also help to
-   reproduce test failures.
- - It's possible to run the shell tests from a reproducer replay. The
+ - Unit tests to cover the reproducer infrastructure. There are tests for the
+   provider, loader and for the reproducer instrumentation.
+ - Feature specific end-to-end test cases in the ``test/Shell/Reproducer``
+   directory. These tests serve as integration and regression tests for the
+   reproducers infrastructure, as well as doing some sanity checking for basic
+   debugger functionality.
+ - The shell tests can be run against a reproducer replay. The
    ``check-lldb-repro`` target will run the shell test suite twice. First it
    runs the test suite and captures a reproducer for every lldb invocation and
    saves it to a known location based off lldb's arguments and  working
    directory. Then it runs the test suite again, this time replaying the
    reproducers. Certain tests do not fit this paradigm (for example test that
-   check the output of the binary being debugged) and can be skipped by setting
-   ``UNSUPPORTED: lldb-repro`` at the top of the test.
+   check the output of the binary being debugged) and are skipped by marking
+   them as unsupported by adding ``UNSUPPORTED: lldb-repro`` to the top of the
+   test.
+
+Additional testing is possible:
+
+ - It's possible to unconditionally capture reproducers while running the
+   entire test suite by setting the ``LLDB_CAPTURE_REPRODUCER`` environment
+   variable. Assuming no bugs in reproducers, this can also help to reproduce
+   and investigate test failures.
 
 Knows Issues
 ------------