[PATCH] Fix Documentation for git-describe
The documentation for git-describe says the default abbreviation is 8 hexadecimal digits while cache.c clearly shows DEFAULT_ABBREV set to 7. This patch corrects the documentation.
Signed-off-by: Boyd Stephen Smith Jr <bss@iguanasuicide.net>
---
On Thursday 2009 January 22 06:34:06 Tomas Carnecky wrote:
Show 21 quoted lines
>On 01/22/2009 12:26 PM, Martin Pirker wrote:
>> john@doe:/workspace$ git version
>> git version 1.6.1
>> john@doe:/workspace$ git describe
>> fatal: cannot describe '7aee61cc635a923e70b74091486742481ee0928b'
>> john@doe:/workspace$ git describe --always
>> 7aee61c
>> john@doe:/workspace$ git describe --always --abbrev=8
>> 7aee61cc
>>
>> man git-describe:
>> --abbrev=<n>
>> Instead of using the default 8 hexadecimal digits as the
>> abbreviated object name, use<n> digits.
>>
>> There is one character missing from default or what am I missing?
>
>The man page is wrong:
>
>cache.h:#define DEFAULT_ABBREV 7
>builtin-describe.c:static int abbrev = DEFAULT_ABBREV;
Let's fix it then! This is a patch against maint.
Is there any way to include values from the source as text in the ascidoc other than copy-and-paste? It would be nice if we don't have to do this fix again in the future.
I did a quick scan of 'git grep 8 -- Documentation' and didn't see anywhere else this needed fixing.
Documentation/git-describe.txt | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 3d79f05..a30c5ac 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -43,7 +43,7 @@ OPTIONS
Automatically implies --tags.
--abbrev=<n>::
- Instead of using the default 8 hexadecimal digits as the
+ Instead of using the default 7 hexadecimal digits as the
abbreviated object name, use <n> digits.
--candidates=<n>::
--
1.6.0.2
--
Boyd Stephen Smith Jr. ,= ,-_-. =.
bss@iguanasuicide.net ((_/)o o(\_))
ICQ: 514984 YM/AIM: DaTwinkDaddy `-'(. .)`-'
http://iguanasuicide.net/ \_/