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
|
|
|
|
--------
|
2011-07-02 02:38:26 +00:00
|
|
|
[verse]
|
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
|
2013-01-21 19:17:53 +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
|
2010-01-09 23:33:00 +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.
|
|
|
|
|
2010-05-25 14:52:03 +00:00
|
|
|
-b::
|
|
|
|
--branch::
|
|
|
|
Show the branch and tracking info even in short-format.
|
|
|
|
|
2017-06-17 22:30:51 +00:00
|
|
|
--show-stash::
|
|
|
|
Show the number of entries currently stashed away.
|
|
|
|
|
2016-08-05 22:00:28 +00:00
|
|
|
--porcelain[=<version>]::
|
2011-05-27 02:31:51 +00:00
|
|
|
Give the output in an easy-to-parse format for scripts.
|
|
|
|
This is similar to the short output, but will remain stable
|
2013-01-21 19:17:53 +00:00
|
|
|
across Git versions and regardless of user configuration. See
|
2011-05-27 02:31:51 +00:00
|
|
|
below for details.
|
2016-08-05 22:00:28 +00:00
|
|
|
+
|
|
|
|
The version parameter is used to specify the format version.
|
|
|
|
This is optional and defaults to the original version 'v1' format.
|
2009-09-05 08:55:37 +00:00
|
|
|
|
2012-10-18 14:15:50 +00:00
|
|
|
--long::
|
|
|
|
Give the output in the long-format. This is the default.
|
|
|
|
|
2015-04-23 12:27:46 +00:00
|
|
|
-v::
|
|
|
|
--verbose::
|
|
|
|
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 `git diff --cached`). If `-v` is specified
|
|
|
|
twice, then also show the changes in the working tree that
|
|
|
|
have not yet been staged (i.e., like the output of `git diff`).
|
|
|
|
|
2009-08-15 09:27:39 +00:00
|
|
|
-u[<mode>]::
|
|
|
|
--untracked-files[=<mode>]::
|
2011-02-21 20:05:25 +00:00
|
|
|
Show untracked files.
|
2009-08-15 09:27:39 +00:00
|
|
|
+
|
2015-09-19 07:47:50 +00:00
|
|
|
The mode parameter is used to specify the handling of untracked files.
|
|
|
|
It is optional: it defaults to 'all', and if specified, it must be
|
|
|
|
stuck to the option (e.g. `-uno`, but not `-u no`).
|
2011-02-21 20:05:25 +00:00
|
|
|
+
|
|
|
|
The possible options are:
|
2009-08-15 09:27:39 +00:00
|
|
|
+
|
2013-03-15 16:53:48 +00:00
|
|
|
- 'no' - Show no untracked files.
|
|
|
|
- 'normal' - Shows untracked files and directories.
|
2009-08-15 09:27:39 +00:00
|
|
|
- 'all' - Also shows individual files in untracked directories.
|
|
|
|
+
|
2013-03-15 16:53:48 +00:00
|
|
|
When `-u` option is not used, untracked files and directories are
|
|
|
|
shown (i.e. the same as specifying `normal`), 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
|
2015-03-08 10:12:47 +00:00
|
|
|
time in a large working tree.
|
|
|
|
Consider enabling untracked cache and split index if supported (see
|
|
|
|
`git update-index --untracked-cache` and `git update-index
|
|
|
|
--split-index`), Otherwise you can use `no` to have `git status`
|
2013-03-15 16:53:48 +00:00
|
|
|
return more quickly without showing untracked files.
|
|
|
|
+
|
2011-02-21 20:05:25 +00:00
|
|
|
The default can be changed using the status.showUntrackedFiles
|
|
|
|
configuration variable documented in linkgit:git-config[1].
|
2009-08-15 09:27:39 +00:00
|
|
|
|
2010-06-25 14:56:47 +00:00
|
|
|
--ignore-submodules[=<when>]::
|
|
|
|
Ignore changes to submodules when looking for changes. <when> can be
|
2010-08-05 22:39:25 +00:00
|
|
|
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
|
2010-08-05 22:40:48 +00:00
|
|
|
'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
|
2010-06-25 14:56:47 +00:00
|
|
|
"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
|
2015-03-11 20:32:45 +00:00
|
|
|
`status.submoduleSummary` is set).
|
2010-06-25 14:56:47 +00:00
|
|
|
|
2017-10-30 17:21:39 +00:00
|
|
|
--ignored[=<mode>]::
|
2011-06-02 16:07:11 +00:00
|
|
|
Show ignored files as well.
|
2017-10-30 17:21:39 +00:00
|
|
|
+
|
|
|
|
The mode parameter is used to specify the handling of ignored files.
|
|
|
|
It is optional: it defaults to 'traditional'.
|
|
|
|
+
|
|
|
|
The possible options are:
|
|
|
|
+
|
|
|
|
- 'traditional' - Shows ignored files and directories, unless
|
|
|
|
--untracked-files=all is specifed, in which case
|
|
|
|
individual files in ignored directories are
|
|
|
|
displayed.
|
|
|
|
- 'no' - Show no ignored files.
|
|
|
|
- 'matching' - Shows ignored files and directories matching an
|
|
|
|
ignore pattern.
|
|
|
|
+
|
|
|
|
When 'matching' mode is specified, paths that explicity 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.
|
2011-06-02 16:07:11 +00:00
|
|
|
|
2009-08-15 09:27:39 +00:00
|
|
|
-z::
|
2009-09-05 08:55:37 +00:00
|
|
|
Terminate entries with NUL, instead of LF. This implies
|
2016-08-05 22:00:28 +00:00
|
|
|
the `--porcelain=v1` output format if no other format is given.
|
2007-12-08 09:00:31 +00:00
|
|
|
|
2012-04-13 10:54:39 +00:00
|
|
|
--column[=<options>]::
|
|
|
|
--no-column::
|
|
|
|
Display untracked files in columns. See configuration variable
|
|
|
|
column.status for option syntax.`--column` and `--no-column`
|
|
|
|
without options are equivalent to 'always' and 'never'
|
|
|
|
respectively.
|
|
|
|
|
2017-09-25 08:09:00 +00:00
|
|
|
<pathspec>...::
|
|
|
|
See the 'pathspec' entry in linkgit:gitglossary[7].
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
OUTPUT
|
|
|
|
------
|
|
|
|
The output from this command is designed to be used as a commit
|
2014-03-21 14:10:18 +00:00
|
|
|
template comment.
|
2009-08-15 09:27:39 +00:00
|
|
|
The default, long format, is designed to be human readable,
|
2011-05-27 02:31:11 +00:00
|
|
|
verbose and descriptive. Its contents and format are subject to change
|
|
|
|
at any time.
|
2005-08-15 00:24:36 +00:00
|
|
|
|
2013-01-21 19:17:53 +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
|
|
|
|
2011-05-27 02:31:51 +00:00
|
|
|
Short Format
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
2011-05-27 02:31:11 +00:00
|
|
|
In the short-format, the status of each path is shown as
|
2009-08-15 09:27:39 +00:00
|
|
|
|
|
|
|
XY PATH1 -> PATH2
|
|
|
|
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
|
2009-08-15 09:27:39 +00:00
|
|
|
shown only when `PATH1` corresponds to a different path in the
|
2014-10-19 14:17:15 +00:00
|
|
|
index/worktree (i.e. the file is renamed). The `XY` is a two-letter
|
2010-04-23 17:40:15 +00:00
|
|
|
status code.
|
|
|
|
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
The fields (including the `->`) are separated from each other by a
|
2010-04-23 17:40:15 +00:00
|
|
|
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.
|
|
|
|
|
2014-10-19 14:17:15 +00:00
|
|
|
For paths with merge conflicts, `X` and `Y` show the modification
|
2010-04-23 17:40:15 +00:00
|
|
|
states of each side of the merge. For paths that do not have merge
|
|
|
|
conflicts, `X` shows the status of the index, and `Y` shows the status
|
|
|
|
of the work tree. For untracked paths, `XY` are `??`. Other status
|
|
|
|
codes can be interpreted as follows:
|
|
|
|
|
|
|
|
* ' ' = unmodified
|
|
|
|
* 'M' = modified
|
|
|
|
* 'A' = added
|
|
|
|
* 'D' = deleted
|
|
|
|
* 'R' = renamed
|
|
|
|
* 'C' = copied
|
|
|
|
* 'U' = updated but unmerged
|
|
|
|
|
2011-06-30 00:03:12 +00:00
|
|
|
Ignored files are not listed, unless `--ignored` option is in effect,
|
|
|
|
in which case `XY` are `!!`.
|
2009-08-15 09:27:39 +00:00
|
|
|
|
|
|
|
X Y Meaning
|
|
|
|
-------------------------------------------------
|
|
|
|
[MD] not updated
|
|
|
|
M [ MD] updated in index
|
|
|
|
A [ MD] added to index
|
2010-04-23 17:40:15 +00:00
|
|
|
D [ M] deleted from index
|
2009-08-15 09:27:39 +00:00
|
|
|
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
|
2011-06-02 16:07:11 +00:00
|
|
|
! ! ignored
|
2009-08-15 09:27:39 +00:00
|
|
|
-------------------------------------------------
|
|
|
|
|
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 22:26:15 +00:00
|
|
|
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 `git add` in the superproject to prepare a commit.
|
|
|
|
|
2017-03-29 22:26:16 +00:00
|
|
|
'm' and '?' are applied recursively. For example if a nested submodule
|
|
|
|
in a submodule contains an untracked file, this is reported as '?' as well.
|
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 22:26:15 +00:00
|
|
|
|
2010-05-25 14:52:03 +00:00
|
|
|
If -b is used the short-format status is preceded by a line
|
|
|
|
|
2016-08-11 14:46:00 +00:00
|
|
|
## branchname tracking info
|
2010-05-25 14:52:03 +00:00
|
|
|
|
2016-08-11 14:46:00 +00:00
|
|
|
Porcelain Format Version 1
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2011-05-27 02:31:51 +00:00
|
|
|
|
2016-08-11 14:46:00 +00:00
|
|
|
Version 1 porcelain format is similar to the short format, but is guaranteed
|
2013-01-21 19:17:53 +00:00
|
|
|
not to change in a backwards-incompatible way between Git versions or
|
2011-05-27 02:31:51 +00:00
|
|
|
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:
|
|
|
|
|
|
|
|
1. The user's color.status configuration is not respected; color will
|
|
|
|
always be off.
|
|
|
|
|
|
|
|
2. The user's status.relativePaths configuration is not respected; paths
|
|
|
|
shown will always be relative to the repository root.
|
|
|
|
|
|
|
|
There is also an alternate -z format recommended for machine parsing. In
|
2010-04-23 17:40:15 +00:00
|
|
|
that format, the status field is the same, but some other things
|
2011-05-27 02:32:41 +00:00
|
|
|
change. First, the '\->' is omitted from rename entries and the field
|
|
|
|
order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
|
2010-04-23 17:40:15 +00:00
|
|
|
(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
|
2012-05-07 21:09:04 +00:00
|
|
|
backslash-escaping is performed.
|
2005-08-15 00:24:36 +00:00
|
|
|
|
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 22:26:15 +00:00
|
|
|
Any submodule changes are reported as modified `M` instead of `m` or single `?`.
|
|
|
|
|
2016-08-11 14:46:00 +00:00
|
|
|
Porcelain Format Version 2
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
Header lines start with "#" and are added in response to specific
|
|
|
|
command line arguments. Parsers should ignore headers they
|
|
|
|
don't recognize.
|
|
|
|
|
|
|
|
### Branch Headers
|
|
|
|
|
|
|
|
If `--branch` is given, a series of header lines are printed with
|
|
|
|
information about the current branch.
|
|
|
|
|
|
|
|
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.
|
|
|
|
------------------------------------------------------------
|
|
|
|
|
|
|
|
### Changed Tracked Entries
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
Ordinary changed entries have the following format:
|
|
|
|
|
|
|
|
1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
|
|
|
|
|
|
|
|
Renamed or copied entries have the following format:
|
|
|
|
|
|
|
|
2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
|
|
|
|
|
|
|
|
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 path in the index and in the working tree.
|
|
|
|
<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. This is only
|
|
|
|
present in a renamed/copied entry, and tells
|
|
|
|
where the renamed/copied contents came from.
|
|
|
|
--------------------------------------------------------
|
|
|
|
|
|
|
|
Unmerged entries have the following format; the first character is
|
|
|
|
a "u" to distinguish from ordinary changed entries.
|
|
|
|
|
|
|
|
u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
|
|
|
|
|
|
|
|
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.
|
|
|
|
--------------------------------------------------------
|
|
|
|
|
|
|
|
### Other Items
|
|
|
|
|
|
|
|
Following the tracked entries (and if requested), a series of
|
|
|
|
lines will be printed for untracked and then ignored items
|
|
|
|
found in the worktree.
|
|
|
|
|
|
|
|
Untracked items have the following format:
|
|
|
|
|
|
|
|
? <path>
|
|
|
|
|
|
|
|
Ignored items have the following format:
|
|
|
|
|
|
|
|
! <path>
|
|
|
|
|
|
|
|
### Pathname Format Notes and -z
|
|
|
|
|
|
|
|
When the `-z` option is given, pathnames are printed as is and
|
|
|
|
without any quoting and lines are terminated with a NUL (ASCII 0x00)
|
|
|
|
byte.
|
|
|
|
|
2017-03-02 19:03:52 +00:00
|
|
|
Without the `-z` option, pathnames with "unusual" characters are
|
|
|
|
quoted as explained for the configuration variable `core.quotePath`
|
|
|
|
(see linkgit:git-config[1]).
|
2016-08-11 14:46:00 +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
|
2009-11-26 15:24:38 +00:00
|
|
|
paths shown are relative to the repository root, not to the current
|
|
|
|
directory.
|
2007-12-07 21:26:07 +00:00
|
|
|
|
2015-03-11 20:32:45 +00:00
|
|
|
If `status.submoduleSummary` is set to a non zero number or true (identical
|
2009-09-05 08:52:18 +00:00
|
|
|
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
|
2013-09-11 19:07:15 +00:00
|
|
|
shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
|
|
|
|
that the summary output from the status command will be suppressed for all
|
|
|
|
submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
|
|
|
|
submodules where `submodule.<name>.ignore=all`. To also view the summary for
|
|
|
|
ignored submodules you can either use the --ignore-submodules=dirty command
|
|
|
|
line option or the 'git submodule summary' command, which shows a similar
|
|
|
|
output but does not honor these settings.
|
2008-04-12 15:05:32 +00:00
|
|
|
|
2017-11-27 06:04:12 +00:00
|
|
|
BACKGROUND REFRESH
|
|
|
|
------------------
|
|
|
|
|
|
|
|
By default, `git status` 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't
|
|
|
|
strictly necessary (`status` computes the values for itself, but writing
|
|
|
|
them out is just to save subsequent programs from repeating our
|
|
|
|
computation). When `status` is run in the background, the lock held
|
|
|
|
during the write may conflict with other simultaneous processes, causing
|
|
|
|
them to fail. Scripts running `status` in the background should consider
|
|
|
|
using `git --no-optional-locks status` (see linkgit:git[1] for details).
|
|
|
|
|
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
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|