git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Petr Baudis <pasky@suse.cz>
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>, git@vger.kernel.org
Subject: Re: [PATCH] Mention the fact that 'git annotate' is only for backward compatibility.
Date: Thu, 04 Sep 2008 12:17:05 -0700	[thread overview]
Message-ID: <7v63pb3emm.fsf@gitster.siamese.dyndns.org> (raw)
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.

  parent reply	other threads:[~2008-09-04 19:18 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-03 16:43 blame vs annotate? Jonathan del Strother
2008-09-03 17:49 ` Miklos Vajna
2008-09-03 17:54   ` Petr Baudis
2008-09-03 18:10 ` Junio C Hamano
2008-09-04  9:09   ` Matthieu Moy
2008-09-04  9:16     ` Sverre Rabbelier
2008-09-04 12:00       ` [PATCH] Mention the fact that 'git annotate' is only for backward compatibility Matthieu Moy
2008-09-04 12:30         ` Petr Baudis
2008-09-04 13:03           ` Matthieu Moy
2008-09-04 19:12           ` Junio C Hamano
2008-09-04 19:17           ` Junio C Hamano [this message]
2008-09-05  6:31             ` Matthieu Moy
2008-09-05  7:29               ` Junio C Hamano
2008-09-05  8:07                 ` Petr Baudis
2008-09-05 12:06                   ` Matthieu Moy
2008-09-05  7:56           ` Junio C Hamano
2008-09-03 18:11 ` blame vs annotate? Jakub Narebski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7v63pb3emm.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=Matthieu.Moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=pasky@suse.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).