Skip to content

Commit 743ec5b

Browse files
authored
Add missing documentation for --no-auto-pr (#47)
1 parent 6b302ad commit 743ec5b

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

readme.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Usage (from a cloned CPython directory) ::
22

3-
cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--status] [--abort/--continue] [--push/--no-push] <commit_sha1> <branches>
3+
cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--status] [--abort/--continue] [--push/--no-push] [--auto-pr/--no-auto-pr] <commit_sha1> <branches>
44

55
|pyversion status|
66
|pypi status|
@@ -69,7 +69,7 @@ From the cloned CPython directory:
6969

7070
::
7171

72-
(venv) $ cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--abort/--continue] [--status] [--push/--no-push] <commit_sha1> <branches>
72+
(venv) $ cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--abort/--continue] [--status] [--push/--no-push] [--auto-pr/--no-auto-pr] <commit_sha1> <branches>
7373

7474

7575
Commit sha1
@@ -100,6 +100,8 @@ Additional options::
100100
--abort Abort current cherry-pick and clean up branch
101101
--continue Continue cherry-pick, push, and clean up branch
102102
--no-push Changes won't be pushed to remote
103+
--no-auto-pr PR creation page won't be automatically opened in the web browser or
104+
if GH_AUTH is set, the PR won't be automatically opened through API.
103105
--config-path Path to config file
104106
(`.cherry_picker.toml` from project root by default)
105107

@@ -269,6 +271,14 @@ cherry-pick additional commits, by::
269271

270272
$ git cherry-pick -x <commit_sha1>
271273

274+
`--no-auto-pr` option
275+
---------------------
276+
277+
PR creation page won't be automatically opened in the web browser or
278+
if GH_AUTH is set, the PR won't be automatically opened through API.
279+
This can be useful if your terminal is not capable of opening a useful web browser,
280+
or if you use cherry-picker with a different Git hosting than GitHub.
281+
272282
`--config-path` option
273283
----------------------
274284

0 commit comments

Comments
 (0)