Re: [RFC PATCH] Revamp git-cherry(1)
- From
Jeff King <peff@peff.net>
- Date
- Nov 21, 2013, 11:54 UTC
- Message-ID
- <20131121115423.GC7171@sigill.intra.peff.net>
- In-Reply-To
- <3af3069696e3a59d513f1fef0ca797d103f6d882.1385033403.git.tr@thomasrast.ch>
On Thu, Nov 21, 2013 at 12:30:56PM +0100, Thomas Rast wrote:
Show 10 quoted lines
> 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/ ?
Show 7 quoted lines
> +------------ > +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