Go to file
Ævar Arnfjörð Bjarmason 5cc044e025 get_short_oid: sort ambiguous objects by type, then SHA-1
Change the output emitted when an ambiguous object is encountered so
that we show tags first, then commits, followed by trees, and finally
blobs. Within each type we show objects in hashcmp() order. Before
this change the objects were only ordered by hashcmp().

The reason for doing this is that the output looks better as a result,
e.g. the v2.17.0 tag before this change on "git show e8f2" would
display:

    hint: The candidates are:
    hint:   e8f2093055 tree
    hint:   e8f21caf94 commit 2013-06-24 - bash prompt: print unique detached HEAD abbreviated object name
    hint:   e8f21d02f7 blob
    hint:   e8f21d577c blob
    hint:   e8f25a3a50 tree
    hint:   e8f26250fa commit 2017-02-03 - Merge pull request #996 from jeffhostetler/jeffhostetler/register_rename_src
    hint:   e8f2650052 tag v2.17.0
    hint:   e8f2867228 blob
    hint:   e8f28d537c tree
    hint:   e8f2a35526 blob
    hint:   e8f2bc0c06 commit 2015-05-10 - Documentation: note behavior for multiple remote.url entries
    hint:   e8f2cf6ec0 tree

Now we'll instead show:

    hint:   e8f2650052 tag v2.17.0
    hint:   e8f21caf94 commit 2013-06-24 - bash prompt: print unique detached HEAD abbreviated object name
    hint:   e8f26250fa commit 2017-02-03 - Merge pull request #996 from jeffhostetler/jeffhostetler/register_rename_src
    hint:   e8f2bc0c06 commit 2015-05-10 - Documentation: note behavior for multiple remote.url entries
    hint:   e8f2093055 tree
    hint:   e8f25a3a50 tree
    hint:   e8f28d537c tree
    hint:   e8f2cf6ec0 tree
    hint:   e8f21d02f7 blob
    hint:   e8f21d577c blob
    hint:   e8f2867228 blob
    hint:   e8f2a35526 blob

Since we show the commit data in the output that's nicely aligned once
we sort by object type. The decision to show tags before commits is
pretty arbitrary. I don't want to order by object_type since there
tags come last after blobs, which doesn't make sense if we want to
show the most important things first.

I could display them after commits, but it's much less likely that
we'll display a tag, so if there is one it makes sense to show it
prominently at the top.

A note on the implementation: Derrick rightly pointed out[1] that
we're bending over backwards here in get_short_oid() to first
de-duplicate the list, and then emit it, but could simply do it in one
step.

The reason for that is that oid_array_for_each_unique() doesn't
actually require that the array be sorted by oid_array_sort(), it just
needs to be sorted in some order that guarantees that all objects with
the same ID are adjacent to one another, which (barring a hash
collision, which'll be someone else's problem) the sort_ambiguous()
function does.

I agree that would be simpler for this code, and had forgotten why I
initially wrote it like this[2]. But on further reflection I think
it's better to do more work here just so we're not underhandedly using
the oid-array API where we lie about the list being sorted. That would
break any subsequent use of oid_array_lookup() in subtle ways.

I could get around that by hacking the API itself to support this
use-case and documenting it, which I did as a WIP patch in [3], but I
think it's too much code smell just for this one call site. It's
simpler for the API to just introduce a oid_array_for_each() function
to eagerly spew out the list without sorting or de-duplication, and
then do the de-duplication and sorting in two passes.

1. https://public-inbox.org/git/20180501130318.58251-1-dstolee@microsoft.com/
2. https://public-inbox.org/git/876047ze9v.fsf@evledraar.gmail.com/
3. https://public-inbox.org/git/874ljrzctc.fsf@evledraar.gmail.com/

Helped-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-05-11 14:43:23 +09:00
.github
Documentation get_short_oid: sort ambiguous objects by type, then SHA-1 2018-05-11 14:43:23 +09:00
block-sha1
builtin Merge branch 'sb/filenames-with-dashes' 2018-04-25 13:29:05 +09:00
ci
compat
contrib Merge branch 'sb/filenames-with-dashes' 2018-04-25 13:29:05 +09:00
ewah
git-gui Merge branch 'cb/git-gui-ttk-style' 2018-04-25 13:28:49 +09:00
gitk-git
gitweb
mergetools mergetools: add support for guiffy 2018-04-06 08:11:39 +09:00
perl git-svn: allow empty email-address using authors-prog and authors-file 2018-04-05 19:22:06 +00:00
po l10n: de.po: translate 132 new messages 2018-03-31 13:21:09 +02:00
ppc
refs refs: use chdir_notify to update cached relative paths 2018-03-30 12:50:03 -07:00
sha1collisiondetection@19d97bf5af
sha1dc
t get_short_oid: sort ambiguous objects by type, then SHA-1 2018-05-11 14:43:23 +09:00
templates
vcs-svn
xdiff
.clang-format
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
.tsan-suppressions
COPYING
GIT-VERSION-GEN The first batch for 2.18 cycle 2018-04-10 08:31:17 +09:00
INSTALL
LGPL-2.1
Makefile Merge branch 'jm/mem-pool' 2018-04-25 13:29:06 +09:00
README.md
RelNotes The first batch for 2.18 cycle 2018-04-10 08:31:17 +09:00
abspath.c
aclocal.m4
advice.c
advice.h
alias.c
alloc.c
apply.c Merge branch 'bc/object-id' 2018-04-10 08:25:45 +09:00
apply.h
archive-tar.c
archive-zip.c
archive.c
archive.h
argv-array.c
argv-array.h
attr.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
attr.h
base85.c
bisect.c Merge branch 'ys/bisect-object-id-missing-conversion-fix' 2018-04-10 16:28:24 +09:00
bisect.h
blame.c
blame.h
blob.c
blob.h
branch.c
branch.h
builtin.h
bulk-checkin.c Merge branch 'sb/packfiles-in-repository' 2018-04-11 13:09:55 +09:00
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'jk/relative-directory-fix' 2018-04-25 13:28:52 +09:00
chdir-notify.c add chdir-notify API 2018-03-30 12:49:57 -07:00
chdir-notify.h add chdir-notify API 2018-03-30 12:49:57 -07:00
check-builtins.sh
check-racy.c
check_bindir
checkout.c
checkout.h
color.c
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-slab.h
commit.c
commit.h
common-main.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
config.c Merge branch 'sb/filenames-with-dashes' 2018-04-25 13:29:05 +09:00
config.h
config.mak.in
config.mak.uname
configure.ac Merge branch 'es/fread-reads-dir-autoconf-fix' 2018-04-25 13:29:01 +09:00
connect.c
connect.h
connected.c
connected.h
convert.c
convert.h
copy.c
credential-cache--daemon.c
credential-cache.c
credential-store.c
credential.c credential: ignore SIGPIPE when writing to credential helpers 2018-03-29 15:33:55 -07:00
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c Merge branch 'lw/daemon-log-destination' 2018-04-25 13:28:58 +09:00
date.c
decorate.c
decorate.h
delta.h
diff-delta.c
diff-lib.c
diff-no-index.c
diff.c Merge branch 'bc/object-id' 2018-04-10 08:25:45 +09:00
diff.h
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c
dir.h
editor.c
entry.c
environment.c Merge branch 'jk/relative-directory-fix' 2018-04-25 13:28:52 +09:00
exec-cmd.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
exec-cmd.h exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
fast-import.c Merge branch 'jm/mem-pool' 2018-04-25 13:29:06 +09:00
fetch-object.c
fetch-object.h
fetch-pack.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
fetch-pack.h
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor.c Merge branch 'bp/fsmonitor-prime-index' 2018-04-25 13:29:04 +09:00
fsmonitor.h
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'pw/add-p-single' 2018-04-02 10:10:55 -07:00
git-archimport.perl
git-bisect.sh
git-compat-util.h
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh
git-filter-branch.sh Merge branch 'yk/filter-branch-non-committish-refs' 2018-04-10 16:28:23 +09:00
git-instaweb.sh
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh
git-mergetool.sh
git-p4.py git-p4: change "commitish" typo to "committish" 2018-05-11 12:09:55 +09:00
git-parse-remote.sh
git-quiltimport.sh
git-rebase--am.sh Merge branch 'pw/rebase-signoff' 2018-04-25 13:28:51 +09:00
git-rebase--interactive.sh Merge branch 'pw/rebase-signoff' 2018-04-25 13:28:51 +09:00
git-rebase--merge.sh Merge branch 'pw/rebase-signoff' 2018-04-25 13:28:51 +09:00
git-rebase.sh Merge branch 'pw/rebase-signoff' 2018-04-25 13:28:51 +09:00
git-remote-testgit.sh
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-stash.sh Merge branch 'tg/stash-untracked-with-pathspec-fix' 2018-04-10 08:25:45 +09:00
git-submodule.sh
git-svn.perl git-svn: search --authors-prog in PATH too 2018-04-05 06:55:02 +00:00
git-web--browse.sh
git.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c
grep.h
hash.h
hashmap.c
hashmap.h
help.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
help.h
hex.c
http-backend.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
http-fetch.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
http-push.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
http-walker.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
http.c Merge branch 'lv/tls-1.3' 2018-04-11 13:09:57 +09:00
http.h
ident.c
imap-send.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
iterator.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c
line-log.h
line-range.c
line-range.h
list-objects-filter-options.c
list-objects-filter-options.h
list-objects-filter.c sha1_name.c: rename to use dash in file name 2018-04-11 18:11:00 +09:00
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c
log-tree.h
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
mem-pool.c mem-pool: move reusable parts of memory pool into its own file 2018-04-12 11:55:20 +09:00
mem-pool.h mem-pool: move reusable parts of memory pool into its own file 2018-04-12 11:55:20 +09:00
merge-blobs.c
merge-blobs.h
merge-recursive.c Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
merge-recursive.h Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
merge.c
mergesort.c
mergesort.h
name-hash.c
notes-cache.c
notes-cache.h
notes-merge.c
notes-merge.h
notes-utils.c
notes-utils.h
notes.c
notes.h
object-store.h sha1_file: allow map_sha1_file to handle arbitrary repositories 2018-03-26 10:05:55 -07:00
object.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
object.h sha1_name.c: rename to use dash in file name 2018-04-11 18:11:00 +09:00
oidmap.c
oidmap.h
oidset.c
oidset.h
pack-bitmap-write.c
pack-bitmap.c packfile: keep prepare_packed_git() private 2018-03-26 10:07:43 -07:00
pack-bitmap.h
pack-check.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
pack-objects.c
pack-objects.h
pack-revindex.c object-store: move packed_git and packed_git_mru to object store 2018-03-26 10:05:46 -07:00
pack-revindex.h
pack-write.c
pack.h
packfile.c Merge branch 'sb/packfiles-in-repository' 2018-04-11 13:09:55 +09:00
packfile.h Merge branch 'sb/packfiles-in-repository' 2018-04-11 13:09:55 +09:00
pager.c
parse-options-cb.c
parse-options.c Merge branch 'ps/contains-id-error-message' 2018-04-10 16:28:20 +09:00
parse-options.h Merge branch 'ps/contains-id-error-message' 2018-04-10 16:28:20 +09:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c repository: introduce raw object store field 2018-03-23 11:06:01 -07:00
path.h
pathspec.c
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c
pretty.c
pretty.h
prio-queue.c
prio-queue.h
progress.c
progress.h
prompt.c
prompt.h
protocol.c
protocol.h
quote.c
quote.h
reachable.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
reachable.h
read-cache.c Merge branch 'bc/object-id' 2018-04-10 08:25:45 +09:00
ref-filter.c Merge branch 'jk/ref-array-push' 2018-04-25 13:28:59 +09:00
ref-filter.h ref-filter: factor ref_array pushing into its own function 2018-04-09 06:14:46 +09:00
reflog-walk.c
reflog-walk.h
refs.c
refs.h
remote-curl.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
remote-testsvn.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
remote.c
remote.h
replace-object.c replace_object.c: rename to use dash in file name 2018-04-11 18:11:00 +09:00
repository.c repository: introduce raw object store field 2018-03-23 11:06:01 -07:00
repository.h repository: introduce raw object store field 2018-03-23 11:06:01 -07:00
rerere.c Merge branch 'bc/object-id' 2018-04-10 08:25:45 +09:00
rerere.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'jk/cached-commit-buffer' into maint 2018-03-22 14:24:25 -07:00
revision.h
run-command.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
run-command.h
send-pack.c
send-pack.h
sequencer.c Merge branch 'sb/filenames-with-dashes' 2018-04-25 13:29:05 +09:00
sequencer.h
server-info.c packfile: keep prepare_packed_git() private 2018-03-26 10:07:43 -07:00
setup.c Merge branch 'jk/relative-directory-fix' 2018-04-25 13:28:52 +09:00
sh-i18n--envsubst.c
sha1-array.c get_short_oid: sort ambiguous objects by type, then SHA-1 2018-05-11 14:43:23 +09:00
sha1-array.h get_short_oid: sort ambiguous objects by type, then SHA-1 2018-05-11 14:43:23 +09:00
sha1-file.c sha1_file.c: rename to use dash in file name 2018-04-11 18:11:00 +09:00
sha1-lookup.c
sha1-lookup.h
sha1-name.c get_short_oid: sort ambiguous objects by type, then SHA-1 2018-05-11 14:43:23 +09:00
sha1dc_git.c
sha1dc_git.h
shallow.c
shell.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
shortlog.h
show-index.c
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c
split-index.h
strbuf.c Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
strbuf.h Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
streaming.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
streaming.h
string-list.c
string-list.h
sub-process.c
sub-process.h
submodule-config.c
submodule-config.h
submodule.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
submodule.h
symlinks.c
tag.c
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c object-store: migrate alternates struct and functions from cache.h 2018-03-23 11:06:01 -07:00
tmp-objdir.h
trace.c trace.c: export trace_setup_key 2018-03-30 12:49:57 -07:00
trace.h trace.c: export trace_setup_key 2018-03-30 12:49:57 -07:00
trailer.c
trailer.h
transport-helper.c
transport-internal.h
transport.c Merge branch 'sb/object-store' 2018-04-11 13:09:55 +09:00
transport.h
tree-diff.c
tree-walk.c
tree-walk.h
tree.c
tree.h
unicode-width.h unicode_width.h: rename to use dash in file name 2018-04-11 18:11:00 +09:00
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
unpack-trees.h Revert "Merge branch 'en/rename-directory-detection'" 2018-04-11 18:07:11 +09:00
upload-pack.c exec_cmd: rename to use dash in file name 2018-04-11 18:11:00 +09:00
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c
userdiff.h
utf8.c unicode_width.h: rename to use dash in file name 2018-04-11 18:11:00 +09:00
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c
worktree.h
wrap-for-bin.sh
wrapper.c
write-or-die.c write_or_die.c: rename to use dashes in file name 2018-04-11 18:11:00 +09:00
ws.c
wt-status.c
wt-status.h
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

Git - fast, scalable, distributed revision control system

Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.

Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.

Please read the file INSTALL for installation instructions.

Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.

See Documentation/gittutorial.txt to get started, then see Documentation/giteveryday.txt for a useful minimum set of commands, and Documentation/git-.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.

CVS users may also want to read Documentation/gitcvs-migration.txt (man gitcvs-migration or git help cvs-migration if git is installed).

The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. The mailing list archives are available at https://public-inbox.org/git/, http://marc.info/?l=git and other archival sites.

The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

  • random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
  • stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
  • "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
  • "goddamn idiotic truckload of sh*t": when it breaks