docs/detailed_test_config: document "archive-on-error" option

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/docs/detailed_test_config.rst b/docs/detailed_test_config.rst
index 50ae910a91f16313655fa732927898d5f59a0228..42b17f1f359dfe238d3fe868cb73ecefc33c5b93 100644 (file)
--- a/docs/detailed_test_config.rst
+++ b/docs/detailed_test_config.rst
@@ -227,6 +227,21 @@ global option can be set to true to make the unlocking happen unconditionally.
 Troubleshooting
 ===============
 
+Postmortem Debugging
+--------------------
+
+After completion of a test, the ``archive`` subdirectory is archived under
+the corresponding ``remote`` subdirectory. We can disable this behavior
+using the top-level configuration, like::
+
+  archive-on-error: true
+
+If ``archive-on-error`` is ``true``, the ``archive`` subdirectory is
+archived only for failed tests.
+
+
+Situ Debugging
+--------------
 Sometimes when a bug triggers, instead of automatic cleanup, you want
 to explore the system as is. Adding a top-level::