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
|
|
|
|
--------
|
2006-08-08 05:41:32 +00:00
|
|
|
'git-status' <options>...
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
Examines paths in the working tree that has changes unrecorded
|
|
|
|
to the index file, and changes between the index file and the
|
|
|
|
current HEAD commit. The former paths are what you _could_
|
2007-02-17 09:43:42 +00:00
|
|
|
commit by running 'git add' before running 'git
|
2005-08-15 00:24:36 +00:00
|
|
|
commit', and the latter paths are what you _would_ commit by
|
|
|
|
running 'git commit'.
|
|
|
|
|
|
|
|
If there is no path that is different between the index file and
|
|
|
|
the current HEAD commit, the command exits with non-zero
|
|
|
|
status.
|
|
|
|
|
2006-08-08 05:41:32 +00:00
|
|
|
The command takes the same set of options as `git-commit`; it
|
|
|
|
shows what would be committed if the same options are given to
|
|
|
|
`git-commit`.
|
|
|
|
|
2007-08-07 05:57:47 +00:00
|
|
|
If any paths have been touched in the working tree (that is,
|
|
|
|
their modification times have changed) but their contents and
|
|
|
|
permissions are identical to those in the index file, the command
|
|
|
|
updates the index file. Running `git-status` can thus speed up
|
|
|
|
subsequent operations such as `git-diff` if the working tree
|
|
|
|
contains many paths that have been touched but not modified.
|
|
|
|
|
2005-08-15 00:24:36 +00:00
|
|
|
|
|
|
|
OUTPUT
|
|
|
|
------
|
|
|
|
The output from this command is designed to be used as a commit
|
|
|
|
template comments, and all the output lines are prefixed with '#'.
|
|
|
|
|
2007-12-06 17:15:39 +00:00
|
|
|
The paths mentioned in the output, unlike many other git commands, are
|
|
|
|
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
|
|
|
|
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.
|
|
|
|
|
2007-06-02 17:08:54 +00:00
|
|
|
See Also
|
|
|
|
--------
|
|
|
|
gitlink:gitignore[5]
|
2007-01-17 09:11:01 +00:00
|
|
|
|
2005-08-15 00:24:36 +00:00
|
|
|
Author
|
|
|
|
------
|
|
|
|
Written by Linus Torvalds <torvalds@osdl.org> and
|
|
|
|
Junio C Hamano <junkio@cox.net>.
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
--------------
|
|
|
|
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
|
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2005-09-19 10:10:51 +00:00
|
|
|
Part of the gitlink:git[7] suite
|