]> rtime.felk.cvut.cz Git - git.git/blob - Documentation/git-status.txt
Merge branch 'pr/mergetool'
[git.git] / Documentation / git-status.txt
1 git-status(1)
2 =============
3
4 NAME
5 ----
6 git-status - Show the working tree status
7
8
9 SYNOPSIS
10 --------
11 'git-status' <options>...
12
13 DESCRIPTION
14 -----------
15 Displays paths that have differences between the index file and the
16 current HEAD commit, paths that have differences between the working
17 tree and the index file, and paths in the working tree that are not
18 tracked by git (and are not ignored by gitlink:gitignore[5]). The first
19 are what you _would_ commit by running `git commit`; the second and
20 third are what you _could_ commit by running `git add` before running
21 `git commit`.
22
23 The command takes the same set of options as `git-commit`; it
24 shows what would be committed if the same options are given to
25 `git-commit`.
26
27 If there is no path that is different between the index file and
28 the current HEAD commit (i.e., there is nothing to commit by running
29 `git-commit`), the command exits with non-zero status.
30
31 If any paths have been touched in the working tree (that is,
32 their modification times have changed) but their contents and
33 permissions are identical to those in the index file, the command
34 updates the index file. Running `git-status` can thus speed up
35 subsequent operations such as `git-diff` if the working tree
36 contains many paths that have been touched but not modified.
37
38
39 OUTPUT
40 ------
41 The output from this command is designed to be used as a commit
42 template comment, and all the output lines are prefixed with '#'.
43
44 The paths mentioned in the output, unlike many other git commands, are
45 made relative to the current directory if you are working in a
46 subdirectory (this is on purpose, to help cutting and pasting). See
47 the status.relativePaths config option below.
48
49
50 CONFIGURATION
51 -------------
52
53 The command honors `color.status` (or `status.color` -- they
54 mean the same thing and the latter is kept for backward
55 compatibility) and `color.status.<slot>` configuration variables
56 to colorize its output.
57
58 If the config variable `status.relativePaths` is set to false, then all
59 paths shown are relative to the repository root, not to the current
60 directory.
61
62 See Also
63 --------
64 gitlink:gitignore[5]
65
66 Author
67 ------
68 Written by Linus Torvalds <torvalds@osdl.org> and
69 Junio C Hamano <junkio@cox.net>.
70
71 Documentation
72 --------------
73 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
74
75 GIT
76 ---
77 Part of the gitlink:git[7] suite