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

Re: [PATCH] Mention the fact that 'git annotate' is only for backward compatibility.

From
Junio C Hamano <gitster@pobox.com>
Date
Sep 4, 2008, 19:17 UTC
Message-ID
<7v63pb3emm.fsf@gitster.siamese.dyndns.org>
In-Reply-To
<20080904123046.GX10544@machine.or.cz>
Petr Baudis <pasky@suse.cz> writes:
> Can you please also mark it deprecated in the bash completion and
> command-list.txt?

I am hesitant to use the word "deprecated" in git(7) manual page, as the word has much stronger connotation than merely "because a more often used equivalent exists, there is no reason to encourage this for new people, but on the other hand there is no reason to remove or phase it out to hurt existing users", which is what "git annotate" is.

"Deprecated" is more like "it is still supported but its use is actively discouraged". I do not think we actively discourage it, nor need to phase it out.

People coming from different background may look for annotate and get frustrated until they find out blame is the equivalent (or vice versa).

While I do not mind marking annotate as ": infrequently used ;;" in the completion script, I am skeptical about the value of such a change. Dropping annotate from the completion is a _slight_ improvement in that when people type "git a<TAB>" they will see one less candidates, but it is not a great deal of improvement: four down from five.

Mentioning that we support both names for findability in both annotate and blame manual pages (not just annotate page) might be a better thing to do.

Previous: Junio C HamanoNext: Matthieu Moy
Message 11 of 17 in “blame vs annotate?”
  1. Jonathan del StrotherSep 3, 2008
  2. Miklos VajnaSep 3, 2008
  3. Petr BaudisSep 3, 2008
  4. Junio C HamanoSep 3, 2008
  5. Matthieu MoySep 4, 2008
  6. Sverre RabbelierSep 4, 2008
  7. Mention the fact that 'git annotate' is only for backward compatibility.Matthieu Moy, Sep 4, 2008
  8. Petr BaudisSep 4, 2008
  9. Mention the fact that 'git annotate' is only for backward compatibility.Matthieu Moy, Sep 4, 2008
  10. Junio C HamanoSep 4, 2008
  11. Junio C HamanoSep 4, 2008
  12. Matthieu MoySep 5, 2008
  13. Junio C HamanoSep 5, 2008
  14. Petr BaudisSep 5, 2008
  15. Matthieu MoySep 5, 2008
  16. Junio C HamanoSep 5, 2008
  17. Jakub NarebskiSep 3, 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.