[PATCH] stash show: use stash.showIncludeUntracked even when diff options given

[PATCH] stash show: use stash.showIncludeUntracked even when diff options given

[Denton Liu]

If options pertaining to how the diff is displayed is provided to
`git stash show`, the command will ignore the stash.showIncludeUntracked
configuration variable, defaulting to not showing any untracked files.
This is unintuitive behaviour since the format of the diff output and
whether or not to display untracked files are orthogonal.

Use stash.showIncludeUntracked even when diff options are given. Of
course, this is still overridable via the command-line options.

Update the documentation to explicitly say which configuration variables
will be overridden when a diff options are given.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
This patch is a follow-up to [0]. This patch is based on top of
'dl/stash-show-untracked-fixup'.

[0]: https://lore.kernel.org/git/76dfa90a32ae926f7477d5966109f81441eb2783.1621325684.git.liu.denton@gmail.com/

 Documentation/config/stash.txt     | 6 +++---
 Documentation/git-stash.txt        | 6 ++++--
 builtin/stash.c                    | 5 +----
 t/t3905-stash-include-untracked.sh | 2 ++
 4 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt
index 413f907cba..9ed775281f 100644
--- a/Documentation/config/stash.txt
+++ b/Documentation/config/stash.txt
@@ -6,9 +6,9 @@ stash.useBuiltin::
 	remaining users that setting this now does nothing.
 
 stash.showIncludeUntracked::
-	If this is set to true, the `git stash show` command without an
-	option will show the untracked files of a stash entry.  Defaults to
-	false. See description of 'show' command in linkgit:git-stash[1].
+	If this is set to true, the `git stash show` command will show
+	the untracked files of a stash entry.  Defaults to false. See
+	description of 'show' command in linkgit:git-stash[1].
 
 stash.showPatch::
 	If this is set to true, the `git stash show` command without an
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index a8c8c32f1e..be6084ccef 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -91,8 +91,10 @@ show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
 	By default, the command shows the diffstat, but it will accept any
 	format known to 'git diff' (e.g., `git stash show -p stash@{1}`
 	to view the second most recent entry in patch form).
-	You can use stash.showIncludeUntracked, stash.showStat, and
-	stash.showPatch config variables to change the default behavior.
+	If no `<diff-option>` is provided, the default behavior will be given
+	by the `stash.showStat`, and `stash.showPatch` config variables. You
+	can also use `stash.showIncludeUntracked` to set whether
+	`--include-untracked` is enabled by default.
 
 pop [--index] [-q|--quiet] [<stash>]::
 
diff --git a/builtin/stash.c b/builtin/stash.c
index 82e4829d44..864b6c1416 100644
--- a/builtin/stash.c
+++ b/builtin/stash.c
@@ -831,7 +831,7 @@ static int show_stash(int argc, const char **argv, const char *prefix)
 		UNTRACKED_NONE,
 		UNTRACKED_INCLUDE,
 		UNTRACKED_ONLY
-	} show_untracked = UNTRACKED_NONE;
+	} show_untracked = show_include_untracked ? UNTRACKED_INCLUDE : UNTRACKED_NONE;
 	struct option options[] = {
 		OPT_SET_INT('u', "include-untracked", &show_untracked,
 			    N_("include untracked files in the stash"),
@@ -874,9 +874,6 @@ static int show_stash(int argc, const char **argv, const char *prefix)
 		if (show_patch)
 			rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
 
-		if (show_include_untracked)
-			show_untracked = UNTRACKED_INCLUDE;
-
 		if (!show_stat && !show_patch) {
 			free_stash_info(&info);
 			return 0;
diff --git a/t/t3905-stash-include-untracked.sh b/t/t3905-stash-include-untracked.sh
index 1c9765928d..f7fafcd447 100755
--- a/t/t3905-stash-include-untracked.sh
+++ b/t/t3905-stash-include-untracked.sh
@@ -333,6 +333,8 @@ test_expect_success 'stash show --include-untracked shows untracked files' '
 	git stash show -p --include-untracked >actual &&
 	test_cmp expect actual &&
 	git stash show --include-untracked -p >actual &&
+	test_cmp expect actual &&
+	git -c stash.showIncludeUntracked=true stash show -p >actual &&
 	test_cmp expect actual
 '
 
-- 
2.32.0.rc0.171.g09c0ee21fe

Re: [PATCH] stash show: use stash.showIncludeUntracked even when diff options given

[Junio C Hamano]

Denton Liu <liu.denton@gmail.com> writes:

> If options pertaining to how the diff is displayed is provided to
> `git stash show`, the command will ignore the stash.showIncludeUntracked
> configuration variable, defaulting to not showing any untracked files.
> This is unintuitive behaviour since the format of the diff output and
> whether or not to display untracked files are orthogonal.
>
> Use stash.showIncludeUntracked even when diff options are given. Of
> course, this is still overridable via the command-line options.
>
> Update the documentation to explicitly say which configuration variables
> will be overridden when a diff options are given.
>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
> This patch is a follow-up to [0]. This patch is based on top of
> 'dl/stash-show-untracked-fixup'.

It does make sense to keep "what to show" and "how to show them"
orthogonal.  It seems that not enough thoguht went into the topic
before it got merged to 'next', which is quite sad.

> diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt
> index 413f907cba..9ed775281f 100644
> --- a/Documentation/config/stash.txt
> +++ b/Documentation/config/stash.txt
> @@ -6,9 +6,9 @@ stash.useBuiltin::
>  	remaining users that setting this now does nothing.
>  
>  stash.showIncludeUntracked::
> -	If this is set to true, the `git stash show` command without an
> -	option will show the untracked files of a stash entry.  Defaults to
> -	false. See description of 'show' command in linkgit:git-stash[1].
> +	If this is set to true, the `git stash show` command will show
> +	the untracked files of a stash entry.  Defaults to false. See
> +	description of 'show' command in linkgit:git-stash[1].

OK.

> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index a8c8c32f1e..be6084ccef 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -91,8 +91,10 @@ show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
>  	By default, the command shows the diffstat, but it will accept any
>  	format known to 'git diff' (e.g., `git stash show -p stash@{1}`
>  	to view the second most recent entry in patch form).
> +	If no `<diff-option>` is provided, the default behavior will be given
> +	by the `stash.showStat`, and `stash.showPatch` config variables. You
> +	can also use `stash.showIncludeUntracked` to set whether
> +	`--include-untracked` is enabled by default.

OK.

> diff --git a/builtin/stash.c b/builtin/stash.c
> index 82e4829d44..864b6c1416 100644
> --- a/builtin/stash.c
> +++ b/builtin/stash.c
> @@ -831,7 +831,7 @@ static int show_stash(int argc, const char **argv, const char *prefix)
>  		UNTRACKED_NONE,
>  		UNTRACKED_INCLUDE,
>  		UNTRACKED_ONLY
> -	} show_untracked = UNTRACKED_NONE;
> +	} show_untracked = show_include_untracked ? UNTRACKED_INCLUDE : UNTRACKED_NONE;

OK.  We initialize this to what the config said...

>  	struct option options[] = {
>  		OPT_SET_INT('u', "include-untracked", &show_untracked,
>  			    N_("include untracked files in the stash"),
> @@ -874,9 +874,6 @@ static int show_stash(int argc, const char **argv, const char *prefix)
>  		if (show_patch)
>  			rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
>  
> -		if (show_include_untracked)
> -			show_untracked = UNTRACKED_INCLUDE;
> -

... without limiting the defaulting only to the case where
revision_args.nr==1 (no options are given).

>  		if (!show_stat && !show_patch) {
>  			free_stash_info(&info);
>  			return 0;

As this is a fix to a part of a new feature that was broken from day
one, let's take it and fast-track.

Thanks.

> diff --git a/t/t3905-stash-include-untracked.sh b/t/t3905-stash-include-untracked.sh
> index 1c9765928d..f7fafcd447 100755
> --- a/t/t3905-stash-include-untracked.sh
> +++ b/t/t3905-stash-include-untracked.sh
> @@ -333,6 +333,8 @@ test_expect_success 'stash show --include-untracked shows untracked files' '
>  	git stash show -p --include-untracked >actual &&
>  	test_cmp expect actual &&
>  	git stash show --include-untracked -p >actual &&
> +	test_cmp expect actual &&
> +	git -c stash.showIncludeUntracked=true stash show -p >actual &&
>  	test_cmp expect actual
>  '