doc/dev: update auto pr validation section

This commit updates the "Automated PR Validation"
section of the "Basic Workflow" page in the
Developer Guide. This is part of a project that
aims to clean all of the sentences currently extant
in the Dev Guide, prior to a slight reorganization
of that guide for the sake of clarity and simplicity.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst
index 1dfb0029d3d076bd4142c585573bdb83c0991642..1a387a94e1850eef7bcd35f4f0009d479ba7d8fb 100644 (file)
--- a/doc/dev/developer_guide/basic-workflow.rst
+++ b/doc/dev/developer_guide/basic-workflow.rst
@@ -221,21 +221,25 @@ as simple as::
 Automated PR validation
 -----------------------
 
-When your PR is created or updated, the Ceph project's `Continuous Integration
+When you create or update your PR, the Ceph project's `Continuous Integration
 (CI) <https://en.wikipedia.org/wiki/Continuous_integration>`_ infrastructure
-will test it automatically. At the time of this writing (September 2020), the
-automated CI testing included five tests to check that the commits in the PR
-are properly signed (see :ref:`submitting-patches`), to check that the
-documentation builds, to check that the submodules are unmodified, to check
-that the API is in order, and a :ref:`make-check` test.  Additional tests may
-be performed depending on which files are modified by your PR.
-
-The :ref:`make-check`, builds the PR and runs it through a battery of
+automatically tests it. At the time of this writing (September 2020), the
+automated CI testing included five tests: 
+
+#. a test to check that the commits are properly signed (see :ref:`submitting-patches`): 
+#. a test to check that the documentation builds
+#. a test to check that the submodules are unmodified
+#. a test to check that the API is in order
+#. a :ref:`make check<make-check>` test  
+   
+Additional tests may be performed depending on which files your PR modifies.
+
+The :ref:`make check<make-check>` test builds the PR and runs it through a battery of
 tests. These tests run on servers operated by the Ceph Continuous
 Integration (CI) team. When the tests complete, the result will be shown
 on GitHub in the pull request itself.
 
-You can (and should) also test your modifications before you open a PR.
+You should test your modifications before you open a PR.
 Refer to the chapters on testing for details.
 
 Notes on PR make check test

diff --git a/doc/dev/developer_guide/tests-unit-tests.rst b/doc/dev/developer_guide/tests-unit-tests.rst
index 6327b969674300ec7292e13b493b762ba7bb1f68..2863a8f7f9a56ac9712804991a8f9f5d809a2a05 100644 (file)
--- a/doc/dev/developer_guide/tests-unit-tests.rst
+++ b/doc/dev/developer_guide/tests-unit-tests.rst
@@ -33,9 +33,11 @@ framework`_.
 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::
+the Ceph source tree by invoking:
 
-.. prompt:: bash $
+  .. 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