git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc: enhance git describe --tags help

From
Shawn O. Pearce <spearce@spearce.org>
Date
Sep 29, 2008, 15:01 UTC
Message-ID
<20080929150127.GB18340@spearce.org>
In-Reply-To
<20080928151259.GJ5302@artemis.corp>
Pierre Habouzit <madcoder@debian.org> wrote:
Show 11 quoted lines
> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
> index c4dbc2a..9cc8c2f 100644
> --- a/Documentation/git-describe.txt
> +++ b/Documentation/git-describe.txt
> @@ -30,7 +30,8 @@ OPTIONS
>  
>  --tags::
>  	Instead of using only the annotated tags, use any tag
> -	found in `.git/refs/tags`.
> +	found in `.git/refs/tags`. Though if an annotated tag is found in the
> +	ancestry, it will always be preferred to lightweight tags.

As technically correct as the statement is, I read this and go "why do we even have --tags?".

If I read builtin-describe.c right we only honor --tags on an exact match, or if there are no annotated tags at all in the history. I wonder if docs like this aren't better for --tags:

--tags::
	If a lightweight tag exactly matches, output it.  If no
	annotated tag is found in the ancestry but a lightweight
	tag is found, output the lightweight tag.
?
-- 
Shawn.
Previous: Pierre HabouzitNext: Pierre Habouzit
Message 7 of 26 in “git-describe doesn't show the most recent tag”
  1. Erez ZilberSep 28, 2008
  2. Pierre HabouzitSep 28, 2008
  3. Erez ZilberSep 28, 2008
  4. Pierre HabouzitSep 28, 2008
  5. Pierre HabouzitSep 28, 2008
  6. doc: enhance git describe --tags helpPierre Habouzit, Sep 28, 2008
  7. Shawn O. PearceSep 29, 2008
  8. Pierre HabouzitSep 30, 2008
  9. describe: Make --tags and --all match lightweight tags more oftenShawn O. Pearce, Oct 10, 2008
  10. Pierre HabouzitOct 10, 2008
  11. Junio C HamanoOct 10, 2008
  12. Shawn O. PearceOct 13, 2008
  13. describe: Make --tags and --all match lightweight tags more oftenShawn O. Pearce, Oct 13, 2008
  14. Santi BéjarOct 15, 2008
  15. Andreas EricssonOct 11, 2008
  16. Shawn O. PearceOct 12, 2008
  17. Andreas EricssonOct 12, 2008
  18. Uwe Kleine-KönigOct 12, 2008
  19. Uwe Kleine-KönigSep 30, 2008
  20. Andreas EricssonSep 30, 2008
  21. Shawn O. PearceSep 30, 2008
  22. Uwe Kleine-KönigSep 30, 2008
  23. Shawn O. PearceSep 30, 2008
  24. Uwe Kleine-KönigOct 15, 2008
  25. Erez ZilberSep 28, 2008
  26. Andreas EricssonSep 28, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.