docs: document that git push --deleted only pushes tracked branches

It tries to push all deleted branches, but can only succeed for tracked
branches.

Closes #2946, as there's probably no need to have `--deleted --tracked`
that would only be different in that the warnings wouldn't be printed.
Thanks to @yuja for pointing this out.
This commit is contained in:
Ilya Grigoriev 2024-02-05 20:12:58 -08:00
parent 8fb790118f
commit b20e7ee095

View file

@ -212,15 +212,16 @@ pub struct GitPushArgs {
/// This usually means that the branch was already pushed to or fetched from
/// the relevant remote. For details, see
/// https://martinvonz.github.io/jj/latest/branches#remotes-and-tracked-branches
///
/// Not yet implemented, TODO(#2946): `jj git push --tracked --deleted`
/// would make sense, but is not currently allowed.
#[arg(long)]
tracked: bool,
/// Push all branches (including deleted branches)
#[arg(long)]
all: bool,
/// Push all deleted branches
///
/// Only tracked branches can be successfully deleted on the remote. A
/// warning will be printed if any untracked branches on the remote
/// correspond to missing local branches.
#[arg(long)]
deleted: bool,
/// Push branches pointing to these commits