git/contrib
Marc Khouzam 9673b8c392 tcsh-completion re-using git-completion.bash
The current tcsh-completion support for Git, as can be found on the
Internet, takes the approach of defining the possible completions
explicitly.  This has the obvious draw-back to require constant
updating as the Git code base evolves.

The approach taken by this commit is to to re-use the advanced bash
completion script and use its result for tcsh completion.  This is
achieved by sourcing the bash script and outputting the completion
result for tcsh consumption.

Three solutions were looked at to implement this approach with (C)
being retained:

  A) Modifications:
          git-completion.bash and new git-completion.tcsh

     Modify the existing git-completion.bash script to support
     being sourced using bash (as now), but also executed using bash.
     When being executed, the script will output the result of the
     computed completion to be re-used elsewhere (e.g., in tcsh).

     The modification to git-completion.bash is made not to be
     tcsh-specific, but to allow future users to also re-use its
     output.  Therefore, to be general, git-completion.bash accepts a
     second optional parameter, which is not used by tcsh, but could
     prove useful for other users.

     Pros:
       1- allows the git-completion.bash script to easily be re-used
       2- tcsh support is mostly isolated in git-completion.tcsh
     Cons (for tcsh users only):
       1- requires the user to copy both git-completion.tcsh and
          git-completion.bash to ${HOME}
       2- requires bash script to have a fixed name and location:
          ${HOME}/.git-completion.bash

  B) Modifications:
          git-completion.bash

     Modify the existing git-completion.bash script to support
     being sourced using bash (as now), but also executed using bash,
     and sourced using tcsh.

     Pros:
       1- only requires the user to deal with a single file
       2- maintenance more obvious for tcsh since it is entirely part
          of the same git-completion.bash script.
     Cons:
       1- tcsh support could affect bash support as they share the
          same script
       2- small tcsh section must use syntax suitable for both tcsh
          and bash and must be at the beginning of the script
       3- requires script to have a fixed name and location:
          ${HOME}/.git-completion.sh (for tcsh users only)

  C) Modifications:
          New git-completion.tcsh

     Provide a short tcsh script that generates another script
     which extends git-completion.bash.  This new script can be
     used by tcsh to perform completion.

     Pros:
       1- tcsh support is entirely isolated in git-completion.tcsh
       2- new tcsh script can be as complex as needed
     Cons (for tcsh users only):
       1- requires the user to copy both git-completion.tcsh and
          git-completion.bash to ${HOME}
       2- requires bash script to have a fixed name and location:
          ${HOME}/.git-completion.bash
       3- sourcing the new script will generate a third script

Approach (C) was selected avoid any modification to git-completion.bash.

Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
Reviewed-by: Felipe Contreras <felipe.contreras@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-11-16 12:01:24 -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
ciabot Make the ciabot scripts completely self-configuring in the normal case. 2012-08-23 20:58:24 -07:00
completion tcsh-completion re-using git-completion.bash 2012-11-16 12:01:24 -08:00
continuous contrib/continuous: a continuous integration build manager 2007-03-19 22:21:19 -07:00
convert-objects Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
credential Merge branch 'ph/credential-gnome-keyring' 2012-09-10 15:42:30 -07:00
diff-highlight diff-highlight: document some non-optimal cases 2012-02-13 15:57:07 -08:00
diffall contrib/diffall: fix cleanup trap on Windows 2012-03-14 15:22:38 -07:00
emacs Merge branch 'lm/git-blame-el' into maint 2012-08-06 15:37:54 -07:00
examples Merge branch 'jc/merge-bases' 2012-09-11 11:36:05 -07:00
fast-import git-p4: move to toplevel 2012-04-09 14:59:40 -07:00
git-jump git-jump: ignore (custom) prefix in diff mode 2012-09-17 12:31:57 -07:00
git-shell-commands Add sample commands for git-shell 2010-08-12 15:16:31 -07:00
gitview Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07: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 Fix spelling error in post-receive-email hook 2012-10-13 21:50:14 -07:00
mw-to-git git-remote-mediawiki: replace TODO-list in comment by appropriate link 2012-08-03 09:13:28 -07: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
persistent-https Add persistent-https to contrib 2012-05-30 13:50:45 -07:00
stats contrib: update packinfo.pl to not use dashed commands 2008-10-18 06:20:27 -07:00
subtree Fix git-subtree install instructions 2012-04-09 22:26:19 -05:00
svn-fe correct spelling: an URL -> a URL 2012-03-28 08:47:23 -07: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 contrib/rerere-train: use installed git-sh-setup 2012-04-30 12:50:38 -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