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/pretty-options.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/pretty-options.txt')
-rw-r--r-- | Documentation/pretty-options.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 17c5aac4b7..27ddaf84a1 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -16,9 +16,9 @@ configuration (see linkgit:git-config[1]). --abbrev-commit:: Instead of showing the full 40-byte hexadecimal commit object - name, show only a partial prefix. Non default number of - digits can be specified with "--abbrev=<n>" (which also modifies - diff output, if it is displayed). + name, show a prefix that names the object uniquely. + "--abbrev=<n>" (which also modifies diff output, if it is displayed) + option can be used to specify the minimum length of the prefix. + This should make "--pretty=oneline" a whole lot more readable for people using 80-column terminals. |