[PATCH] Documentation: explain the meaning of "-g" in git-describe output
Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
---
Linus Torvalds, 2010-03-18 02:19:
Show 10 quoted lines
>
> On Wed, 17 Mar 2010, Jay Soffian wrote:
> >
> > My guess, from 908e531 (Add a "git-describe" command, 2005-12-24), is
> > that it's short for "git":
>
> Indeed. I actually wanted to make it possible to use other SCM's, even if
> it's stupid. And git is not the only one that uses hashes for versioning,
> so the "g" prefix is there to allow others that use -hg or monotone or
> similar to work
I really hadn't thought of this obvious explanation.
Documentation/git-describe.txt | 3 +++
1 files changed, 3 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 6fc5323..d9311dd 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -105,6 +105,9 @@ The number of additional commits is the number
of commits which would be displayed by "git log v1.0.4..parent".
The hash suffix is "-g" + 7-char abbreviation for the tip commit
of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).
+The "g" prefix stands for "git" and is used to allow describing the version of
+a software depending on the SCM the software is managed with. This is useful
+in an environment where people may use different SCMs.
Doing a 'git describe' on a tag-name will just show the tag name:
--
1.7.0.3.257.gcd709
Markus Heidelberg <markus.heidelberg@web.de>