]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: update unit test 1 of 7 38133/head
authorZac Dover <zac.dover@gmail.com>
Tue, 17 Nov 2020 13:43:03 +0000 (23:43 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 18 Nov 2020 08:25:05 +0000 (18:25 +1000)
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now 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..c97a94fcad7910002a09eeee6e1bebc1025eadcf 100644 (file)
@@ -1,11 +1,17 @@
 Testing - unit tests
 ====================
 
-Ceph has two types of tests: unit tests (also called ``make check`` tests) and
-integration tests. Strictly speaking, the ``make check`` tests are not "unit
-tests", but rather tests that can be run easily on a single build machine
-after compiling Ceph from source, whereas integration tests require packages
-and multi-machine clusters to run.
+Ceph has two types of tests: 
+
+#. unit tests (also called ``make check`` tests)
+#. integration tests. 
+   
+What are here called ``make check`` tests are not, strictly speaking, "unit
+tests". They are tests that can be easily run on a single-build machine
+after Ceph has been compiled from source. Such ``make check`` tests do
+not require packages or a multi-machine cluster.
+
+Integration tests, however, require packages and multi-machine clusters.
 
 .. _make-check: