]> git.ipfire.org Git - thirdparty/git.git/commit
doc: clarify that --abbrev=<n> is about the minimum length
authorJunio C Hamano <gitster@pobox.com>
Wed, 4 Nov 2020 22:01:37 +0000 (14:01 -0800)
committerJunio C Hamano <gitster@pobox.com>
Wed, 4 Nov 2020 22:04:44 +0000 (14:04 -0800)
commitcda34e0d0cc3e0b53e6c496c56e07e34c339263f
tree3cc01c93d956ceb686e5fe76950e3cbba645d8cc
parent898f80736c75878acc02dc55672317fcc0e0a5a6
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>
Documentation/diff-options.txt
Documentation/git-blame.txt
Documentation/git-branch.txt
Documentation/git-ls-files.txt
Documentation/git-ls-tree.txt
Documentation/pretty-options.txt