From e3abd2e7c8d8f3d70ad913e13c53d219469ce65b Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sat, 5 Sep 2020 00:24:57 +0800 Subject: [PATCH] doc/dev/developer_guide/tests-unit-tests: use literal "make check" the ``make check`` is better than a hyper link here. Signed-off-by: Kefu Chai --- doc/dev/developer_guide/tests-unit-tests.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/dev/developer_guide/tests-unit-tests.rst b/doc/dev/developer_guide/tests-unit-tests.rst index fdaa1b85a9f..06a9d063dac 100644 --- a/doc/dev/developer_guide/tests-unit-tests.rst +++ b/doc/dev/developer_guide/tests-unit-tests.rst @@ -1,8 +1,8 @@ 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 +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. @@ -14,7 +14,7 @@ What does "make check" mean? After compiling Ceph, the code can be run through a battery of tests covering various aspects of Ceph. For historical reasons, this battery of tests is -often referred to as `make check`_ even though the actual command used to run +often referred to as ``make check`` even though the actual command used to run the tests is now ``ctest``. For inclusion in this battery of tests, a test must: @@ -57,7 +57,7 @@ Unit testing of CLI tools Some of the CLI tools are tested using special files ending with the extension ``.t`` and stored under ``./src/test/cli``. These tests are run using a tool called `cram`_ via a shell script ``./src/test/run-cli-tests``. `cram`_ tests -that are not suitable for `make check`_ may also be run by teuthology using +that are not suitable for ``make check`` may also be run by teuthology using the `cram task`_. .. _`cram`: https://bitheap.org/cram/ -- 2.39.5