mirror of
https://github.com/git/git.git
synced 2024-10-31 14:27:54 +01:00
30e12b924b
Patch id changes if users reorder file diffs that make up a patch. As the result is functionally equivalent, a different patch id is surprising to many users. In particular, reordering files using diff -O is helpful to make patches more readable (e.g. API header diff before implementation diff). Add an option to change patch-id behaviour making it stable against these kinds of patch change: calculate SHA1 hash for each hunk separately and sum all hashes (using a symmetrical sum) to get patch id We use a 20byte sum and not xor - since xor would give 0 output for patches that have two identical diffs, which isn't all that unlikely (e.g. append the same line in two places). The new behaviour is enabled - when patchid.stable is true - when --stable flag is present Using a new flag --unstable or setting patchid.stable to false force the historical behaviour. In the documentation, clarify that patch ID can now be a sum of hashes, not a hash. Document how command line and config options affect the behaviour. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
62 lines
2.1 KiB
Text
62 lines
2.1 KiB
Text
git-patch-id(1)
|
|
===============
|
|
|
|
NAME
|
|
----
|
|
git-patch-id - Compute unique ID for a patch
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git patch-id' [--stable | --unstable] < <patch>
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
A "patch ID" is nothing but a sum of SHA-1 of the file diffs associated with a
|
|
patch, with whitespace and line numbers ignored. As such, it's "reasonably
|
|
stable", but at the same time also reasonably unique, i.e., two patches that
|
|
have the same "patch ID" are almost guaranteed to be the same thing.
|
|
|
|
IOW, you can use this thing to look for likely duplicate commits.
|
|
|
|
When dealing with 'git diff-tree' output, it takes advantage of
|
|
the fact that the patch is prefixed with the object name of the
|
|
commit, and outputs two 40-byte hexadecimal strings. The first
|
|
string is the patch ID, and the second string is the commit ID.
|
|
This can be used to make a mapping from patch ID to commit ID.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--stable::
|
|
Use a "stable" sum of hashes as the patch ID. With this option:
|
|
- Reordering file diffs that make up a patch does not affect the ID.
|
|
In particular, two patches produced by comparing the same two trees
|
|
with two different settings for "-O<orderfile>" result in the same
|
|
patch ID signature, thereby allowing the computed result to be used
|
|
as a key to index some meta-information about the change between
|
|
the two trees;
|
|
|
|
- Result is different from the value produced by git 1.9 and older
|
|
or produced when an "unstable" hash (see --unstable below) is
|
|
configured - even when used on a diff output taken without any use
|
|
of "-O<orderfile>", thereby making existing databases storing such
|
|
"unstable" or historical patch-ids unusable.
|
|
|
|
This is the default if patchid.stable is set to true.
|
|
|
|
--unstable::
|
|
Use an "unstable" hash as the patch ID. With this option,
|
|
the result produced is compatible with the patch-id value produced
|
|
by git 1.9 and older. Users with pre-existing databases storing
|
|
patch-ids produced by git 1.9 and older (who do not deal with reordered
|
|
patches) may want to use this option.
|
|
|
|
This is the default.
|
|
|
|
<patch>::
|
|
The diff to create the ID of.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|