diff options
| author | Junio C Hamano <gitster@pobox.com> | 2020-11-04 14:01:37 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-11-04 14:04:44 -0800 |
| commit | cda34e0d0cc3e0b53e6c496c56e07e34c339263f (patch) | |
| tree | 3cc01c93d956ceb686e5fe76950e3cbba645d8cc /Documentation/git-blame.txt | |
| parent | 898f80736c75878acc02dc55672317fcc0e0a5a6 (diff) | |
| download | git-cda34e0d0cc3e0b53e6c496c56e07e34c339263f.tar.gz | |
doc: clarify that --abbrev=<n> is about the minimum length
Early text written in 2006 explains the "--abbrev=<n>" option to
"show only a partial prefix", without saying that the length of the
partial prefix is not necessarily the number given to the option to
ensure that the output names the object uniquely.
Update documentation for the diff family of commands, "blame",
"branch --verbose", "ls-files" and "ls-tree" to stress that the
short prefix must uniquely refer to an object, and <n> is merely
the mininum number of hexdigits used in the prefix.
Helped-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-blame.txt')
| -rw-r--r-- | Documentation/git-blame.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 7e81541996..34b496d485 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -87,7 +87,9 @@ include::blame-options.txt[] --abbrev=<n>:: Instead of using the default 7+1 hexadecimal digits as the - abbreviated object name, use <n>+1 digits. Note that 1 column + abbreviated object name, use <m>+1 digits, where <m> is at + least <n> but ensures the commit object names are unique. + Note that 1 column is used for a caret to mark the boundary commit. |