Skip to content

Commit dcc7fd6

Browse files
update howtocommit
1 parent 26dc7d6 commit dcc7fd6

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

source/Reviewers/howtocommit.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ are more complicated conflicts ask the developer to solve them themselves. If
5151
there are conflicts in versions.py then see the details in the macro section
5252
below.
5353

54-
Then checkout the up to date branch, eg.
54+
Then switch to the up to date branch, eg.
5555

5656
.. code-block::
5757
@@ -130,7 +130,7 @@ rose-stem app then you will need to upgrade the test-suite.
130130

131131
.. note::
132132

133-
All LFRic Core tickets with macros are expected to be linked with LFRic Apps, though they may not have required an LFRic Apps development branch (although an Apps ticket should be provided). This is fine - if there is no LFRic Apps branch just checkout the LFRic Apps trunk. Then run the apply_macros script as described above and this will share the upgrade macro across both LFRic Apps and LFRic Core as needed.
133+
All LFRic Core tickets with macros are expected to be linked with LFRic Apps, though they may not have required an LFRic Apps development branch (although an Apps ticket should be provided). This is fine - if there is no LFRic Apps branch just checkout the LFRic Apps main. Then run the apply_macros script as described above and this will share the upgrade macro across both LFRic Apps and LFRic Core as needed.
134134

135135
.. important::
136136

@@ -283,7 +283,7 @@ are no clashes with what else has gone on trunk.
283283
.. code-block:: RST
284284
285285
git pull
286-
git checkout <branch name>
286+
git switch <branch name>
287287
cd <path_to>/user_guide/doc
288288
conda activate jules-user-guide
289289
make html

source/WorkingPractices/forking.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ Most work to maintain a fork involves syncing it with the upstream repository. S
9494

9595
.. code-block::
9696
97-
# Checkout the desired branch
98-
git checkout main
97+
# Change to the desired branch
98+
git switch main
9999
100100
# Merge in changes from the upstream
101101
git merge upstream/main

source/WorkingPractices/gh_dev_init.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ There is no requirement to open an issue before making a pull request, as long a
4141
Clone the Repository
4242
--------------------
4343

44-
A clone is a local copy of a repository - you can have a local clone of either an upstream repository or a fork. A clone will have an active branch which will initially be the default branch of the repository. All other branches in the repository can be accessed using the ``checkout`` command (see below). For general development, you should now get a clone of your fork.
44+
A clone is a local copy of a repository - you can have a local clone of either
45+
an upstream repository or a fork. A clone will have an active branch which will
46+
initially be the default branch of the repository. All other branches in the repository can be accessed using the ``switch`` command (see below). For general development, you should now get a clone of your fork.
4547

4648
.. tip::
4749

@@ -122,13 +124,13 @@ To create a branch and switch to it from the command line, the syntax is,
122124
.. code-block::
123125
124126
# parent_branch will default to the current branch if not provided
125-
# switch will automatically checkout the newly created branch
127+
# switch will automatically change to the newly created branch
126128
git switch -c <branch_name> [<parent_branch>]
127129
128130
# Or
129131
130132
git branch <branch_name> <source_branch>
131-
git checkout <branch_name>
133+
git switch <branch_name>
132134
133135
Developing a Change
134136
-------------------

0 commit comments

Comments
 (0)