2005-09-08 00:26:23 +00:00
|
|
|
git-status(1)
|
|
|
|
=============
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2007-01-18 23:53:37 +00:00
|
|
|
git-status - Show the working tree status
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2009-08-15 09:27:39 +00:00
|
|
|
'git status' [<options>...] [--] [<pathspec>...]
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2007-12-08 09:00:31 +00:00
|
|
|
Displays paths that have differences between the index file and the
|
|
|
|
current HEAD commit, paths that have differences between the working
|
|
|
|
tree and the index file, and paths in the working tree that are not
|
2007-12-29 06:20:38 +00:00
|
|
|
tracked by git (and are not ignored by linkgit:gitignore[5]). The first
|
2007-12-08 09:00:31 +00:00
|
|
|
are what you _would_ commit by running `git commit`; the second and
|
2008-07-03 05:41:41 +00:00
|
|
|
third are what you _could_ commit by running 'git-add' before running
|
2007-12-08 09:00:31 +00:00
|
|
|
`git commit`.
|
2005-08-15 00:24:36 +00:00
|
|
|
|
2009-08-15 09:27:39 +00:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
|
|
|
-s::
|
|
|
|
--short::
|
|
|
|
Give the output in the short-format.
|
|
|
|
|
|
|
|
-u[<mode>]::
|
|
|
|
--untracked-files[=<mode>]::
|
|
|
|
Show untracked files (Default: 'all').
|
|
|
|
+
|
|
|
|
The mode parameter is optional, and is used to specify
|
|
|
|
the handling of untracked files. The possible options are:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
- 'no' - Show no untracked files
|
|
|
|
- 'normal' - Shows untracked files and directories
|
|
|
|
- 'all' - Also shows individual files in untracked directories.
|
|
|
|
--
|
|
|
|
+
|
|
|
|
See linkgit:git-config[1] for configuration variable
|
|
|
|
used to change the default for when the option is not
|
|
|
|
specified.
|
|
|
|
|
|
|
|
-z::
|
|
|
|
Terminate entries with NUL, instead of LF. This implies `-s`
|
|
|
|
(short status) output format.
|
2007-12-08 09:00:31 +00:00
|
|
|
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
OUTPUT
|
|
|
|
------
|
|
|
|
The output from this command is designed to be used as a commit
|
2007-12-08 09:00:31 +00:00
|
|
|
template comment, and all the output lines are prefixed with '#'.
|
2009-08-15 09:27:39 +00:00
|
|
|
The default, long format, is designed to be human readable,
|
|
|
|
verbose and descriptive. They are subject to change in any time.
|
2005-08-15 00:24:36 +00:00
|
|
|
|
2007-12-06 17:15:39 +00:00
|
|
|
The paths mentioned in the output, unlike many other git commands, are
|
2007-12-08 09:00:31 +00:00
|
|
|
made relative to the current directory if you are working in a
|
2007-12-07 21:26:07 +00:00
|
|
|
subdirectory (this is on purpose, to help cutting and pasting). See
|
|
|
|
the status.relativePaths config option below.
|
2007-12-06 17:15:39 +00:00
|
|
|
|
2009-08-15 09:27:39 +00:00
|
|
|
In short-format, the status of each path is shown as
|
|
|
|
|
|
|
|
XY PATH1 -> PATH2
|
|
|
|
|
|
|
|
where `PATH1` is the path in the `HEAD`, and ` -> PATH2` part is
|
|
|
|
shown only when `PATH1` corresponds to a different path in the
|
|
|
|
index/worktree (i.e. renamed).
|
|
|
|
|
|
|
|
For unmerged entries, `X` shows the status of stage #2 (i.e. ours) and `Y`
|
|
|
|
shows the status of stage #3 (i.e. theirs).
|
|
|
|
|
|
|
|
For entries that do not have conflicts, `X` shows the status of the index,
|
|
|
|
and `Y` shows the status of the work tree. For untracked paths, `XY` are
|
|
|
|
`??`.
|
|
|
|
|
|
|
|
X Y Meaning
|
|
|
|
-------------------------------------------------
|
|
|
|
[MD] not updated
|
|
|
|
M [ MD] updated in index
|
|
|
|
A [ MD] added to index
|
|
|
|
D [ MD] deleted from index
|
|
|
|
R [ MD] renamed in index
|
|
|
|
C [ MD] copied in index
|
|
|
|
[MARC] index and work tree matches
|
|
|
|
[ MARC] M work tree changed since index
|
|
|
|
[ MARC] D deleted in work tree
|
|
|
|
-------------------------------------------------
|
|
|
|
D D unmerged, both deleted
|
|
|
|
A U unmerged, added by us
|
|
|
|
U D unmerged, deleted by them
|
|
|
|
U A unmerged, added by them
|
|
|
|
D U unmerged, deleted by us
|
|
|
|
A A unmerged, both added
|
|
|
|
U U unmerged, both modified
|
|
|
|
-------------------------------------------------
|
|
|
|
? ? untracked
|
|
|
|
-------------------------------------------------
|
|
|
|
|
2005-08-15 00:24:36 +00:00
|
|
|
|
2007-01-17 09:11:01 +00:00
|
|
|
CONFIGURATION
|
|
|
|
-------------
|
|
|
|
|
|
|
|
The command honors `color.status` (or `status.color` -- they
|
|
|
|
mean the same thing and the latter is kept for backward
|
|
|
|
compatibility) and `color.status.<slot>` configuration variables
|
|
|
|
to colorize its output.
|
|
|
|
|
2007-12-07 21:26:07 +00:00
|
|
|
If the config variable `status.relativePaths` is set to false, then all
|
|
|
|
paths shown are relative to the repository root, not to the current
|
|
|
|
directory.
|
|
|
|
|
2008-04-12 15:05:32 +00:00
|
|
|
If `status.submodulesummary` is set to a non zero number or true (identical
|
|
|
|
to -1 or an unlimited number), the submodule summary will be enabled and a
|
|
|
|
summary of commits for modified submodules will be shown (see --summary-limit
|
|
|
|
option of linkgit:git-submodule[1]).
|
|
|
|
|
2008-05-28 23:55:27 +00:00
|
|
|
SEE ALSO
|
2007-06-02 17:08:54 +00:00
|
|
|
--------
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:gitignore[5]
|
2007-01-17 09:11:01 +00:00
|
|
|
|
2005-08-15 00:24:36 +00:00
|
|
|
Author
|
|
|
|
------
|
2009-08-15 09:27:39 +00:00
|
|
|
Written by Junio C Hamano <gitster@pobox.com>.
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
Documentation
|
|
|
|
--------------
|
|
|
|
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
|
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|