]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: update unit test declaration 38150/head
authorZac Dover <zac.dover@gmail.com>
Wed, 18 Nov 2020 08:56:14 +0000 (18:56 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 18 Nov 2020 15:13:37 +0000 (01:13 +1000)
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/developer_guide/tests-unit-tests.rst

index 06a9d063dac3e8a764308387a2aafc5e58f5f4c9..5347f3ad6c11f35bf612e61a224c9f476a54515b 100644 (file)
@@ -43,13 +43,17 @@ minutes to three hours to complete, but it's worth the wait.
 How unit tests are declared
 ---------------------------
 
-Unit tests are declared in the ``CMakeLists.txt`` files (multiple files under
-``./src``) using the ``add_ceph_test`` or ``add_ceph_unittest`` CMake
-functions, which are themselves defined in
-``./cmake/modules/AddCephTest.cmake``. Some unit tests are scripts, while
-others are binaries that are compiled during the build process.  The
-``add_ceph_test`` function is used to declare unit test scripts, while
-``add_ceph_unittest`` is used for unit test binaries.
+Unit tests are declared in the ``CMakeLists.txt`` file, which is found
+in the ``./src`` directory. The ``add_ceph_test`` and 
+``add_ceph_unittest`` CMake functions are used to declare unit tests.
+``add_ceph_test`` and ``add_ceph_unittest`` are themselves defined in
+``./cmake/modules/AddCephTest.cmake``. 
+
+Some unit tests are scripts and other unit tests are binaries that are
+compiled during the build process.  
+
+* - ``add_ceph_test`` function - used to declare unit test scripts 
+* - ``add_ceph_unittest`` function - used for unit test binaries
 
 Unit testing of CLI tools
 -------------------------