8000 DOC: minor tweaks to manual backport instructions · matplotlib/matplotlib@6ea6958 · GitHub
[go: up one dir, main page]

Skip to content
Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 6ea6958

Browse files
committed
DOC: minor tweaks to manual backport instructions
1 parent 922c950 commit 6ea6958

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

doc/devel/coding_guide.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,26 @@ We do a backport from master to v2.2.x assuming:
148148

149149
The ``TARGET_SHA`` is the hash of the merge commit you would like to
150150
backport. This can be read off of the github PR page (in the UI with
151-
the merge notification) or through the git CLI tools.::
151+
the merge notification) or through the git CLI tools.
152152

153-
git fetch matplotlib
154-
git checkout v2.2.x
155-
git merge --ff-only matplotlib/v2.2.x
153+
Assuming that you already have a local branch ``v2.2.x`` (if not, then
154+
``git checkout -b v2.2.x``), and that your remote pointing to
155+
``https://github.com/matplotlib/matplotlib`` is called ``upstream``::
156+
157+
git fetch upstream
158+
git checkout v2.2.x # or include -b if you don't already have this.
159+
git reset --hard upstream/v2.2.x
156160
git cherry-pick -m 1 TARGET_SHA
157161
# resolve conflicts and commit if required
158162

159-
Use your discretion to push directly to upstream or to open a PR.
163+
Files with conflicts can be listed by `git status`,
164+
and will have to be fixed by hand (search on ``>>>>>``). Once
165+
the conflict is resolved, you will have to re-add the file(s) to the branch
166+
and make a commit::
167+
168+
git add lib/matplotlib/conflicted_file.py
169+
git add lib/matplotlib/conflicted_file2.py
170+
git commit -m "Backport PR #XXXX: TITLE OF PR"
171+
172+
Use your discretion to push directly to upstream or to open a PR; be
173+
sure to push or PR against the `v2.2.x` upstream branch, not `master`!

0 commit comments

Comments
 (0)
0