diff --git a/readme.rst b/readme.rst index 2aa63e1..412984f 100644 --- a/readme.rst +++ b/readme.rst @@ -1,6 +1,6 @@ Usage (from a cloned CPython directory) :: - cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--status] [--abort/--continue] [--push/--no-push] + cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--status] [--abort/--continue] [--push/--no-push] [--auto-pr/--no-auto-pr] |pyversion status| |pypi status| @@ -69,7 +69,7 @@ From the cloned CPython directory: :: - (venv) $ cherry_picker [--pr-remote REMOTE] [--dry-run] [--config-path CONFIG-PATH] [--abort/--continue] [--status] [--push/--no-push] + (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 @@ -100,6 +100,8 @@ Additional options:: --abort Abort current cherry-pick and clean up branch --continue Continue cherry-pick, push, and clean up branch --no-push Changes won't be pushed to remote + --no-auto-pr PR creation page won't be automatically opened in the web browser or + if GH_AUTH is set, the PR won't be automatically opened through API. --config-path Path to config file (`.cherry_picker.toml` from project root by default) @@ -269,6 +271,14 @@ cherry-pick additional commits, by:: $ git cherry-pick -x +`--no-auto-pr` option +--------------------- + +PR creation page won't be automatically opened in the web browser or +if GH_AUTH is set, the PR won't be automatically opened through API. +This can be useful if your terminal is not capable of opening a useful web browser, +or if you use cherry-picker with a different Git hosting than GitHub. + `--config-path` option ----------------------