]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Merge branch 'master' into anthonyeleven/docs-46367 38091/head
authorAnthony D'Atri <anthonyeleven@users.noreply.github.com>
Tue, 24 Nov 2020 20:27:31 +0000 (12:27 -0800)
committerGitHub <noreply@github.com>
Tue, 24 Nov 2020 20:27:31 +0000 (12:27 -0800)
1  2 
doc/dev/developer_guide/tests-unit-tests.rst

index ddbee16dfc37311b70f8995520f5ece93aeb8b48,8c7cff8f92af0f2fc43c8f2fe9a558bee8380c5c..6327b969674300ec7292e13b493b762ba7bb1f68
@@@ -13,33 -18,37 +13,36 @@@ run
  What does "make check" mean?
  ----------------------------
  
 -After Ceph has been compiled, its code can be run through a battery of
 -tests that cover 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 the tests is now ``ctest``. In order to be
 -included in this battery of tests, a test must:
 +After compiling Ceph, the code can be run through a battery of tests
 +For historical reasons, this is
 +often referred to as ``make check`` even though the actual command used to run
 +the tests is now ``ctest``. For inclusion in this group of tests, a test
 +must:
 +
  * bind ports that do not conflict with other tests
  * not require root access
  * not require more than one machine to run
  * complete within a few minutes
  
- For simplicity, we will refer to this class of tests as "make check tests" or
- "unit tests", to distinguish them from the more complex "integration tests"
- that are run via the `teuthology framework`_.
+ For the sake of simplicity, this class of tests is referred to as "make
+ check tests" or "unit tests". This is meant to distinguish these tests from
+ the more complex "integration tests" that are run via the `teuthology
+ framework`_.
  
 -While it is possible to run ``ctest`` directly, it can be tricky to
 -correctly set up your environment for it. Fortunately, a script is provided
 -to make it easier to run the unit tests on your code. This script can be
 -run from the top-level directory of the Ceph source tree by running the
 -following command:
 +While it is possible to run ``ctest`` directly, it can be tricky to correctly
 +set up your environment. Fortunately, a script is provided to make it easier
 +run the unit tests on your code. It can be run from the top-level directory of
 +the Ceph source tree by invoking::
  
-     $ ./run-make-check.sh
+ .. prompt:: bash $
  
 -   ./run-make-check.sh
 +You will need a minimum of 8GB of RAM and 32GB of free drive space for this
 +command to complete successfully on x86_64; other architectures may have
- different requirements. Depending on your hardware, it can take from twendy
++different requirements. Depending on your hardware, it can take from twenty
 +minutes to three hours to complete, but it's worth the wait.
  
 -You will need a minimum of 8GB of RAM and 32GB of free disk space for this
 -command to complete successfully on x86_64 (other architectures may have
 -different constraints). Depending on your hardware, it can take from 20
 -minutes to three hours to complete.
  How unit tests are declared
  ---------------------------