doc: rewrite description for rev-parse --short
`git rev-parse --short` is not a generic modifier but just a variant of `--verify` and considers the given length only as a suggestion to ensure uniqueness. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Andreas Heiduk committed
May 31, 2017 at 23:39 UTC
fb87327aeed9c0079266e74b80d46b0119142601
2 files changed
+7
-6
Documentation/config.txt
+1
@@ -862,6 +862,7 @@ core.abbrev::
862
computed based on the approximate number of packed objects
863
in your repository, which hopefully is enough for
864
abbreviated object names to stay unique for some time.
865
+ The minimum length is 4.
866
867
add.ignoreErrors::
868
add.ignore-errors (deprecated)::
Documentation/git-rev-parse.txt
+6
-6
@@ -126,6 +126,12 @@ can be used.
126
'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
127
the command input is still interpreted as usual.
128
129
+--short[=length]::
130
+ Same as `--verify` but shortens the object name to a unique
131
+ prefix with at least `length` characters. The minimum length
132
+ is 4, the default is the effective value of the `core.abbrev`
133
+ configuration variable (see linkgit:git-config[1]).
134
+
135
--not::
136
When showing object names, prefix them with '{caret}' and
137
strip '{caret}' prefix from the object names that already have
@@ -136,12 +142,6 @@ can be used.
142
The option core.warnAmbiguousRefs is used to select the strict
143
abbreviation mode.
144
139
---short::
140
---short=number::
141
- Instead of outputting the full SHA-1 values of object names try to
142
- abbreviate them to a shorter unique name. When no length is specified
143
- 7 is used. The minimum length is 4.
144
-
145
--symbolic::
146
Usually the object names are output in SHA-1 form (with
147
possible '{caret}' prefix); this option makes them output in a