* [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
@ 2012-11-29 15:14 Adam Tkac
2012-11-29 17:03 ` Junio C Hamano
0 siblings, 1 reply; 6+ messages in thread
From: Adam Tkac @ 2012-11-29 15:14 UTC (permalink / raw)
To: git
Originally reported as https://bugzilla.redhat.com/show_bug.cgi?id=863780
Signed-off-by: Adam Tkac <atkac@redhat.com>
Signed-off-by: Holger Arnold <holgerar@gmail.com>
---
contrib/completion/git-completion.bash | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 0960acc..79073c2 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -565,7 +565,7 @@ __git_complete_strategy ()
__git_list_all_commands ()
{
local i IFS=" "$'\n'
- for i in $(git help -a|egrep '^ [a-zA-Z0-9]')
+ for i in $(git help -a| \egrep '^ [a-zA-Z0-9]')
do
case $i in
*--*) : helper pattern;;
--
1.8.0
--
Adam Tkac, Red Hat, Inc.
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
2012-11-29 15:14 [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion Adam Tkac
@ 2012-11-29 17:03 ` Junio C Hamano
2012-11-29 17:33 ` Junio C Hamano
0 siblings, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2012-11-29 17:03 UTC (permalink / raw)
To: Adam Tkac; +Cc: git, SZEDER Gábor, Felipe Contreras
Adam Tkac <atkac@redhat.com> writes:
> Subject: Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
The code does not seem to do anything special if it is not aliased,
though, so "If ..." part does not sound correct; perhaps you meant
"just in case egrep is aliased to something totally wacky" or
something?
The script seems to use commands other than 'egrep' that too can be
aliased to do whatever unexpected things. How does this patch get
away without backslashing them all, like
\echo ...
\sed ...
\test ...
\: comment ...
\git args ...
and still fix problems for users? Can't the same solution you would
give to users who alias one of the above to do something undesirable
be applied to those who alias egrep?
Puzzled...
> Originally reported as https://bugzilla.redhat.com/show_bug.cgi?id=863780
>
> Signed-off-by: Adam Tkac <atkac@redhat.com>
> Signed-off-by: Holger Arnold <holgerar@gmail.com>
> ---
> contrib/completion/git-completion.bash | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> index 0960acc..79073c2 100644
> --- a/contrib/completion/git-completion.bash
> +++ b/contrib/completion/git-completion.bash
> @@ -565,7 +565,7 @@ __git_complete_strategy ()
> __git_list_all_commands ()
> {
> local i IFS=" "$'\n'
> - for i in $(git help -a|egrep '^ [a-zA-Z0-9]')
> + for i in $(git help -a| \egrep '^ [a-zA-Z0-9]')
> do
> case $i in
> *--*) : helper pattern;;
> --
> 1.8.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
2012-11-29 17:03 ` Junio C Hamano
@ 2012-11-29 17:33 ` Junio C Hamano
2012-12-06 14:05 ` Adam Tkac
0 siblings, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2012-11-29 17:33 UTC (permalink / raw)
To: Adam Tkac; +Cc: git, SZEDER Gábor, Felipe Contreras
Junio C Hamano <gitster@pobox.com> writes:
> Adam Tkac <atkac@redhat.com> writes:
>
>> Subject: Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
>
> The code does not seem to do anything special if it is not aliased,
> though, so "If ..." part does not sound correct; perhaps you meant
> "just in case egrep is aliased to something totally wacky" or
> something?
>
> The script seems to use commands other than 'egrep' that too can be
> aliased to do whatever unexpected things. How does this patch get
> away without backslashing them all, like
>
> \echo ...
> \sed ...
> \test ...
> \: comment ...
> \git args ...
>
> and still fix problems for users? Can't the same solution you would
> give to users who alias one of the above to do something undesirable
> be applied to those who alias egrep?
>
> Puzzled...
Sorry for having been more snarky than necessary (blame it to lack
of caffeine). What I was trying to get at were:
* I have this suspicion that this patch exists only because you saw
somebody who aliases egrep to something unexpected by the use of
it in this script, and egrep *happened* to be the only such
"unreasonable" alias. The reporter may not have aliased echo or
sed away, or the aliases to these command *happened* to produce
"acceptable" output (even though it might have been slightly
different from unaliased one, the difference *happened* not to
matter for the purpose of this script).
* To the person who observes the same aliasing breakage due to his
aliasing sed to something else, you would solve his problem by
telling him "don't do that, then". If that is the solution, why
wouldn't it work for egrep?
* The next person who aliased other commands this script uses in
such a way that the behaviour of the alias differs sufficiently
from the unaliased version, you will have to patch the file
again, with the same backslashing. This patch is not a solution,
but a band-aid that only works for a particular case you
*happened* to have seen.
* A complete solution that follows the direction this patch
suggests would involve backslashing *all* commands that can
potentially aliased away. Is that really the direction we would
want to go in (answer: I doubt it)? Is that the only approach to
solve this aliasing issue (answer: I don't know, but we should
try to pursue it before applying a band-aid that is not a
solution)?
Is there a way to tell bash "do not alias-expand from here up to
there"? Perhaps "shopt -u expand_aliases" upon entry and restore
its original value when we exit, or something?
IOW, something along this line?
contrib/completion/git-completion.bash | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git i/contrib/completion/git-completion.bash w/contrib/completion/git-completion.bash
index 0b77eb1..193f53c 100644
--- i/contrib/completion/git-completion.bash
+++ w/contrib/completion/git-completion.bash
@@ -23,6 +23,14 @@
# 3) Consider changing your PS1 to also show the current branch,
# see git-prompt.sh for details.
+if shopt -q expand_aliases
+then
+ _git__aliases_were_enabled=yes
+else
+ _git__aliases_were_enabled=
+fi
+shopt -u expand_aliases
+
case "$COMP_WORDBREAKS" in
*:*) : great ;;
*) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
@@ -2504,3 +2512,8 @@ __git_complete gitk __gitk_main
if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
__git_complete git.exe __git_main
fi
+
+if test -n "$_git__aliases_were_enabled"
+then
+ shopt -s expand_aliases
+fi
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
2012-11-29 17:33 ` Junio C Hamano
@ 2012-12-06 14:05 ` Adam Tkac
2012-12-06 18:01 ` Junio C Hamano
0 siblings, 1 reply; 6+ messages in thread
From: Adam Tkac @ 2012-12-06 14:05 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git, SZEDER Gábor, Felipe Contreras
On Thu, Nov 29, 2012 at 09:33:53AM -0800, Junio C Hamano wrote:
> Junio C Hamano <gitster@pobox.com> writes:
>
> > Adam Tkac <atkac@redhat.com> writes:
> >
> >> Subject: Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
> >
> > The code does not seem to do anything special if it is not aliased,
> > though, so "If ..." part does not sound correct; perhaps you meant
> > "just in case egrep is aliased to something totally wacky" or
> > something?
> >
> > The script seems to use commands other than 'egrep' that too can be
> > aliased to do whatever unexpected things. How does this patch get
> > away without backslashing them all, like
> >
> > \echo ...
> > \sed ...
> > \test ...
> > \: comment ...
> > \git args ...
> >
> > and still fix problems for users? Can't the same solution you would
> > give to users who alias one of the above to do something undesirable
> > be applied to those who alias egrep?
> >
> > Puzzled...
>
> Sorry for having been more snarky than necessary (blame it to lack
> of caffeine). What I was trying to get at were:
>
> * I have this suspicion that this patch exists only because you saw
> somebody who aliases egrep to something unexpected by the use of
> it in this script, and egrep *happened* to be the only such
> "unreasonable" alias. The reporter may not have aliased echo or
> sed away, or the aliases to these command *happened* to produce
> "acceptable" output (even though it might have been slightly
> different from unaliased one, the difference *happened* not to
> matter for the purpose of this script).
>
> * To the person who observes the same aliasing breakage due to his
> aliasing sed to something else, you would solve his problem by
> telling him "don't do that, then". If that is the solution, why
> wouldn't it work for egrep?
>
> * The next person who aliased other commands this script uses in
> such a way that the behaviour of the alias differs sufficiently
> from the unaliased version, you will have to patch the file
> again, with the same backslashing. This patch is not a solution,
> but a band-aid that only works for a particular case you
> *happened* to have seen.
>
> * A complete solution that follows the direction this patch
> suggests would involve backslashing *all* commands that can
> potentially aliased away. Is that really the direction we would
> want to go in (answer: I doubt it)? Is that the only approach to
> solve this aliasing issue (answer: I don't know, but we should
> try to pursue it before applying a band-aid that is not a
> solution)?
>
> Is there a way to tell bash "do not alias-expand from here up to
> there"? Perhaps "shopt -u expand_aliases" upon entry and restore
> its original value when we exit, or something?
>
> IOW, something along this line?
This won't work, unfortunately, because shopt settings aren't inherited by
subshell (and for example egrep is called in subshell).
I discussed this issue with colleagues and we found basically two "fixes":
1. Tell people "do not use aliases which breaks completion script"
2. Prefix all commands with "command", i.e. `command egrep` etc.
In my opinion "2." is better long time solution, what do you think?
Regards, Adam
>
> contrib/completion/git-completion.bash | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git i/contrib/completion/git-completion.bash w/contrib/completion/git-completion.bash
> index 0b77eb1..193f53c 100644
> --- i/contrib/completion/git-completion.bash
> +++ w/contrib/completion/git-completion.bash
> @@ -23,6 +23,14 @@
> # 3) Consider changing your PS1 to also show the current branch,
> # see git-prompt.sh for details.
>
> +if shopt -q expand_aliases
> +then
> + _git__aliases_were_enabled=yes
> +else
> + _git__aliases_were_enabled=
> +fi
> +shopt -u expand_aliases
> +
> case "$COMP_WORDBREAKS" in
> *:*) : great ;;
> *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
> @@ -2504,3 +2512,8 @@ __git_complete gitk __gitk_main
> if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
> __git_complete git.exe __git_main
> fi
> +
> +if test -n "$_git__aliases_were_enabled"
> +then
> + shopt -s expand_aliases
> +fi
>
>
--
Adam Tkac, Red Hat, Inc.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
2012-12-06 14:05 ` Adam Tkac
@ 2012-12-06 18:01 ` Junio C Hamano
2012-12-12 22:34 ` Felipe Contreras
0 siblings, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2012-12-06 18:01 UTC (permalink / raw)
To: Adam Tkac; +Cc: git, SZEDER Gábor, Felipe Contreras
Adam Tkac <atkac@redhat.com> writes:
> On Thu, Nov 29, 2012 at 09:33:53AM -0800, Junio C Hamano wrote:
> ...
>> IOW, something along this line?
>
> This won't work, unfortunately, because shopt settings aren't inherited by
> subshell (and for example egrep is called in subshell).
>
> I discussed this issue with colleagues and we found basically two "fixes":
>
> 1. Tell people "do not use aliases which breaks completion script"
> 2. Prefix all commands with "command", i.e. `command egrep` etc.
>
> In my opinion "2." is better long time solution, what do you think?
Judging from what is in /etc/bash_completion.d/ (I am on Debian), I
think that others are divided. Many but not all prefix "command" in
front of "grep", but nobody does the same for "egrep", "cut", "tr",
"sed", etc.
If it were up to me, I would say we pick #1, but I cc'ed the people
who have been more involved in our bash-completion code because they
are in a better position to argue between the two than I am.
Thoughts?
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion
2012-12-06 18:01 ` Junio C Hamano
@ 2012-12-12 22:34 ` Felipe Contreras
0 siblings, 0 replies; 6+ messages in thread
From: Felipe Contreras @ 2012-12-12 22:34 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Adam Tkac, git, SZEDER Gábor
On Thu, Dec 6, 2012 at 12:01 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Adam Tkac <atkac@redhat.com> writes:
>
>> On Thu, Nov 29, 2012 at 09:33:53AM -0800, Junio C Hamano wrote:
>> ...
>>> IOW, something along this line?
>>
>> This won't work, unfortunately, because shopt settings aren't inherited by
>> subshell (and for example egrep is called in subshell).
>>
>> I discussed this issue with colleagues and we found basically two "fixes":
>>
>> 1. Tell people "do not use aliases which breaks completion script"
>> 2. Prefix all commands with "command", i.e. `command egrep` etc.
>>
>> In my opinion "2." is better long time solution, what do you think?
>
> Judging from what is in /etc/bash_completion.d/ (I am on Debian), I
> think that others are divided. Many but not all prefix "command" in
> front of "grep", but nobody does the same for "egrep", "cut", "tr",
> "sed", etc.
>
> If it were up to me, I would say we pick #1, but I cc'ed the people
> who have been more involved in our bash-completion code because they
> are in a better position to argue between the two than I am.
Why not both? I do prefer #1, but I don't see why we wouldn't prefix
some commonly problematic ones (\egrep), prefixing all of them seems
overkill for me.
--
Felipe Contreras
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2012-12-12 22:34 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-11-29 15:14 [PATCH v2] If `egrep` is aliased, temporary disable it in bash.completion Adam Tkac
2012-11-29 17:03 ` Junio C Hamano
2012-11-29 17:33 ` Junio C Hamano
2012-12-06 14:05 ` Adam Tkac
2012-12-06 18:01 ` Junio C Hamano
2012-12-12 22:34 ` Felipe Contreras
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).