]> git.ipfire.org Git - thirdparty/git.git/commit
doc: patch-id: add script example
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Sat, 14 Feb 2026 11:55:42 +0000 (12:55 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 17 Feb 2026 18:49:51 +0000 (10:49 -0800)
commit795d41db1304cdba06361916fa64f93c44678228
treecc188bcfd8f26c56813595bfe2f40adba070c076
parentbfd125f64f86e78894d67c9eafdbae38779484bc
doc: patch-id: add script example

The utility and usability of git-patch-id(1) was discussed
relatively recently:[1]

    Using "git patch-id" is definitely in the "write a script for it"
    category. I don't think I've ever used it as-is from the command
    line as part of a one-liner. It's very much a command that is
    designed purely for scripting, the interface is just odd and baroque
    and doesn't really make sense for one-liners.

    The typical use of patch-id is to generate two *lists* of patch-ids,
    then sort them and use the patch-id as a key to find commits that
    look the same.

The command doc *could* use an example, and since it is a mapper command
it makes sense for that example to be a little script.

Mapping the commits of some branch to an upstream ref allows us to
demonstrate generating two lists, sorting them, joining them, and
finally discarding the patch ID lookup column with cut(1).

† 1: https://lore.kernel.org/workflows/CAHk-=wiN+8EUoik4UeAJ-HPSU7hczQP+8+_uP3vtAy_=YfJ9PQ@mail.gmail.com/

Inspired-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-patch-id.adoc