From: Zac Dover Date: Tue, 14 Jun 2022 22:15:33 +0000 (+1000) Subject: doc/dev: s/master/main/ in basic workflow X-Git-Tag: v17.2.6~130^2~85^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=6bd367edda9b248ef04021b2c7cdb5abe85cd8c9;p=ceph.git doc/dev: s/master/main/ in basic workflow This PR changes "master" to "main" in the basic_workflow.rst file. I have even changed "master" to "main" in some terminal output from several years ago. This isn't historically ac- curate, of course, but my hope is that this change will prevent someone in the future from being con- fused about why an antiquated branch name is ref- erred to. Signed-off-by: Zac Dover (cherry picked from commit f5cfc22445a3e454e572873cdcfbc1852a38aa17) --- diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 6bd98ebb4501c..e74917d7d6dd3 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -8,7 +8,7 @@ The following chart illustrates the basic Ceph development workflow: Upstream Code Your Local Environment /----------\ git clone /-------------\ - | Ceph | -------------------------> | ceph/master | + | Ceph | -------------------------> | ceph/main | \----------/ \-------------/ ^ | | | git branch fix_1 @@ -76,7 +76,7 @@ The procedure for making changes to the Ceph repository is as follows: #. Fix the bug - #. :ref:`Synchronize local master with upstream master`. + #. :ref:`Synchronize local main with upstream main`. #. :ref:`Create a bugfix branch` in your local working copy. @@ -166,20 +166,20 @@ Fixing the Bug Synchronizing Local Master with Upstream Master ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In your local git environment, there is a copy of the ``master`` branch in -``remotes/origin/master``. This is called "local master". This copy of the -master branch (https://github.com/your_github_id/ceph.git) is "frozen in time" +In your local git environment, there is a copy of the ``main`` branch in +``remotes/origin/main``. This is called "local main". This copy of the +main branch (https://github.com/your_github_id/ceph.git) is "frozen in time" at the moment that you cloned it, but the upstream repo (https://github.com/ceph/ceph.git, typically abbreviated to ``ceph/ceph.git``) that it was forked from is not frozen in time: the upstream repo is still being updated by other contributors. -Because upstream master is continually receiving updates from other +Because upstream main is continually receiving updates from other contributors, your fork will drift farther and farther from the state of the upstream repo when you cloned it. -You must keep your fork's master branch synchronized with upstream master in -order to reduce drift between your fork's master branch and the upstream master +You must keep your fork's main branch synchronized with upstream main in +order to reduce drift between your fork's main branch and the upstream main branch. Here are the commands for keeping your fork synchronized with the @@ -188,12 +188,12 @@ upstream repository: .. prompt:: bash $ git fetch ceph - git checkout master - git reset --hard ceph/master - git push -u origin master + git checkout main + git reset --hard ceph/main + git push -u origin main -This procedure should be followed often, in order to keep your local ``master`` -in sync with upstream ``master``. +This procedure should be followed often, in order to keep your local ``main`` +in sync with upstream ``main``. .. _bugfix_branch: @@ -204,12 +204,12 @@ Create a branch for your bugfix: .. prompt:: bash $ - git checkout master + git checkout main git checkout -b fix_1 git push -u origin fix_1 -The first command (git checkout master) makes sure that the bugfix branch -"fix_1" is created from the most recent state of the master branch of the +The first command (git checkout main) makes sure that the bugfix branch +"fix_1" is created from the most recent state of the main branch of the upstream repository. The second command (git checkout -b fix_1) creates a "bugfix branch" called @@ -319,7 +319,7 @@ the `Git Commit Good Practice`_ article at the `OpenStack Project Wiki`_. .. _`OpenStack Project Wiki`: https://wiki.openstack.org/wiki/Main_Page See also our own `Submitting Patches -`_ document. +`_ document. After your pull request (PR) has been opened, update the :ref:`issue-tracker` by adding a comment directing other contributors to your PR. The comment can be @@ -388,7 +388,7 @@ see how it behaves on real clusters running 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/ +.. _`ceph/qa sub-directory`: https://github.com/ceph/ceph/tree/main/qa/ .. _`teuthology repository`: https://github.com/ceph/teuthology .. _`teuthology framework`: https://github.com/ceph/teuthology @@ -496,7 +496,7 @@ Another method of generating merge commits involves using Patrick Donnelly's **/ceph/src/script/ptl-tool.py**. Merge commits that have been generated by the **ptl-tool** have the following form:: - Merge PR #36257 into master + Merge PR #36257 into main * refs/pull/36257/head: client: move client_lock to _unmount() client: add timer_lock support