gian/ceph-mirror
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2026-08-02 07:03:18 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: fix typos and outdated refs across developer guide

Browse Source 
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 <lumir.sliva@firma.seznam.cz>
This commit is contained in:
Lumir Sliva 2026-03-29 00:43:27 +01:00
parent 1c9155c940
commit 31842a048a
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
SubmittingPatches.rst
View File

@ -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. 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 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 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 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 release notes and it is tedious to clean up non-conformant PR titles at release

2
doc/dev/developer_guide/essentials.rst
View File

@ -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`_ in the top-level directory of the source-code tree.
.. _`COPYING`: .. _`COPYING`:
https://github.com/ceph/ceph/blob/master/COPYING https://github.com/ceph/ceph/blob/main/COPYING
Source code repositories Source code repositories
------------------------ ------------------------

2
doc/dev/developer_guide/merging.rst
View File

@ -111,7 +111,7 @@ What ?
^^^^^^ ^^^^^^
* Bug fixes * Bug fixes
* Features are sometime accepted * Features are sometimes accepted
* Commits should be cherry-picked from *main* when possible * Commits should be cherry-picked from *main* when possible
* Commits that are not cherry-picked from *main* must pertain to a bug unique to * Commits that are not cherry-picked from *main* must pertain to a bug unique to
the stable release the stable release

6
doc/dev/developer_guide/running-tests-locally.rst
View File

@ -188,7 +188,7 @@ To run a workunit (e.g ``mon/osd.sh``) do the following::
$ ./qa/workunits/mon/osd.sh $ ./qa/workunits/mon/osd.sh
.. _test_reconnect_timeout: https://github.com/ceph/ceph/blob/master/qa/tasks/cephfs/test_client_recovery.py#L133 .. _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/master/qa/tasks/cephfs/test_client_recovery.py#L86 .. _TestClientRecovery: https://github.com/ceph/ceph/blob/main/qa/tasks/cephfs/test_client_recovery.py#L86
.. _teuthology: https://github.com/ceph/teuthology .. _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

2
doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-intro.rst
View File

@ -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 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/ 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 test results and in the first column of the Pulpito dashboard. The results are
also reported on the `ceph-qa mailing list <https://ceph.com/irc/>`_. also reported on the `ceph-qa mailing list <https://ceph.com/irc/>`_.