git-commit-vandalism/contrib
SZEDER Gábor 424cce832d bash: support user-supplied completion scripts for user's git commands
The bash completion script already provides support to complete
aliases, options and refs for aliases (if the alias can be traced back
to a supported git command by __git_aliased_command()), and the user's
custom git commands, but it does not support the options of the user's
custom git commands (of course; how could it know about the options of
a custom git command?).  Users of such custom git commands could
extend git's bash completion script by writing functions to support
their commands, but they might have issues with it: they might not
have the rights to modify a system-wide git completion script, and
they will need to track and merge upstream changes in the future.

This patch addresses this by providing means for users to supply
custom completion scriplets for their custom git commands without
modifying the main git bash completion script.

Instead of having a huge hard-coded list of command-completion
function pairs (in _git()), the completion script will figure out
which completion function to call based on the command's name.  That
is, when completing the options of 'git foo', the main completion
script will check whether the function '_git_foo' is declared, and if
declared, it will invoke that function to perform the completion.  If
such a function is not declared, it will fall back to complete file
names.  So, users will only need to provide this '_git_foo' completion
function in a separate file, source that file, and it will be used the
next time they press TAB after 'git foo '.

There are two git commands (stage and whatchanged), for which the
completion functions of other commands were used, therefore they
got their own completion function.

Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-24 08:32:20 -08: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
completion bash: support user-supplied completion scripts for user's git commands 2010-02-24 08:32:20 -08: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-blame.el: Change how blame information is shown. 2009-09-29 10:06:56 -07:00
examples git merge -X<option> 2010-01-17 22:45:06 -08:00
fast-import git-p4: Fix sync errors due to new server version 2010-02-01 12:08:14 -08:00
gitview gitview: import only one of gtksourceview and gtksourceview2 2007-11-19 23:24:34 -08:00
hg-to-git hg-to-git: fix COMMITTER type-o 2010-01-12 13:18:27 -08:00
hooks Use 'fast-forward' all over the place 2009-10-24 23:50:28 -07:00
p4import Demote git-p4import to contrib status. 2007-07-15 15:23:37 -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
thunderbird-patch-inline Documentation: fix typos / spelling mistakes 2009-04-20 15:56:07 -07:00
vim contrib/vim: change URL to point to the latest syntax files 2009-01-12 23:36:03 -08:00
workdir Always show which directory is not a git repository 2008-12-21 18:46:41 -08:00
git-resurrect.sh contrib git-resurrect: find traces of a branch name and resurrect it 2009-02-04 15:07:49 -08: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