]> git.ipfire.org Git - thirdparty/git.git/commit
am: refer to format-patch in the documentation
authorJunio C Hamano <gitster@pobox.com>
Tue, 21 Mar 2023 17:27:08 +0000 (10:27 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 21 Mar 2023 20:18:45 +0000 (13:18 -0700)
commit9b0c7f308a9a101deea3ddb359d1505d18f3cdba
tree8c99cd6025e5f1ef10e5f16b786594dd66706580
parent73876f4861cd3d187a4682290ab75c9dccadbc56
am: refer to format-patch in the documentation

There were two reasons we didn't do this.  As "git am" is designed
to grok e-mailed patches, not necessarily taken out of a Git
repostiory or even if it came from a Git repository not necessarily
produced with format-patch, we didn't want to single it out as the
"blessed" input producer to the command.  Also, in the original
workflow that "git am" was invented for, the user of "am" was
expected to be a different person than the users of "format-patch".

But this is a very safe change to make in 2023.  Thanks to the
effort by many contributors, Git ended up becoming a bit more
popular than we initially thought it would be, and "format-patch",
which took me a few weeks to pursuade Linus to take in 2005, seems
to have become the de-facto standard tool to produce patch e-mails.

Interestingly, the documentation for "git apply", which is listed in
SEE ALSO section of "git am" documentation, does mention "am" and
"format-patch" as two things that are related but different from
"apply" in an early part.

Suggested-by: Kai Grossjohann <kai.grossjohann@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-am.txt