Skip to content

Commit f09b0fd

Browse files
committed
Document new matching branch names
1 parent 5a7efe8 commit f09b0fd

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

cherry_picker/readme.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@ Usage (from a cloned CPython directory) ::
1111
About
1212
=====
1313

14-
Use this to backport CPython changes from ``master`` into one or more of the
15-
maintenance branches (``3.6``, ``3.5``, ``2.7``).
14+
Use this to backport changes from the main branch of your project into one or
15+
more of the maintenance branches (``3.6``, ``3.5``, ``2.7``, ``stable-2.6``,
16+
``2.5-lts``).
17+
The main requirement is that the target branches should contain some sort of
18+
version number, which is at least two numbers separated by a dot.
19+
20+
This tool is used to backport CPython changes from ``master`` into one or more
21+
of the maintenance branches (``3.6``, ``3.5``, ``2.7``).
1622

1723
It will prefix the commit message with the branch, e.g. ``[3.6]``, and then
1824
opens up the pull request page.
@@ -142,8 +148,12 @@ To customize the tool for used by other project:
142148
by ``pip install cherry_picker``
143149

144150
5. Now everything is ready, use ``cherry_picker <commit_sha> <branch1>
145-
<branch2>`` for cherry-picking changes from ``<commit_sha`` into
151+
<branch2>`` for cherry-picking changes from ``<commit_sha>`` into
146152
maintenance branches.
153+
Branch name should contain at least major and minor version numbers
154+
and may have some prefix or suffix.
155+
Only the first version-like substring is matched when the version
156+
is extracted from branch name.
147157

148158
Demo
149159
----

0 commit comments

Comments
 (0)