]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev/developer_guide: mention unit_test_summary.yaml & valgrind.yaml 54209/head
authorVallari Agrawal <val.agl002@gmail.com>
Tue, 31 Oct 2023 08:26:53 +0000 (13:56 +0530)
committerVallari Agrawal <val.agl002@gmail.com>
Tue, 31 Oct 2023 11:37:49 +0000 (17:07 +0530)
In tests-integration-testing-teuthology-workflow.rst,
briefly mention unit_test_summary.yaml and valgrind.yaml
as other files that exist in teuthology archive.

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>
doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-workflow.rst

index 64b006c57fb4602cab6141cdf265204058b36609..6b8877886a7897f331a49b5ced2ef99e21f295b1 100644 (file)
@@ -209,6 +209,14 @@ For example: for the above test ID, the path is::
 
 This method can be used to view the log more quickly than would be possible through a browser.
 
+In addition to teuthology.log, there are other files included for debugging purposes:
+
+* unit_test_summary.yaml: It provides a summary of all unit test failures and 
+  is optionally generated when the ``unit_test_scan`` configuration option is 
+  used in the job's YAML file.
+
+* valgrind.yaml: It summarizes any Valgrind errors that may occur.
+
 .. note:: To access archives more conveniently, ``/a/`` has been symbolically
    linked to ``/ceph/teuthology-archive/``. For instance, to access the previous
    example, we can use something like::