Re: [PATCH] git-diff: Add --staged as a synonym for --cached.

From: Jeff King <peff@peff.net>
Date: Oct 29, 2008, 16:42 UTC
Message-ID: <20081029164253.GA3172@sigill.intra.peff.net>
In-Reply-To: <1225296936-1357-1-git-send-email-dsymonds@gmail.com>

On Wed, Oct 29, 2008 at 09:15:36AM -0700, David Symonds wrote:

>  Consider this as a replacement to the previous git-staged series.

I think this is a much more sensible (actual) approach.

Show 9 quoted lines

> diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
> index c53eba5..a2f192f 100644
> --- a/Documentation/git-diff.txt
> +++ b/Documentation/git-diff.txt
> @@ -33,6 +33,7 @@ forced by --no-index.
>  	commit relative to the named <commit>.  Typically you
>  	would want comparison with the latest commit, so if you
>  	do not give <commit>, it defaults to HEAD.
> +	--staged is a synonym of --cached.

Hmm. I wonder if it would make it more sense to make the "official" name --staged, and leave --cached forever as a synonym. If the goal is giving sane names to end users, then we should probably advertise the sane ones.

OTOH, maybe it is better to start slow, let people who are doing training materials mention --staged, and see how that works.

Show 9 quoted lines

> @@ -118,7 +118,7 @@ static int builtin_diff_index(struct rev_info *revs,
>  	int cached = 0;
>  	while (1 < argc) {
>  		const char *arg = argv[1];
> -		if (!strcmp(arg, "--cached"))
> +		if (!strcmp(arg, "--cached") || !strcmp(arg, "--staged"))
>  			cached = 1;
>  		else
>  			usage(builtin_diff_usage);

I had to investigate this hunk closely, as it really looks at first glance (from the function name, and the fact that there are two hunks, one here and one for cmd_diff) that this is impacting diff-index --cached, but it's not. We just checked --cached in two different places inside git-diff (but at least one of them is prefixed by a comment that includes the world "Eek.").

-Peff