cli: git: mention git.private-commits in --allow-private help text
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-24.04) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run

Since the set is empty by default, --allow-private is noop unless the private
revset is configured by user. Let's clarify that.
This commit is contained in:
Yuya Nishihara 2025-01-14 21:21:03 +09:00
parent d0f44e8350
commit d00c02fb07
2 changed files with 6 additions and 0 deletions

View file

@ -131,6 +131,10 @@ pub struct GitPushArgs {
#[arg(long)]
allow_empty_description: bool,
/// Allow pushing commits that are private
///
/// The set of private commits can be configured by the
/// `git.private-commits` setting. The default is `none()`, meaning all
/// commits are eligible to be pushed.
#[arg(long)]
allow_private: bool,
/// Push bookmarks pointing to these commits (can be repeated)

View file

@ -1173,6 +1173,8 @@ Before the command actually moves, creates, or deletes a remote bookmark, it mak
Newly-created remote bookmarks will be tracked automatically.
* `--allow-empty-description` — Allow pushing commits with empty descriptions
* `--allow-private` — Allow pushing commits that are private
The set of private commits can be configured by the `git.private-commits` setting. The default is `none()`, meaning all commits are eligible to be pushed.
* `-r`, `--revisions <REVSETS>` — Push bookmarks pointing to these commits (can be repeated)
* `-c`, `--change <REVSETS>` — Push this commit by creating a bookmark based on its change ID (can be repeated)