git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Bert Wesarg <bert.wesarg@googlemail.com>
Cc: git@vger.kernel.org, szeder@ira.uka.de,
	"Shawn O. Pearce" <spearce@spearce.org>
Subject: Re: [PATCH v3] for-each-ref: `:short` format for `refname`
Date: Wed, 03 Sep 2008 11:36:04 -0700	[thread overview]
Message-ID: <7vtzcxaxgr.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <1220431352-30605-1-git-send-email-bert.wesarg@googlemail.com> (Bert Wesarg's message of "Wed, 3 Sep 2008 10:42:32 +0200")

Bert Wesarg <bert.wesarg@googlemail.com> writes:

> Try to shorten the refname to a non-ambiguous name.
>
> Changes in v3:
>  * don't compare sha1's, its ambiguous if the short name
>    resovles to more than one ref
>  * use xstrdup()
>  * use indexes for the loops to clarify backward/forward
>    direction

Please don't do "Changes in v3" in the commit log message; do so after
"---" is very welcome as it gives people on the discussion _right now_
to understand the context of the change.

Also please do not omit discussion in the commit log message, to help
people _not_ on the discussion right now.

Your earlier versions will not appear on the history anywhere, and v3 is
the _only_ variant available to the people who need to understand what
this change was made for and why the code to implement the change was done
in the way the patch shows.  Write your commit log message to help people
who have "git show $this" and nothing else to figure these things out in
year 2010.

Namely:

 * Why "shortening" is a good thing?  For what use case this new feature
   was invented for?

 * What are the definitions of "shortening" and "non-ambiguous" in this
   feature's context?

In addition, for a complex feature with different possiblilities, it is a
good practice to describe what alternatatives and pros-and-cons among them
were considered while reaching this final version.  This is to help people
who would want to explore enhancement possibilities later; you beforehand
warn them about dead ends you have already explored.  For this particular
patch/feature, I do not think it is necessary, though.

  parent reply	other threads:[~2008-09-03 18:37 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <7vprnpbqmo.fsf@gitster.siamese.dyndns.org>
2008-08-31 12:41 ` [PATCH] for-each-ref: `:short` format for `refname` Bert Wesarg
2008-09-01 13:15   ` SZEDER Gábor
2008-09-01 14:13     ` Bert Wesarg
2008-09-01 17:52       ` Bert Wesarg
2008-09-01 19:10         ` Shawn O. Pearce
2008-09-01 21:10           ` Bert Wesarg
2008-09-01 21:28             ` Junio C Hamano
2008-09-01 21:44               ` Bert Wesarg
2008-09-02  7:26                 ` Bert Wesarg
2008-09-02 14:39                   ` Shawn O. Pearce
2008-09-02 21:57                     ` [PATCH v2] " Bert Wesarg
2008-09-02 23:10                       ` Junio C Hamano
2008-09-03  8:33                         ` Bert Wesarg
2008-09-03  8:42                           ` [PATCH v3] " Bert Wesarg
2008-09-03 15:18                             ` Shawn O. Pearce
2008-09-03 16:33                               ` Bert Wesarg
2008-09-03 16:56                                 ` Bert Wesarg
2008-09-03 18:36                             ` Junio C Hamano [this message]
2008-09-05 21:16                               ` [PATCH v4] " Bert Wesarg
2008-09-05 22:20                                 ` Junio C Hamano
2008-09-06 18:16                                   ` Bert Wesarg
2008-09-08 22:57                                 ` Junio C Hamano
2008-09-08 23:04                                   ` Shawn O. Pearce
2008-09-09  6:52                                   ` Bert Wesarg
2008-09-09  8:05                                     ` Junio C Hamano
2008-09-09  8:57                                       ` Bert Wesarg

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=7vtzcxaxgr.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=bert.wesarg@googlemail.com \
    --cc=git@vger.kernel.org \
    --cc=spearce@spearce.org \
    --cc=szeder@ira.uka.de \
    /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).