From: Max Horn <max@quendi.de>
To: Felipe Contreras <felipe.contreras@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
Johannes Schindelin <johannes.schindelin@gmx.de>,
Jeff King <peff@peff.net>,
Sverre Rabbelier <srabbelier@gmail.com>,
Brandon Casey <drafnel@gmail.com>,
Brandon Casey <casey@nrlssc.navy.mil>,
Jonathan Nieder <jrnieder@gmail.com>,
Ilari Liusvaara <ilari.liusvaara@elisanet.fi>,
Pete Wyckoff <pw@padd.com>, Ben Walton <bdwalton@gmail.com>,
Matthieu Moy <Matthieu.Moy@imag.fr>,
Julian Phillips <julian@quantumfyre.co.uk>
Subject: Re: [PATCH v5 11/15] remote-testgit: make clear the 'done' feature
Date: Mon, 12 Nov 2012 12:20:56 +0100 [thread overview]
Message-ID: <EA56F0CC-7C93-491F-A076-4A1AA9593ED0@quendi.de> (raw)
In-Reply-To: <CAMP44s0o1eP+aeT0AHu4uP1NPLqJq56qUDb-+F_x5NjoJCnf+A@mail.gmail.com>
On 11.11.2012, at 22:22, Felipe Contreras wrote:
> On Sun, Nov 11, 2012 at 9:49 PM, Max Horn <max@quendi.de> wrote:
>>
>> On 11.11.2012, at 14:59, Felipe Contreras wrote:
>>
>>> People seeking for reference would find it useful.
>>
>> Hm, I don't understand this commit message. Probably means I am j git fast-export --use-done-featureust too dumb, but since I am one of those people who would likely be seeking for reference, I would really appreciate if it could clarified. Like, for example, I don't see how the patch below makes anything "clear", it just seems to change the "import" command of git-remote-testgit to make use of the 'done' feature?
>
> No, the done feature was there already, but not so visible: git
> fast-export --use-done-feature <-there. Which is the problem, it's too
> easy to miss, therefore the need to make it clear.
Aha, now I understand what this patch is about. So I would suggest this alternate commit message:
remote-testgit: make it explicit clear that we use the 'done' feature
Previously we relied on passing '--use-done-feature ' to git fast-export, which is
easy to miss when looking at this script. Since remote-testgit is also a reference
implementation, we now explicitly output 'feature done' / 'done' to make it
crystal clear that we implement this feature.
Or perhaps a little bit less verbose. With a commit message like the above, I think I would have grokked the patch right away. With the original message, that was not the case (else I wouldn't have wrote my initial email). And even though I now understand (or at least believe to understand) the patch, I don't think the original message is that helpful... indeed, "make clear the 'done' feature" is ambiguous. You meant it as "make clear the 'done' feature is implemented / used", while I understood it as "make clear what the 'done' feature is about". Looking at the patch can help to resolve that, but (a) my wrong interpretation threw me off-track and (b) I thought that the point of commit messages was to give an overview of a patch without having to look at it...
So at the very least, the message should explain what exactly is "made clear".
Anyway, a small change to the commit message hopefully will not be a problem. :-)
Cheers,
Max
next prev parent reply other threads:[~2012-11-12 11:21 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-11-11 13:59 [PATCH v5 00/15] fast-export and remote-testgit improvements Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 01/15] fast-export: avoid importing blob marks Felipe Contreras
2012-11-11 16:36 ` Torsten Bögershausen
2012-11-11 16:38 ` Jeff King
2012-11-12 17:44 ` Junio C Hamano
2012-11-11 17:53 ` Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 02/15] remote-testgit: fix direction of marks Felipe Contreras
2012-11-11 20:39 ` Max Horn
2012-11-11 13:59 ` [PATCH v5 03/15] remote-helpers: fix failure message Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 04/15] Rename git-remote-testgit to git-remote-testpy Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 05/15] Add new simplified git-remote-testgit Felipe Contreras
2012-11-11 20:40 ` Max Horn
2012-11-21 18:26 ` Junio C Hamano
2012-11-21 23:39 ` Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 06/15] remote-testgit: get rid of non-local functionality Felipe Contreras
2012-11-21 18:26 ` Junio C Hamano
2012-11-21 23:44 ` Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 07/15] remote-testgit: remove irrelevant test Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 08/15] remote-testgit: cleanup tests Felipe Contreras
2012-11-21 18:28 ` Junio C Hamano
2012-11-22 0:55 ` Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 09/15] remote-testgit: exercise more features Felipe Contreras
2012-11-21 18:26 ` Junio C Hamano
2012-11-21 23:35 ` Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 10/15] remote-testgit: report success after an import Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 11/15] remote-testgit: make clear the 'done' feature Felipe Contreras
2012-11-11 20:49 ` Max Horn
2012-11-11 21:22 ` Felipe Contreras
2012-11-12 11:20 ` Max Horn [this message]
2012-11-12 15:45 ` Jonathan Nieder
2012-11-12 16:40 ` Felipe Contreras
2012-11-21 18:11 ` Junio C Hamano
2012-11-21 19:20 ` Sverre Rabbelier
2012-11-11 13:59 ` [PATCH v5 12/15] fast-export: trivial cleanup Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 13/15] fast-export: fix comparison in tests Felipe Contreras
2012-11-11 13:59 ` [PATCH v5 14/15] fast-export: make sure updated refs get updated Felipe Contreras
2012-11-11 20:43 ` Max Horn
2012-11-21 18:12 ` Junio C Hamano
2012-11-11 13:59 ` [PATCH v5 15/15] fast-export: don't handle uninteresting refs Felipe Contreras
2012-11-12 16:28 ` Felipe Contreras
2012-11-20 22:43 ` Junio C Hamano
2012-11-21 3:03 ` Felipe Contreras
2012-11-21 4:17 ` Jonathan Nieder
2012-11-21 4:22 ` Felipe Contreras
2012-11-21 5:08 ` Junio C Hamano
2012-11-21 7:11 ` Felipe Contreras
2012-11-21 8:37 ` Felipe Contreras
2012-11-21 19:48 ` Jeff King
2012-11-22 0:28 ` Felipe Contreras
2012-11-26 5:35 ` Junio C Hamano
2012-11-26 12:16 ` Felipe Contreras
2012-11-26 16:28 ` Johannes Schindelin
2012-11-26 17:56 ` Junio C Hamano
2012-11-26 19:23 ` Felipe Contreras
2012-11-26 19:26 ` Johannes Schindelin
2012-11-26 21:46 ` Sverre Rabbelier
2012-11-26 22:22 ` Junio C Hamano
2012-11-21 22:30 ` Max Horn
2012-11-22 0:38 ` Felipe Contreras
2012-11-21 18:14 ` Junio C Hamano
2012-11-22 0:15 ` Felipe Contreras
2012-11-24 3:12 ` Felipe Contreras
2012-11-21 9:46 ` [PATCH v5 00/15] fast-export and remote-testgit improvements Felipe Contreras
2012-11-21 19:05 ` Junio C Hamano
2012-11-22 0:51 ` Felipe Contreras
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=EA56F0CC-7C93-491F-A076-4A1AA9593ED0@quendi.de \
--to=max@quendi.de \
--cc=Matthieu.Moy@imag.fr \
--cc=bdwalton@gmail.com \
--cc=casey@nrlssc.navy.mil \
--cc=drafnel@gmail.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=ilari.liusvaara@elisanet.fi \
--cc=johannes.schindelin@gmx.de \
--cc=jrnieder@gmail.com \
--cc=julian@quantumfyre.co.uk \
--cc=peff@peff.net \
--cc=pw@padd.com \
--cc=srabbelier@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).