From 31842a048acf4ece4b21d6a8474138d649ad735c Mon Sep 17 00:00:00 2001 From: Lumir Sliva Date: Sun, 29 Mar 2026 00:43:27 +0100 Subject: [PATCH] doc: fix typos and outdated refs across developer guide Fix 'elipsis' to 'ellipsis' in SubmittingPatches.rst, update outdated 'master' branch references to 'main' in essentials.rst and running-tests-locally.rst, fix 'sometime' to 'sometimes' in merging.rst, and remove duplicated word in teuthology-intro.rst. Signed-off-by: Lumir Sliva --- SubmittingPatches.rst | 4 ++-- doc/dev/developer_guide/essentials.rst | 2 +- doc/dev/developer_guide/merging.rst | 2 +- doc/dev/developer_guide/running-tests-locally.rst | 6 +++--- .../tests-integration-testing-teuthology-intro.rst | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index 5869bba81422..ad8211b3f53a 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -214,9 +214,9 @@ the following difference: the PR title describes the entire set of changes, while the `Commit title`_ describes only the changes in a particular commit. If GitHub suggests a PR title based on a very long commit message it will split -the result with an elipsis (...) and fold the remainder into the PR description. +the result with an ellipsis (...) and fold the remainder into the PR description. In such a case, please edit the title to be more concise and the description to -remove the elipsis. +remove the ellipsis. Keep in mind that the PR titles feed directly into the script that generates release notes and it is tedious to clean up non-conformant PR titles at release diff --git a/doc/dev/developer_guide/essentials.rst b/doc/dev/developer_guide/essentials.rst index 230b1e81d826..c51219099975 100644 --- a/doc/dev/developer_guide/essentials.rst +++ b/doc/dev/developer_guide/essentials.rst @@ -35,7 +35,7 @@ terms of the LGPL2.1 or LGPL3.0. For full details, see the file `COPYING`_ in the top-level directory of the source-code tree. .. _`COPYING`: - https://github.com/ceph/ceph/blob/master/COPYING + https://github.com/ceph/ceph/blob/main/COPYING Source code repositories ------------------------ diff --git a/doc/dev/developer_guide/merging.rst b/doc/dev/developer_guide/merging.rst index 7e41bd483d44..7821d548f60b 100644 --- a/doc/dev/developer_guide/merging.rst +++ b/doc/dev/developer_guide/merging.rst @@ -111,7 +111,7 @@ What ? ^^^^^^ * Bug fixes -* Features are sometime accepted +* Features are sometimes accepted * Commits should be cherry-picked from *main* when possible * Commits that are not cherry-picked from *main* must pertain to a bug unique to the stable release diff --git a/doc/dev/developer_guide/running-tests-locally.rst b/doc/dev/developer_guide/running-tests-locally.rst index f8d84efa67a9..6a9b3e1faaa1 100644 --- a/doc/dev/developer_guide/running-tests-locally.rst +++ b/doc/dev/developer_guide/running-tests-locally.rst @@ -188,7 +188,7 @@ To run a workunit (e.g ``mon/osd.sh``) do the following:: $ ./qa/workunits/mon/osd.sh -.. _test_reconnect_timeout: https://github.com/ceph/ceph/blob/master/qa/tasks/cephfs/test_client_recovery.py#L133 -.. _TestClientRecovery: https://github.com/ceph/ceph/blob/master/qa/tasks/cephfs/test_client_recovery.py#L86 +.. _test_reconnect_timeout: https://github.com/ceph/ceph/blob/main/qa/tasks/cephfs/test_client_recovery.py#L133 +.. _TestClientRecovery: https://github.com/ceph/ceph/blob/main/qa/tasks/cephfs/test_client_recovery.py#L86 .. _teuthology: https://github.com/ceph/teuthology -.. _vstart_runner.py: https://github.com/ceph/ceph/blob/master/qa/tasks/vstart_runner.py +.. _vstart_runner.py: https://github.com/ceph/ceph/blob/main/qa/tasks/vstart_runner.py diff --git a/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-intro.rst b/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-intro.rst index 9fa95118a161..e97911c3e4ef 100644 --- a/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-intro.rst +++ b/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-intro.rst @@ -40,7 +40,7 @@ nightlies" because the Ceph core developers used to live and work in the same time zone and from their perspective the tests were run overnight. The results of nightly test runs are published at http://pulpito.ceph.com/ -under the user ``teuthology``. The developer nick appears in URL of the the +under the user ``teuthology``. The developer nick appears in URL of the test results and in the first column of the Pulpito dashboard. The results are also reported on the `ceph-qa mailing list `_. -- 2.47.3