Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename PR remote option to --pr-remote #106

Merged
merged 1 commit into from
Jun 4, 2017
Merged

Rename PR remote option to --pr-remote #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cherry_picker/cherry_picker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ def continue_cherry_pick(self):
@click.command(context_settings=CONTEXT_SETTINGS)
@click.option('--dry-run', is_flag=True,
help="Prints out the commands, but not executed.")
@click.option('--push', 'pr_remote', metavar='REMOTE',
@click.option('--pr-remote', 'pr_remote', metavar='REMOTE',
help='git remote to use for PR branches', default='origin')
@click.option('--abort', 'abort', flag_value=True, default=None,
help="Abort current cherry-pick and clean up branch")
Expand Down
20 changes: 13 additions & 7 deletions cherry_picker/readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Usage (from a cloned CPython directory) ::

cherry_picker [--push REMOTE] [--dry-run] [--status] [--abort/--continue] [--no-push] <commit_sha1> <branches>
cherry_picker [--pr-remote REMOTE] [--dry-run] [--status] [--abort/--continue] [--no-push] <commit_sha1> <branches>


.. contents::
Expand Down Expand Up @@ -43,8 +43,8 @@ cherry-pick branches. Otherwise, `origin` is used for that purpose.

By default, the PR branches used to submit pull requests back to the main
repository are pushed to `origin`. If this is incorrect, then the correct
remote will need be specified using the ``--push`` option (e.g.
``--push pr`` to use a remote named ``pr``).
remote will need be specified using the ``--pr-remote`` option (e.g.
``--pr-remote pr`` to use a remote named ``pr``).


Cherry-picking :snake: :cherries: :pick:
Expand Down Expand Up @@ -77,9 +77,9 @@ Options

::

-- dry-run Dry Run Mode. Prints out the commands, but not executed.
-- push REMOTE Specify the git remote to push into. Default is 'origin'.
-- status Do `git status` in cpython directory.
-- dry-run Dry Run Mode. Prints out the commands, but not executed.
-- pr-remote REMOTE Specify the git remote to push into. Default is 'origin'.
-- status Do `git status` in cpython directory.


Additional options::
Expand Down Expand Up @@ -142,7 +142,7 @@ In case of merge conflicts or errors, the following message will be displayed::
Passing the `--dry-run` option will cause the script to print out all the
steps it would execute without actually executing any of them. For example::

$ cherry_picker --dry-run --push pr 1e32a1be4a1705e34011770026cb64ada2d340b5 3.6 3.5
$ cherry_picker --dry-run --pr-remote pr 1e32a1be4a1705e34011770026cb64ada2d340b5 3.6 3.5
Dry run requested, listing expected command sequence
fetching upstream ...
dry_run: git fetch origin
Expand All @@ -161,6 +161,12 @@ steps it would execute without actually executing any of them. For example::
dry_run: git checkout master
dry_run: git branch -D backport-1e32a1b-3.5

`--pr-remote` option
-----------------

This will generate pull requests through a remote other than ``origin``
(e.g. ``pr``)


`--status` option
-----------------
Expand Down