git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Thomas Rast <tr@thomasrast.ch>
Cc: git@vger.kernel.org, a.huemer@commend.com,
	"Michael S. Tsirkin" <mst@kernel.org>
Subject: Re: [RFC PATCH] Revamp git-cherry(1)
Date: Thu, 21 Nov 2013 06:54:23 -0500	[thread overview]
Message-ID: <20131121115423.GC7171@sigill.intra.peff.net> (raw)
In-Reply-To: <3af3069696e3a59d513f1fef0ca797d103f6d882.1385033403.git.tr@thomasrast.ch>

On Thu, Nov 21, 2013 at 12:30:56PM +0100, Thomas Rast wrote:

> git-cherry(1)'s "description" section has never really managed to
> explain to me what the command does.  It contains too much explanation
> of the algorithm instead of simply saying what goals it achieves, and
> too much terminology that we otherwise do not use (fork-point instead
> of merge-base).
> 
> Try a much more concise approach: state what it finds out, why this is
> neat, and how the output is formatted, in a few short paragraphs.  In
> return, provide a longer example of how it fits into a format-patch/am
> based workflow.

FWIW, I find your concise explanation much friendlier.

> +Later, you can whether your changes have been applied by saying (still
> +on `topic`):

s/can/& see/ ?

> +------------
> +git fetch  # update your notion of origin/master
> +git cherry -v
> +------------
> ++
> +Note that this uses , and assumes that
> +`core.autosetupmerge` is enabled (the default).

I couldn't quite parse this. Is there a word missing before the comma,
or is it "uses and assumes that..."?

Given that it is the default, I wonder if it is worth mentioning at all.
Even I, who knows what autosetupmerge does, took a minute to figure out
why it is relevant here. I suspect it may just confuse most readers.

-Peff

  reply	other threads:[~2013-11-21 11:54 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-21 11:30 [RFC PATCH] Revamp git-cherry(1) Thomas Rast
2013-11-21 11:54 ` Jeff King [this message]
2013-11-21 20:58   ` Thomas Rast
2013-11-21 19:26 ` Junio C Hamano
2013-11-21 21:02   ` Thomas Rast
2013-11-21 22:04     ` Junio C Hamano
2013-11-22 16:29   ` [PATCH v2] " Thomas Rast
2013-11-22 19:25     ` Junio C Hamano
2013-11-22 19:37       ` Thomas Rast
2013-11-22 19:39         ` Junio C Hamano

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=20131121115423.GC7171@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=a.huemer@commend.com \
    --cc=git@vger.kernel.org \
    --cc=mst@kernel.org \
    --cc=tr@thomasrast.ch \
    /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).