format-patch (doc): clarify --base=auto
What --base=auto tells format-patch is to compute the base commit itself, using the tracking information. It does not make anything track anything. Tighten the phrasing so that it won't be copied and pasted to other places. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Oct 23, 2021 at 14:01 UTC
203eb8381a3351ce4d92456f5f9a6d21ea1d2f6f
1 file changed
+3
-3
Documentation/git-format-patch.txt
+3
-3
@@ -689,10 +689,10 @@ You can also use `git format-patch --base=P -3 C` to generate patches
689
for A, B and C, and the identifiers for P, X, Y, Z are appended at the
690
end of the first message.
691
692
-If set `--base=auto` in cmdline, it will track base commit automatically,
693
-the base commit will be the merge base of tip commit of the remote-tracking
692
+If set `--base=auto` in cmdline, it will automatically compute
693
+the base commit as the merge base of tip commit of the remote-tracking
694
branch and revision-range specified in cmdline.
695
-For a local branch, you need to track a remote branch by `git branch
695
+For a local branch, you need to make it to track a remote branch by `git branch
696
--set-upstream-to` before using this option.
697
698
EXAMPLES