update source to Ceph Pacific 16.2.2

[ceph.git] / ceph / doc / dev / developer_guide / running-tests-using-teuth.rst

diff --git a/ceph/doc/dev/developer_guide/running-tests-using-teuth.rst b/ceph/doc/dev/developer_guide/running-tests-using-teuth.rst
index c84ba2a3972f768f493efa4c41053fed2a1b0255..492b7790e9e0a3435a484c5293c3e53f0aab7cd1 100644 (file)
--- a/ceph/doc/dev/developer_guide/running-tests-using-teuth.rst
+++ b/ceph/doc/dev/developer_guide/running-tests-using-teuth.rst
@@ -63,9 +63,38 @@ After building is complete, proceed to trigger tests -
    `Pulpito`_ page created for the tests triggered.
 
 Other frequently used/useful options are ``-d`` (or ``--distro``),
-``--distroversion``, ``--filter-out``, ``--timeout``, ``flavor``, ``-rerun``.
-Run ``teuthology-suite --help`` to read description of these and every other
-options available.
+``--distroversion``, ``--filter-out``, ``--timeout``, ``flavor``, ``-rerun``,
+``-l`` (for limiting number of jobs) , ``-n`` (for how many times job would
+run) and ``-e`` (for email notifications). Run ``teuthology-suite --help``
+to read description of these and every other options available.
+
+Testing QA changes (without re-building binaires)
+-------------------------------------------------
+While writing a PR you might need to test your PR repeatedly using teuthology.
+If you are making non-QA changes, you need to follow the standard process of
+triggering builds, waiting for it to finish and then triggering tests and
+wait for the result. But if changes you made are purely changes in qa/,
+you don't need rebuild the binaries. Instead you can test binaries built for
+the ceph-ci branch and instruct ``teuthology-suite`` command to use a separate
+branch for running tests. The separate branch can be passed to the command
+by using ``--suite-repo`` and ``--suite-branch``. Pass the link to the GitHub
+fork where your PR branch exists to the first option and pass the PR branch
+name to the second option.
+
+For example, if you want to make changes in ``qa/`` after testing ``branch-x``
+(of which has ceph-ci branch is ``wip-username-branch-x``) by running
+following command::
+
+    teuthology-suite -v -m smithi -c wip-username-branch-x -s fs -p 50 --filter cephfs-shell
+
+You can make the modifications locally, update the PR branch and then
+trigger tests from your PR branch as follows::
+
+    teuthology-suite -v -m smithi -c wip-username-branch-x -s fs -p 50 --filter cephfs-shell --suite-repo https://github.com/username/ceph --suite-branch branch-x
+
+You can verify if the tests were run using this branch by looking at values
+for the keys ``suite_branch``, ``suite_repo`` and ``suite_sha1`` in the job
+config printed at the very beginning of the teuthology job.
 
 About Suites and Filters
 ------------------------
@@ -96,7 +125,7 @@ to terminate a job::
 
         teuthology-kill -r teuthology-2019-12-10_05:00:03-smoke-master-testing-basic-smithi
 
-Let's call the the argument passed to ``-r`` as test ID. It can be found
+Let's call the argument passed to ``-r`` as test ID. It can be found
 easily in the link to the Pulpito page for the tests you triggered. For
 example, for the above test ID, the link is - http://pulpito.front.sepia.ceph.com/teuthology-2019-12-10_05:00:03-smoke-master-testing-basic-smithi/