Fix: fix comment for __git_complete_worktree_paths

Commit Message

Sardorbek Imomaliev April 29, 2021, 8:43 a.m. UTC

From: Sardorbek Imomaliev <[e-mail]>

Completion helper function fails for zsh because of wrongly put comment

Signed-off-by: Sardorbek Imomaliev <[e-mail]>
---
    Fix: wrongly put comment for __git_complete_worktree_paths completion
    helper function
    
    git completion script fails for zsh
    
    $ git worktree remove [TAB]
    $ git worktree remove __git_complete_worktree_paths:7: command not found: #
    

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-943%2Fimomaliev%2Ffix%2Fgit-completion-worktree-subcommands-comment-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-943/imomaliev/fix/git-completion-worktree-subcommands-comment-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/943

 contrib/completion/git-completion.bash | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 311531c9de557d25ac087c1637818bd2aad6eb3a

Comments

Junio C Hamano April 30, 2021, 12:42 a.m. UTC | #1

"Sardorbek Imomaliev via GitGitGadget" <[e-mail]>
writes:

> Subject: Re: [PATCH] Fix: fix comment for __git_complete_worktree_paths

In this project, we write what area of the codebase the change
affects before the colon (I'll give you an example later).

> From: Sardorbek Imomaliev <[e-mail]>
>
> Completion helper function fails for zsh because of wrongly put comment

Isn't it a bug in zsh that it does not understand that the comment
is about the command placed on the downstream of the pipe, like
this example?

	echo a b c |
	# upcase the input (a comment about the next line)
	tr a-z A-Z

Apparently bash is happy with the existing code, and dash and ksh
seems to be OK with the above construct, too.

Perhaps rephrase the log message like this instead?

    [PATCH] completion: work around zsh comment but in __git_complete_worktree_paths

    In contrib/completion/git-completion.bash, there is a construct
    where comment lines are placed between the command that is on
    the upstream of a pipe and the command that is on the downstream
    of a pipe in __git_complete_worktree_paths function.

    Unfortunately, this script is also used by Zsh completion, but
    Zsh mishandles this construct, resulting in a breakage:

        $ git worktree remove [TAB]
        $ git worktree remove __git_complete_worktree_paths:7: command not found: #

    Move the comment, even though it explains what happens on the
    downstream of the pipe and logically belongs where it is right
    now, before the entire pipeline, to work around this problem.

It might also be necessary to consider rephrasing the comment
itself, not just "Move the comment", to make sure that it is still
appropriate when used as a comment to cover the whole pipeline---the
original was meant to explain what happens in the downstream only.

Thanks.


> diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> index dfa735ea6299..b2e158edaf6b 100644
> --- a/contrib/completion/git-completion.bash
> +++ b/contrib/completion/git-completion.bash
> @@ -3268,9 +3268,9 @@ _git_whatchanged ()
>  __git_complete_worktree_paths ()
>  {
>  	local IFS=$'\n'
> +	# Skip the first entry: it's the path of the main worktree,
> +	# which can't be moved, removed, locked, etc.
>  	__gitcomp_nl "$(git worktree list --porcelain |
> -		# Skip the first entry: it's the path of the main worktree,
> -		# which can't be moved, removed, locked, etc.
>  		sed -n -e '2,$ s/^worktree //p')"
>  }
>  
>
> base-commit: 311531c9de557d25ac087c1637818bd2aad6eb3a

Patch

diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index dfa735ea6299..b2e158edaf6b 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -3268,9 +3268,9 @@  _git_whatchanged ()
 __git_complete_worktree_paths ()
 {
 	local IFS=$'\n'
+	# Skip the first entry: it's the path of the main worktree,
+	# which can't be moved, removed, locked, etc.
 	__gitcomp_nl "$(git worktree list --porcelain |
-		# Skip the first entry: it's the path of the main worktree,
-		# which can't be moved, removed, locked, etc.
 		sed -n -e '2,$ s/^worktree //p')"
 }