mirror of
https://github.com/git/git.git
synced 2025-01-08 16:43:56 +08:00
c7860507f0
Consistently with all other diff oriented commands, we have given paths relative to the work tree root in git-status output for a long time. This documents the recent behaviour change, as people's eyes (and worse yet, scripts, although scripts should not parse "git status" output) may depend on the old behaviour. In the longer run, giving a --full-name option to git-diff Porcelain similar to what ls-files has, and change the default for git-diff Porcelain to show relative paths may be a good thing to do, in order to hide the oddballness of this git-status behaviour, but that would have a rather large impact to established expectation by existing users. Signed-off-by: Junio C Hamano <gitster@pobox.com>
72 lines
1.9 KiB
Plaintext
72 lines
1.9 KiB
Plaintext
git-status(1)
|
|
=============
|
|
|
|
NAME
|
|
----
|
|
git-status - Show the working tree status
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
'git-status' <options>...
|
|
|
|
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_
|
|
commit by running 'git add' before running 'git
|
|
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.
|
|
|
|
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`.
|
|
|
|
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.
|
|
|
|
|
|
OUTPUT
|
|
------
|
|
The output from this command is designed to be used as a commit
|
|
template comments, and all the output lines are prefixed with '#'.
|
|
|
|
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).
|
|
|
|
|
|
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.
|
|
|
|
See Also
|
|
--------
|
|
gitlink:gitignore[5]
|
|
|
|
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
|
|
---
|
|
Part of the gitlink:git[7] suite
|