git-commit-vandalism/contrib
SZEDER Gábor 3bee6a4733 completion: don't declare 'local words' to make zsh happy
The "_get_comp_words_by_ref -n := words" command from the
bash_completion library reassembles a modified version of COMP_WORDS
with ':' and '=' no longer treated as word separators and stores it in
the ${words[@]} array.  Git's programmable tab completion script uses
this to abstract away the difference between bash v3's and bash v4's
definitions of COMP_WORDS (bash v3 used shell words, while bash v4
breaks at separator characters); see v1.7.4-rc0~11^2~2 (bash: get
--pretty=m<tab> completion to work with bash v4, 2010-12-02).

zsh has (or rather its completion functions have) another idea about
what ${words[@]} should contain: the array is prepopulated with the
words from the command it is completing.  For reasons that are not
well understood, when git-completion.bash reserves its own "words"
variable with "local words", the variable becomes empty and cannot be
changed from then on.  So the completion script neglects the arguments
it has seen, and words complete like git subcommand names.  For
example, typing "git log origi<TAB>" gives no completions because
there are no "git origi..." commands.

However, when this words variable is not declared as local but is just
populated by _get_comp_words_by_ref() and then read in various
completion functions, then zsh seems to be happy about it and our
completion script works as expected.

So, to get our completion script working again under zsh and to
prevent the words variable from leaking into the shell environment
under bash, we will only declare words as local when using bash.

Reported-by: Stefan Haller <lists@haller-berlin.de>
Suggested-by: Felipe Contreras <felipe.contreras@gmail.com>
Explained-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-04-28 09:40:21 -07:00
..
blameview War on whitespace 2007-06-07 00:04:01 -07:00
buildsystems msvc: Fix an "unrecognized option" linker warning 2010-01-22 16:15:14 -08:00
ciabot contrib/ciabot: git-describe commit instead of HEAD 2010-10-29 14:09:48 -07:00
completion completion: don't declare 'local words' to make zsh happy 2011-04-28 09:40:21 -07:00
continuous contrib/continuous: a continuous integration build manager 2007-03-19 22:21:19 -07:00
convert-objects Fix a bunch of pointer declarations (codestyle) 2009-05-01 15:17:31 -07:00
emacs git.el: Don't use font-lock-compile-keywords 2011-04-03 11:08:54 -07:00
examples cherry-pick/revert: add support for -X/--strategy-option 2010-12-28 11:27:56 -08:00
fast-import git-p4: replace each tab with 8 spaces for consistency 2011-04-07 00:37:45 -07:00
git-shell-commands Add sample commands for git-shell 2010-08-12 15:16:31 -07:00
gitview gitview: import only one of gtksourceview and gtksourceview2 2007-11-19 23:24:34 -08:00
hg-to-git Correct references to /usr/bin/python which does not exist on FreeBSD 2010-03-24 14:33:54 -07:00
hooks post-receive-email: suppress error if description file missing 2011-02-07 14:28:21 -08:00
p4import Correct references to /usr/bin/python which does not exist on FreeBSD 2010-03-24 14:33:54 -07:00
patches INSTALL: add warning on docbook-xsl 1.72 and 1.73 2007-08-04 01:55:08 -07:00
stats contrib: update packinfo.pl to not use dashed commands 2008-10-18 06:20:27 -07:00
svn-fe Merge commit 'jn/svn-fe' of git://github.com/gitster/git into svn-fe 2011-02-26 05:21:29 -06:00
thunderbird-patch-inline contrib/thunderbird-patch-inline: do not require bash to run the script 2011-03-30 12:29:39 -07:00
vim contrib/vim: change URL to point to the latest syntax files 2009-01-12 23:36:03 -08:00
workdir prefer test -h over test -L in shell scripts 2010-09-27 10:48:23 -07:00
git-resurrect.sh request-pull: protect against OPTIONS_KEEPDASHDASH from environment 2010-05-01 11:02:21 -07:00
README War on whitespace 2007-06-07 00:04:01 -07:00
remotes2config.sh contrib: Make remotes2config.sh script more robust 2007-12-04 14:35:08 -08:00
rerere-train.sh Add contrib/rerere-train script 2008-09-29 09:15:41 -07:00

Contributed Software

Although these pieces are available as part of the official git
source tree, they are in somewhat different status.  The
intention is to keep interesting tools around git here, maybe
even experimental ones, to give users an easier access to them,
and to give tools wider exposure, so that they can be improved
faster.

I am not expecting to touch these myself that much.  As far as
my day-to-day operation is concerned, these subdirectories are
owned by their respective primary authors.  I am willing to help
if users of these components and the contrib/ subtree "owners"
have technical/design issues to resolve, but the initiative to
fix and/or enhance things _must_ be on the side of the subtree
owners.  IOW, I won't be actively looking for bugs and rooms for
enhancements in them as the git maintainer -- I may only do so
just as one of the users when I want to scratch my own itch.  If
you have patches to things in contrib/ area, the patch should be
first sent to the primary author, and then the primary author
should ack and forward it to me (git pull request is nicer).
This is the same way as how I have been treating gitk, and to a
lesser degree various foreign SCM interfaces, so you know the
drill.

I expect that things that start their life in the contrib/ area
to graduate out of contrib/ once they mature, either by becoming
projects on their own, or moving to the toplevel directory.  On
the other hand, I expect I'll be proposing removal of disused
and inactive ones from time to time.

If you have new things to add to this area, please first propose
it on the git mailing list, and after a list discussion proves
there are some general interests (it does not have to be a
list-wide consensus for a tool targeted to a relatively narrow
audience -- for example I do not work with projects whose
upstream is svn, so I have no use for git-svn myself, but it is
of general interest for people who need to interoperate with SVN
repositories in a way git-svn works better than git-svnimport),
submit a patch to create a subdirectory of contrib/ and put your
stuff there.

-jc