1
0
mirror of https://github.com/git/git.git synced 2024-10-21 16:18:11 +02:00
git/contrib
Marc Khouzam 4db42b3823 Completion must sort before using uniq
The user can be presented with invalid completion results
when trying to complete a 'git checkout' command.  This can happen
when using a branch name prefix that matches multiple remote branches.

For example, if available branches are:
  master
  remotes/GitHub/maint
  remotes/GitHub/master
  remotes/origin/maint
  remotes/origin/master

When performing completion on 'git checkout ma' the user will be
given the choices:
  maint
  master

However, 'git checkout maint' will fail in this case, although
completion previously said 'maint' was valid.  Furthermore, when
performing completion on 'git checkout mai', no choices will be
suggested.  So, the user is first told that the branch name
'maint' is valid, but when trying to complete 'mai' into 'maint',
that completion is no longer valid.

The completion results should never propose 'maint' as a valid
branch name, since 'git checkout' will refuse it.

The reason for this bug is that the uniq program only
works with sorted input.  The man page states
"uniq prints the unique lines in a sorted file".

When __git_refs uses the guess heuristic employed by checkout for
tracking branches it wants to consider remote branches but only if
the branch name is unique.  To do that, it calls 'uniq -u'.  However
the input given to 'uniq -u' is not sorted.

Therefore, in the above example, when dealing with 'git checkout ma',
"__git_refs '' 1" will find the following list:
  master
  maint
  master
  maint
  master

which, when passed to 'uniq -u' will remain the same.  Therefore
'maint' will be wrongly suggested as a valid option.

When dealing with 'git checkout mai', the list will be:
  maint
  maint

which happens to be sorted and will be emptied by 'uniq -u',
properly ignoring 'maint'.

A solution for preventing the completion script from suggesting
such invalid branch names is to first call 'sort' and then 'uniq -u'.

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-24 22:35:48 -08:00
..
blameview
buildsystems
ciabot Make the ciabot scripts completely self-configuring in the normal case. 2012-08-23 20:58:24 -07:00
completion Completion must sort before using uniq 2012-11-24 22:35:48 -08:00
continuous
convert-objects
credential Merge branch 'ph/credential-gnome-keyring' 2012-09-10 15:42:30 -07:00
diff-highlight
diffall
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
gitview
hg-to-git
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
patches
persistent-https Add persistent-https to contrib 2012-05-30 13:50:45 -07:00
stats
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
vim
workdir
git-resurrect.sh
README
remotes2config.sh
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