blob: 577aca100b24615ed502a51cc7307e987393b902 [file] [log] [blame]
'\" t
.\" Title: git-status
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/18/2018
.\" Manual: Git Manual
.\" Source: Git 2.20.0.rc0
.\" Language: English
.\"
.TH "GIT\-STATUS" "1" "11/18/2018" "Git 2\&.20\&.0\&.rc0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-status \- Show the working tree status
.SH "SYNOPSIS"
.sp
.nf
\fIgit status\fR [<options>\&...] [\-\-] [<pathspec>\&...]
.fi
.sp
.SH "DESCRIPTION"
.sp
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 tracked by Git (and are not ignored by \fBgitignore\fR(5))\&. The first are what you \fIwould\fR commit by running \fBgit commit\fR; the second and third are what you \fIcould\fR commit by running \fIgit add\fR before running \fBgit commit\fR\&.
.SH "OPTIONS"
.PP
\-s, \-\-short
.RS 4
Give the output in the short\-format\&.
.RE
.PP
\-b, \-\-branch
.RS 4
Show the branch and tracking info even in short\-format\&.
.RE
.PP
\-\-show\-stash
.RS 4
Show the number of entries currently stashed away\&.
.RE
.PP
\-\-porcelain[=<version>]
.RS 4
Give the output in an easy\-to\-parse format for scripts\&. This is similar to the short output, but will remain stable across Git versions and regardless of user configuration\&. See below for details\&.
.sp
The version parameter is used to specify the format version\&. This is optional and defaults to the original version
\fIv1\fR
format\&.
.RE
.PP
\-\-long
.RS 4
Give the output in the long\-format\&. This is the default\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
In addition to the names of files that have been changed, also show the textual changes that are staged to be committed (i\&.e\&., like the output of
\fBgit diff \-\-cached\fR)\&. If
\fB\-v\fR
is specified twice, then also show the changes in the working tree that have not yet been staged (i\&.e\&., like the output of
\fBgit diff\fR)\&.
.RE
.PP
\-u[<mode>], \-\-untracked\-files[=<mode>]
.RS 4
Show untracked files\&.
.sp
The mode parameter is used to specify the handling of untracked files\&. It is optional: it defaults to
\fIall\fR, and if specified, it must be stuck to the option (e\&.g\&.
\fB\-uno\fR, but not
\fB\-u no\fR)\&.
.sp
The possible options are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIno\fR
\- Show no untracked files\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fInormal\fR
\- Shows untracked files and directories\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIall\fR
\- Also shows individual files in untracked directories\&.
.sp
When
\fB\-u\fR
option is not used, untracked files and directories are shown (i\&.e\&. the same as specifying
\fBnormal\fR), to help you avoid forgetting to add newly created files\&. Because it takes extra work to find untracked files in the filesystem, this mode may take some time in a large working tree\&. Consider enabling untracked cache and split index if supported (see
\fBgit update\-index \-\-untracked\-cache\fR
and
\fBgit update\-index \-\-split\-index\fR), Otherwise you can use
\fBno\fR
to have
\fBgit status\fR
return more quickly without showing untracked files\&.
.sp
The default can be changed using the status\&.showUntrackedFiles configuration variable documented in
\fBgit-config\fR(1)\&.
.RE
.RE
.PP
\-\-ignore\-submodules[=<when>]
.RS 4
Ignore changes to submodules when looking for changes\&. <when> can be either "none", "untracked", "dirty" or "all", which is the default\&. Using "none" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the
\fIignore\fR
option in
\fBgit-config\fR(1)
or
\fBgitmodules\fR(5)\&. When "untracked" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content)\&. Using "dirty" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior before 1\&.7\&.0)\&. Using "all" hides all changes to submodules (and suppresses the output of submodule summaries when the config option
\fBstatus\&.submoduleSummary\fR
is set)\&.
.RE
.PP
\-\-ignored[=<mode>]
.RS 4
Show ignored files as well\&.
.sp
The mode parameter is used to specify the handling of ignored files\&. It is optional: it defaults to
\fItraditional\fR\&.
.sp
The possible options are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fItraditional\fR
\- Shows ignored files and directories, unless \-\-untracked\-files=all is specified, in which case individual files in ignored directories are displayed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIno\fR
\- Show no ignored files\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fImatching\fR
\- Shows ignored files and directories matching an ignore pattern\&.
.sp
When
\fImatching\fR
mode is specified, paths that explicitly match an ignored pattern are shown\&. If a directory matches an ignore pattern, then it is shown, but not paths contained in the ignored directory\&. If a directory does not match an ignore pattern, but all contents are ignored, then the directory is not shown, but all contents are shown\&.
.RE
.RE
.PP
\-z
.RS 4
Terminate entries with NUL, instead of LF\&. This implies the
\fB\-\-porcelain=v1\fR
output format if no other format is given\&.
.RE
.PP
\-\-column[=<options>], \-\-no\-column
.RS 4
Display untracked files in columns\&. See configuration variable column\&.status for option syntax\&.\fB\-\-column\fR
and
\fB\-\-no\-column\fR
without options are equivalent to
\fIalways\fR
and
\fInever\fR
respectively\&.
.RE
.PP
\-\-ahead\-behind, \-\-no\-ahead\-behind
.RS 4
Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch\&. Defaults to true\&.
.RE
.PP
\-\-renames, \-\-no\-renames
.RS 4
Turn on/off rename detection regardless of user configuration\&. See also
\fBgit-diff\fR(1)
\fB\-\-no\-renames\fR\&.
.RE
.PP
\-\-find\-renames[=<n>]
.RS 4
Turn on rename detection, optionally setting the similarity threshold\&. See also
\fBgit-diff\fR(1)
\fB\-\-find\-renames\fR\&.
.RE
.PP
<pathspec>\&...
.RS 4
See the
\fIpathspec\fR
entry in
\fBgitglossary\fR(7)\&.
.RE
.SH "OUTPUT"
.sp
The output from this command is designed to be used as a commit template comment\&. The default, long format, is designed to be human readable, verbose and descriptive\&. Its contents and format are subject to change at any time\&.
.sp
The paths mentioned in the output, unlike many other Git commands, are made relative to the current directory if you are working in a subdirectory (this is on purpose, to help cutting and pasting)\&. See the status\&.relativePaths config option below\&.
.SS "Short Format"
.sp
In the short\-format, the status of each path is shown as one of these forms
.sp
.if n \{\
.RS 4
.\}
.nf
XY PATH
XY ORIG_PATH \-> PATH
.fi
.if n \{\
.RE
.\}
.sp
where \fBORIG_PATH\fR is where the renamed/copied contents came from\&. \fBORIG_PATH\fR is only shown when the entry is renamed or copied\&. The \fBXY\fR is a two\-letter status code\&.
.sp
The fields (including the \fB\->\fR) are separated from each other by a single space\&. If a filename contains whitespace or other nonprintable characters, that field will be quoted in the manner of a C string literal: surrounded by ASCII double quote (34) characters, and with interior special characters backslash\-escaped\&.
.sp
For paths with merge conflicts, \fBX\fR and \fBY\fR show the modification states of each side of the merge\&. For paths that do not have merge conflicts, \fBX\fR shows the status of the index, and \fBY\fR shows the status of the work tree\&. For untracked paths, \fBXY\fR are \fB??\fR\&. Other status codes can be interpreted as follows:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\(aq \(aq = unmodified
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIM\fR
= modified
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIA\fR
= added
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fID\fR
= deleted
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIR\fR
= renamed
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIC\fR
= copied
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIU\fR
= updated but unmerged
.RE
.sp
Ignored files are not listed, unless \fB\-\-ignored\fR option is in effect, in which case \fBXY\fR are \fB!!\fR\&.
.sp
.if n \{\
.RS 4
.\}
.nf
X Y Meaning
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
[AMD] not updated
M [ MD] updated in index
A [ MD] added to index
D 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] R renamed in work tree
[ D] C copied 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
! ! ignored
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.fi
.if n \{\
.RE
.\}
.sp
Submodules have more state and instead report M the submodule has a different HEAD than recorded in the index m the submodule has modified content ? the submodule has untracked files since modified content or untracked files in a submodule cannot be added via \fBgit add\fR in the superproject to prepare a commit\&.
.sp
\fIm\fR and \fI?\fR are applied recursively\&. For example if a nested submodule in a submodule contains an untracked file, this is reported as \fI?\fR as well\&.
.sp
If \-b is used the short\-format status is preceded by a line
.sp
.if n \{\
.RS 4
.\}
.nf
## branchname tracking info
.fi
.if n \{\
.RE
.\}
.SS "Porcelain Format Version 1"
.sp
Version 1 porcelain format is similar to the short format, but is guaranteed not to change in a backwards\-incompatible way between Git versions or based on user configuration\&. This makes it ideal for parsing by scripts\&. The description of the short format above also describes the porcelain format, with a few exceptions:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
The user\(cqs color\&.status configuration is not respected; color will always be off\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
The user\(cqs status\&.relativePaths configuration is not respected; paths shown will always be relative to the repository root\&.
.RE
.sp
There is also an alternate \-z format recommended for machine parsing\&. In that format, the status field is the same, but some other things change\&. First, the \fI\->\fR is omitted from rename entries and the field order is reversed (e\&.g \fIfrom \-> to\fR becomes \fIto from\fR)\&. Second, a NUL (ASCII 0) follows each filename, replacing space as a field separator and the terminating newline (but a space still separates the status field from the first filename)\&. Third, filenames containing special characters are not specially formatted; no quoting or backslash\-escaping is performed\&.
.sp
Any submodule changes are reported as modified \fBM\fR instead of \fBm\fR or single \fB?\fR\&.
.SS "Porcelain Format Version 2"
.sp
Version 2 format adds more detailed information about the state of the worktree and changed items\&. Version 2 also defines an extensible set of easy to parse optional headers\&.
.sp
Header lines start with "#" and are added in response to specific command line arguments\&. Parsers should ignore headers they don\(cqt recognize\&.
.sp
# Branch Headers
.sp
If \fB\-\-branch\fR is given, a series of header lines are printed with information about the current branch\&.
.sp
.if n \{\
.RS 4
.\}
.nf
Line Notes
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
# branch\&.oid <commit> | (initial) Current commit\&.
# branch\&.head <branch> | (detached) Current branch\&.
# branch\&.upstream <upstream_branch> If upstream is set\&.
# branch\&.ab +<ahead> \-<behind> If upstream is set and
the commit is present\&.
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.fi
.if n \{\
.RE
.\}
.sp
# Changed Tracked Entries
.sp
Following the headers, a series of lines are printed for tracked entries\&. One of three different line formats may be used to describe an entry depending on the type of change\&. Tracked entries are printed in an undefined order; parsers should allow for a mixture of the 3 line types in any order\&.
.sp
Ordinary changed entries have the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
.fi
.if n \{\
.RE
.\}
.sp
Renamed or copied entries have the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Field Meaning
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
<XY> A 2 character field containing the staged and
unstaged XY values described in the short format,
with unchanged indicated by a "\&." rather than
a space\&.
<sub> A 4 character field describing the submodule state\&.
"N\&.\&.\&." when the entry is not a submodule\&.
"S<c><m><u>" when the entry is a submodule\&.
<c> is "C" if the commit changed; otherwise "\&."\&.
<m> is "M" if it has tracked changes; otherwise "\&."\&.
<u> is "U" if there are untracked changes; otherwise "\&."\&.
<mH> The octal file mode in HEAD\&.
<mI> The octal file mode in the index\&.
<mW> The octal file mode in the worktree\&.
<hH> The object name in HEAD\&.
<hI> The object name in the index\&.
<X><score> The rename or copy score (denoting the percentage
of similarity between the source and target of the
move or copy)\&. For example "R100" or "C75"\&.
<path> The pathname\&. In a renamed/copied entry, this
is the target path\&.
<sep> When the `\-z` option is used, the 2 pathnames are separated
with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
byte separates them\&.
<origPath> The pathname in the commit at HEAD or in the index\&.
This is only present in a renamed/copied entry, and
tells where the renamed/copied contents came from\&.
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.fi
.if n \{\
.RE
.\}
.sp
Unmerged entries have the following format; the first character is a "u" to distinguish from ordinary changed entries\&.
.sp
.if n \{\
.RS 4
.\}
.nf
u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Field Meaning
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
<XY> A 2 character field describing the conflict type
as described in the short format\&.
<sub> A 4 character field describing the submodule state
as described above\&.
<m1> The octal file mode in stage 1\&.
<m2> The octal file mode in stage 2\&.
<m3> The octal file mode in stage 3\&.
<mW> The octal file mode in the worktree\&.
<h1> The object name in stage 1\&.
<h2> The object name in stage 2\&.
<h3> The object name in stage 3\&.
<path> The pathname\&.
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.fi
.if n \{\
.RE
.\}
.sp
# Other Items
.sp
Following the tracked entries (and if requested), a series of lines will be printed for untracked and then ignored items found in the worktree\&.
.sp
Untracked items have the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
? <path>
.fi
.if n \{\
.RE
.\}
.sp
Ignored items have the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
! <path>
.fi
.if n \{\
.RE
.\}
.sp
# Pathname Format Notes and \-z
.sp
When the \fB\-z\fR option is given, pathnames are printed as is and without any quoting and lines are terminated with a NUL (ASCII 0x00) byte\&.
.sp
Without the \fB\-z\fR option, pathnames with "unusual" characters are quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&.
.SH "CONFIGURATION"
.sp
The command honors \fBcolor\&.status\fR (or \fBstatus\&.color\fR \(em they mean the same thing and the latter is kept for backward compatibility) and \fBcolor\&.status\&.<slot>\fR configuration variables to colorize its output\&.
.sp
If the config variable \fBstatus\&.relativePaths\fR is set to false, then all paths shown are relative to the repository root, not to the current directory\&.
.sp
If \fBstatus\&.submoduleSummary\fR is set to a non zero number or true (identical to \-1 or an unlimited number), the submodule summary will be enabled for the long format and a summary of commits for modified submodules will be shown (see \-\-summary\-limit option of \fBgit-submodule\fR(1))\&. Please note that the summary output from the status command will be suppressed for all submodules when \fBdiff\&.ignoreSubmodules\fR is set to \fIall\fR or only for those submodules where \fBsubmodule\&.<name>\&.ignore=all\fR\&. To also view the summary for ignored submodules you can either use the \-\-ignore\-submodules=dirty command line option or the \fIgit submodule summary\fR command, which shows a similar output but does not honor these settings\&.
.SH "BACKGROUND REFRESH"
.sp
By default, \fBgit status\fR will automatically refresh the index, updating the cached stat information from the working tree and writing out the result\&. Writing out the updated index is an optimization that isn\(cqt strictly necessary (\fBstatus\fR computes the values for itself, but writing them out is just to save subsequent programs from repeating our computation)\&. When \fBstatus\fR is run in the background, the lock held during the write may conflict with other simultaneous processes, causing them to fail\&. Scripts running \fBstatus\fR in the background should consider using \fBgit \-\-no\-optional\-locks status\fR (see \fBgit\fR(1) for details)\&.
.SH "SEE ALSO"
.sp
\fBgitignore\fR(5)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite