Go to file
Stefan Beller dd6962dd73 short status: improve reporting for submodule changes
If I add an untracked file to a submodule or modify a tracked file,
currently "git status --short" treats the change in the same way as
changes to the current HEAD of the submodule:

        $ git clone --quiet --recurse-submodules https://gerrit.googlesource.com/gerrit
        $ echo hello >gerrit/plugins/replication/stray-file
        $ sed -i -e 's/.*//' gerrit/plugins/replication/.mailmap
        $ git -C gerrit status --short
         M plugins/replication

This is by analogy with ordinary files, where "M" represents a change
that has not been added yet to the index.  But this change cannot be
added to the index without entering the submodule, "git add"-ing it,
and running "git commit", so the analogy is counterproductive.

Introduce new status letters " ?" and " m" for this.  These are similar
to the existing "??" and " M" but mean that the submodule (not the
parent project) has new untracked files and modified files, respectively.
The user can use "git add" and "git commit" from within the submodule to
add them.

Changes to the submodule's HEAD commit can be recorded in the index with
a plain "git add -u" and are shown with " M", like today.

To avoid excessive clutter, show at most one of " ?", " m", and " M" for
the submodule.  They represent increasing levels of change --- the last
one that applies is shown (e.g., " m" if there are both modified files
and untracked files in the submodule, or " M" if the submodule's HEAD
has been modified and it has untracked files).

While making these changes, we need to make sure to not break porcelain
level 1, which shares code with "status --short".  We only change
"git status --short".

Non-short "git status" and "git status --porcelain=2" already handle
these cases by showing more detail:

        $ git -C gerrit status --porcelain=2
        1 .M S.MU 160000 160000 160000 305c864db28eb0c77c8499bc04c87de3f849cf3c 305c864db28eb0c77c8499bc04c87de3f849cf3c plugins/replication
        $ git -C gerrit status
[...]
        modified:   plugins/replication (modified content, untracked content)

Scripts caring about these distinctions should use --porcelain=2.

Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-29 15:27:54 -07:00
Documentation short status: improve reporting for submodule changes 2017-03-29 15:27:54 -07:00
block-sha1
builtin Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
ci Travis: also test on 32-bit Linux 2017-03-06 11:19:09 -08:00
compat
contrib Merge branch 'mg/prompt-describe-tags' 2017-03-21 15:07:17 -07:00
ewah Merge branch 'jk/ewah-use-right-type-in-sizeof' into maint 2017-03-21 15:03:24 -07:00
git-gui
gitk-git
gitweb
mergetools
perl
po
ppc
refs Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
t short status: improve reporting for submodule changes 2017-03-29 15:27:54 -07:00
templates
vcs-svn
xdiff
.gitattributes
.gitignore
.mailmap
.travis.yml Travis: also test on 32-bit Linux 2017-03-06 11:19:09 -08:00
COPYING
GIT-VERSION-GEN Preparing for 2.12.1 2017-03-16 14:01:20 -07:00
INSTALL
LGPL-2.1
Makefile Merge branch 'bc/sha1-header-selection-with-cpp-macros' 2017-03-17 13:50:27 -07:00
README.md README: create HTTP/HTTPS links from URLs in Markdown 2017-03-01 14:45:45 -08:00
RelNotes Prepare for 2.12.2 2017-03-21 15:04:12 -07:00
abspath.c real_pathdup(): fix callsites that wanted it to die on error 2017-03-08 14:38:41 -08:00
aclocal.m4
advice.c
advice.h
alias.c
alloc.c
apply.c
apply.h
archive-tar.c
archive-zip.c
archive.c
archive.h
argv-array.c
argv-array.h
attr.c pathspec: allow querying for attributes 2017-03-13 15:28:54 -07:00
attr.h pathspec: allow querying for attributes 2017-03-13 15:28:54 -07:00
base85.c
bisect.c Merge branch 'mm/two-more-xstrfmt' into maint 2017-03-16 13:56:43 -07:00
bisect.h
blob.c
blob.h
branch.c
branch.h
builtin.h
bulk-checkin.c
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
check-builtins.sh
check-racy.c
check_bindir
color.c
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-slab.h
commit.c Merge branch 'rs/commit-parsing-optim' into maint 2017-03-21 15:03:29 -07:00
commit.h Merge branch 'rs/log-email-subject' 2017-03-10 13:24:24 -08:00
common-main.c
config.c Merge branch 'nd/conditional-config-include' 2017-03-21 15:07:18 -07:00
config.mak.in
config.mak.uname Merge branch 'rj/remove-unused-mktemp' into maint 2017-03-21 15:03:24 -07:00
configure.ac wrapper.c: remove unused gitmkstemps() function 2017-02-28 11:54:21 -08: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.h
csum-file.c
csum-file.h
ctype.c
daemon.c
date.c
decorate.c
decorate.h
delta.h
diff-delta.c
diff-lib.c
diff-no-index.c
diff.c Merge branch 'jc/diff-populate-filespec-size-only-fix' into maint 2017-03-21 15:03:26 -07: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 Merge branch 'bw/attr-pathspec' 2017-03-17 13:50:26 -07:00
dir.h
editor.c
entry.c
environment.c Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
exec_cmd.c
exec_cmd.h
fast-import.c Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
fetch-pack.c Merge branch 'mm/fetch-show-error-message-on-unadvertised-object' 2017-03-14 15:23:18 -07:00
fetch-pack.h fetch-pack: move code to report unmatched refs to a function 2017-03-02 11:12:53 -08:00
fmt-merge-msg.h
fsck.c
fsck.h
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'jk/add-i-use-pathspecs' 2017-03-17 13:50:26 -07:00
git-archimport.perl
git-bisect.sh
git-compat-util.h Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh
git-filter-branch.sh filter-branch: fix --prune-empty on parentless commits 2017-03-03 12:43:37 -08: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-parse-remote.sh
git-quiltimport.sh
git-rebase--am.sh
git-rebase--interactive.sh
git-rebase--merge.sh
git-rebase.sh
git-remote-testgit.sh
git-request-pull.sh
git-send-email.perl Merge branch 'jh/send-email-one-cc' into maint 2017-03-21 15:03:30 -07:00
git-sh-i18n.sh
git-sh-setup.sh
git-stash.sh stash: allow pathspecs in the no verb form 2017-02-28 14:21:10 -08:00
git-submodule.sh
git-svn.perl git svn: fix authentication with 'branch' 2017-03-07 21:29:03 +00:00
git-web--browse.sh
git.c
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c
grep.h
hash.h hash.h: move SHA-1 implementation selection into a header file 2017-03-15 11:00:09 -07:00
hashmap.c
hashmap.h
help.c
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c
http-walker.c Merge branch 'jk/http-walker-buffer-underflow-fix' 2017-03-17 13:50:26 -07:00
http.c Merge branch 'jt/http-base-url-update-upon-redirect' into maint 2017-03-16 13:56:42 -07:00
http.h
ident.c
imap-send.c
iterator.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c Merge branch 'vn/line-log-memcpy-size-fix' into maint 2017-03-16 13:56:42 -07:00
line-log.h
line-range.c
line-range.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c pretty: use fmt_output_email_subject() 2017-03-01 15:09:17 -08:00
log-tree.h pretty: use fmt_output_email_subject() 2017-03-01 15:09:17 -08:00
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
merge-blobs.c
merge-blobs.h
merge-recursive.c
merge-recursive.h
merge.c
mergesort.c
mergesort.h
mru.c
mru.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.c
object.h
oidset.c
oidset.h
pack-bitmap-write.c
pack-bitmap.c
pack-bitmap.h
pack-check.c
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
pager.c setup: make read_early_config() reusable 2017-03-14 14:24:16 -07:00
parse-options-cb.c
parse-options.c
parse-options.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c
pathspec.c pathspec: allow escaped query values 2017-03-13 15:28:56 -07:00
pathspec.h pathspec: allow querying for attributes 2017-03-13 15:28:54 -07:00
pkt-line.c
pkt-line.h
preload-index.c
pretty.c Merge branch 'rs/log-email-subject' 2017-03-10 13:24:24 -08:00
prio-queue.c
prio-queue.h
progress.c
progress.h
prompt.c
prompt.h
quote.c
quote.h
reachable.c
reachable.h
read-cache.c Merge branch 'cc/split-index-config' 2017-03-17 13:50:23 -07:00
ref-filter.c Merge branch 'jk/ref-filter-flags-cleanup' 2017-03-17 13:50:25 -07:00
ref-filter.h ref-filter: move ref_cbdata definition into ref-filter.c 2017-03-10 11:51:30 -08:00
reflog-walk.c
reflog-walk.h
refs.c Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
refs.h Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
remote-curl.c
remote-testsvn.c
remote.c Merge branch 'jn/remote-helpers-with-git-dir' 2017-02-27 13:57:16 -08:00
remote.h Merge branch 'mm/fetch-show-error-message-on-unadvertised-object' 2017-03-14 15:23:18 -07:00
replace_object.c
rerere.c
rerere.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
revision.h
run-command.c
run-command.h
send-pack.c send-pack: report signal death of pack-objects 2017-03-07 14:58:36 -08:00
send-pack.h
sequencer.c sequencer: fix missing newline 2017-03-23 11:19:23 -07:00
sequencer.h
server-info.c
setup.c Merge branch 'js/early-config' 2017-03-17 13:50:28 -07:00
sh-i18n--envsubst.c
sha1-array.c
sha1-array.h
sha1-lookup.c
sha1-lookup.h
sha1_file.c Merge branch 'jk/pack-name-cleanups' 2017-03-21 15:07:17 -07:00
sha1_name.c Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
shallow.c
shell.c
shortlog.h
show-index.c
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c split-index: add {add,remove}_split_index() functions 2017-03-01 13:24:21 -08:00
split-index.h split-index: add {add,remove}_split_index() functions 2017-03-01 13:24:21 -08:00
strbuf.c
strbuf.h Merge branch 'jk/interpret-branch-name' 2017-03-14 15:23:18 -07:00
streaming.c
streaming.h
string-list.c
string-list.h
submodule-config.c Merge branch 'sb/submodule-config-parse-ignore-fix' 2017-03-21 15:07:17 -07:00
submodule-config.h
submodule.c submodule.c: stricter checking for submodules in is_submodule_modified 2017-03-27 09:48:19 -07:00
submodule.h rev-parse: add --show-superproject-working-tree 2017-03-08 15:52:03 -08:00
symlinks.c
tag.c
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c
trace.h
trailer.c
trailer.h
transport-helper.c Merge branch 'jn/remote-helpers-with-git-dir' 2017-02-27 13:57:16 -08:00
transport.c Merge branch 'bc/object-id' 2017-03-17 13:50:25 -07:00
transport.h
tree-diff.c
tree-walk.c
tree-walk.h
tree.c
tree.h
unicode_width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c
unpack-trees.h
upload-pack.c
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c
userdiff.h
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c Merge branch 'js/realpath-pathdup-fix' 2017-03-12 23:21:33 -07:00
worktree.h
wrap-for-bin.sh
wrapper.c wrapper.c: remove unused gitmkstemps() function 2017-02-28 11:54:21 -08:00
write_or_die.c
ws.c
wt-status.c short status: improve reporting for submodule changes 2017-03-29 15:27:54 -07:00
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