Skip to contentSkip to conversation

git-completion.bash: stash-show: add --patch-with-stat

PATCH In review Robert Karszniewicz 3 participants 6 messages Sep 28, 2020 – Sep 30, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 git-completion.bash: stash-show: add --patch-with-stat

---
 contrib/completion/git-completion.bash | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
contrib/completion/git-completion.bash +4 -1
index 8be4a0316e..d98c731667 100644
@@ -3016,7 +3016,10 @@ _git_stash ()
 		list,--*)
 			__gitcomp "--name-status --oneline --patch-with-stat"
 			;;
-		show,--*|branch,--*)
+		show,--*)
+			__gitcomp "--patch-with-stat"
+			;;
+		branch,--*)
 			;;
 		branch,*)
 			if [ $cword -eq 3 ]; then
Signature · 1 line
2.28.0
#1 lore raw
Quoted 10 lines · Robert Karszniewicz
---
 contrib/completion/git-completion.bash | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
contrib/completion/git-completion.bash +0 -0
index 8be4a0316e..d98c731667 100644

contrib/completion/git-completion.bash _git_stash () · line 3021

Quoted 7 lines
contrib/completion/git-completion.bash +3 -1
@@ -3016,7 +3016,10 @@ _git_stash ()
 		list,--*)
 			__gitcomp "--name-status --oneline --patch-with-stat"
 			;;
-		show,--*|branch,--*)
+		show,--*)
+			__gitcomp "--patch-with-stat"
+			;;

Why is --patch-with-stat so special?

Without completion support for "--patch" and "--stat", typing "--<TAB>" after "git stash show" and seeing only "--patch-with-stat" (which has been made obsolete-but-still-kept synonym immediately after the other two were invented in 2005) would make a rather surprising experience to the end users. For "show" alone, it may make a lot of sense to complete "git stash show -<TAB>" and offer "-p".

In any case, it might make more sense to do this instead, and then rethink what options make sense to these subcommands of "git stash". I do not think patch-with-stat should be among them.

- list,--*)
+ list,--* | show,--*)
__gitcomp "--name-status --oneline --patch-with-stat"

Thanks.

#2 lore raw

Hi Junio,

Quoted 3 lines · Junio C Hamano

In any case, it might make more sense to do this instead, and then rethink what options make sense to these subcommands of "git stash". I do not think patch-with-stat should be among them.

Perhaps it would make sense to add --patch and --no-patch to $__git_diff_common_options and then use that list for git stash show since it's documented that all of the diff options are valid.

Thanks,
Denton

#3 lore raw
In reply to Junio C Hamano
Quoted 22 lines · Junio C Hamano
Quoted 10 lines · Robert Karszniewicz
---
 contrib/completion/git-completion.bash | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
contrib/completion/git-completion.bash +0 -0
index 8be4a0316e..d98c731667 100644

contrib/completion/git-completion.bash _git_stash () · line 3021

Quoted 7 lines
contrib/completion/git-completion.bash +3 -1
@@ -3016,7 +3016,10 @@ _git_stash ()
 		list,--*)
 			__gitcomp "--name-status --oneline --patch-with-stat"
 			;;
-		show,--*|branch,--*)
+		show,--*)
+			__gitcomp "--patch-with-stat"
+			;;

Why is --patch-with-stat so special?

Quoted 4 lines

Without completion support for "--patch" and "--stat", typing "--<TAB>" after "git stash show" and seeing only "--patch-with-stat" (which has been made obsolete-but-still-kept synonym immediately after the other two were invented in 2005) would make a rather

Oh, I didn't know --patch-with-stat was obsoleted. It was recently added to stash-list, too. I can as well use "--patch --stat".

Quoted 3 lines

surprising experience to the end users. For "show" alone, it may make a lot of sense to complete "git stash show -<TAB>" and offer "-p".

Does git complete short options at all? I only see long options completed. (I'm also very new to bash-completion)

Quoted 4 lines

In any case, it might make more sense to do this instead, and then rethink what options make sense to these subcommands of "git stash". I do not think patch-with-stat should be among them.

So shall I do a v2 as per your suggestion and replace "--patch-with-stat" with "--patch --stat"?

Quoted 6 lines
(quoted diff) +1 -1
-  		list,--*)
+  		list,--* | show,--*)
  			__gitcomp "--name-status --oneline --patch-with-stat"

Thanks.

Thank you.

#4 lore raw
Quoted 6 lines · Robert Karszniewicz
Quoted 3 lines

surprising experience to the end users. For "show" alone, it may make a lot of sense to complete "git stash show -<TAB>" and offer "-p".

Does git complete short options at all? I only see long options completed. (I'm also very new to bash-completion)

I wouldn't personally recommend it, but I did see a patch that added support for one short option completion quite recently. As long as "--<TAB>" gets completed to often-used options, among which "--patch" and "--stat" are included, it would be OK not to react to "-<TAB>".

Quoted 6 lines
Quoted 3 lines

In any case, it might make more sense to do this instead, and then rethink what options make sense to these subcommands of "git stash". I do not think patch-with-stat should be among them.

So shall I do a v2 as per your suggestion and replace "--patch-with-stat" with "--patch --stat"?

I think Denton Liu offered a different suggestion; I didn't look at and compare which direction is the better one myself, but an approach that keeps the number of manually-maintained list of options low is almost always a good approach.

Thanks.

#5 lore raw
Quoted 8 lines · Junio C Hamano
Quoted 2 lines · Robert Karszniewicz

So shall I do a v2 as per your suggestion and replace "--patch-with-stat" with "--patch --stat"?

I think Denton Liu offered a different suggestion; I didn't look at and compare which direction is the better one myself, but an approach that keeps the number of manually-maintained list of options low is almost always a good approach.

Ok, I understand, then. Will take a look at it.

Thank you.