]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: refine basic-workflow.rst integ. test 46305/head
authorZac Dover <zac.dover@gmail.com>
Tue, 17 May 2022 15:16:16 +0000 (01:16 +1000)
committerZac Dover <zac.dover@gmail.com>
Tue, 17 May 2022 18:08:05 +0000 (04:08 +1000)
This is one in a set of PRs meant to keep the Basic
Workflow in the Developer guide current. It refines
the English in the "Integration Tests AKA ceph-qa-suite"
section of "Basic Workflow".

Several other small updates like this are expected. I
intend to avoid refining half of the page in one commit,
as I did last month when I refined the first half of the
basic workflow.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/developer_guide/basic-workflow.rst

index 1647983d47d6b446508d4bd1c718cb9d158933e3..8f91c2021da63f81164c05b0e249014be4b5ca41 100644 (file)
@@ -383,9 +383,8 @@ determine the cause of your specific failure.
 Integration tests AKA ceph-qa-suite
 -----------------------------------
 
-Since Ceph is complex, it may be necessary to test your fix to
-see how it behaves on real clusters running on physical or virtual
-hardware. Tests designed for this purpose live in the `ceph/qa
+It may be necessary to test your fix on real Ceph clusters that run on physical
+or virtual hardware. Tests designed for this purpose live in the `ceph/qa
 sub-directory`_ and are run via the `teuthology framework`_.
 
 .. _`ceph/qa sub-directory`: https://github.com/ceph/ceph/tree/master/qa/
@@ -395,10 +394,12 @@ sub-directory`_ and are run via the `teuthology framework`_.
 The Ceph community has access to the `Sepia lab
 <https://wiki.sepia.ceph.com/doku.php>`_ where `integration tests`_ can be run
 on physical hardware.
-Other developers may add tags like "needs-qa" to your PR.  This allows PRs that
-need testing to be merged into a single branch and tested all at the same time.
-Since teuthology suites can take hours (even days in some cases) to run, this
-can save a lot of time.
+
+Other contributors might add tags like `needs-qa` to your PR. This allows PRs
+to be merged into a single branch and then efficiently tested together.
+Teuthology test suites can take hours (and even days in some cases) to
+complete, so batching tests reduces contention for resources and saves a lot of
+time.
 
 To request access to the Sepia lab, start `here
 <https://wiki.sepia.ceph.com/doku.php?id=vpnaccess>`_.