Skip to content

Commit 5c73d13

Browse files
Clarifying special case when creating a branch for migration (MetOffice#527)
1 parent 5a7a9dd commit 5c73d13

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

source/WorkingPractices/gh_authorisation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,12 @@ Then configure git locally at the command line:
132132
133133
# create a configuration for allowed signers - this only needs to be done once.
134134
# create a configuration location for git
135-
mkdir ~/.config/git`
136-
# Then< substituting the email you used for the git config (above)
135+
mkdir ~/.config/git
136+
# Then substituting the email you used for the git config (above)
137137
# and your own ssh key (noting that this is linking to the `.pub` public part)
138138
echo "<email_address> $(cat ~/.ssh/<correct-ssh-key.pub>)" > ~/.config/git/allowed-signers
139139
140-
# This assumes a global configuration>
140+
# This assumes a global configuration
141141
# Substitute `git config` for `git config --global` for by-repository configuration
142142
git config --global gpg.format ssh
143143
# Noting that the </path/to/key> is to the private part, and must match
@@ -161,7 +161,7 @@ a branch on Github (on a personal fork), then browse to the commit list.
161161

162162
There should be a green `Verified` label beside each signed commit.
163163

164-
..tip ::
164+
.. tip::
165165

166166
One can retrospectively change commits in a repository, if required, with
167167
`git rebase -i HEAD~<N>` # where <N> is the number of commits back to change

source/WorkingPractices/gh_dev_init.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,14 @@ To create a branch and switch to it from the command line, the syntax is,
192192
git branch <branch_name> <start_point>
193193
git switch <branch_name>
194194
195+
.. tip::
196+
197+
If you're creating a branch to use to
198+
:ref:`migrate an fcm branch <branch_migration>` across to git, you'll need
199+
to branch from either the git_migration tag or the hash that matches your
200+
fcm branch origin. This can be done by filling in `<start_point>` in the
201+
commands above.
202+
195203
Developing a Change
196204
-------------------
197205

0 commit comments

Comments
 (0)