Merge branch 'rs/worktree-list-show-locked'
[git] / Documentation / config / status.txt
1 status.relativePaths::
2         By default, linkgit:git-status[1] shows paths relative to the
3         current directory. Setting this variable to `false` shows paths
4         relative to the repository root (this was the default for Git
5         prior to v1.5.4).
6
7 status.short::
8         Set to true to enable --short by default in linkgit:git-status[1].
9         The option --no-short takes precedence over this variable.
10
11 status.branch::
12         Set to true to enable --branch by default in linkgit:git-status[1].
13         The option --no-branch takes precedence over this variable.
14
15 status.aheadBehind::
16         Set to true to enable `--ahead-behind` and false to enable
17         `--no-ahead-behind` by default in linkgit:git-status[1] for
18         non-porcelain status formats.  Defaults to true.
19
20 status.displayCommentPrefix::
21         If set to true, linkgit:git-status[1] will insert a comment
22         prefix before each output line (starting with
23         `core.commentChar`, i.e. `#` by default). This was the
24         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
25         Defaults to false.
26
27 status.renameLimit::
28         The number of files to consider when performing rename detection
29         in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
30         the value of diff.renameLimit.
31
32 status.renames::
33         Whether and how Git detects renames in linkgit:git-status[1] and
34         linkgit:git-commit[1] .  If set to "false", rename detection is
35         disabled. If set to "true", basic rename detection is enabled.
36         If set to "copies" or "copy", Git will detect copies, as well.
37         Defaults to the value of diff.renames.
38
39 status.showStash::
40         If set to true, linkgit:git-status[1] will display the number of
41         entries currently stashed away.
42         Defaults to false.
43
44 status.showUntrackedFiles::
45         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
46         files which are not currently tracked by Git. Directories which
47         contain only untracked files, are shown with the directory name
48         only. Showing untracked files means that Git needs to lstat() all
49         the files in the whole repository, which might be slow on some
50         systems. So, this variable controls how the commands displays
51         the untracked files. Possible values are:
52 +
53 --
54 * `no` - Show no untracked files.
55 * `normal` - Show untracked files and directories.
56 * `all` - Show also individual files in untracked directories.
57 --
58 +
59 If this variable is not specified, it defaults to 'normal'.
60 This variable can be overridden with the -u|--untracked-files option
61 of linkgit:git-status[1] and linkgit:git-commit[1].
62
63 status.submoduleSummary::
64         Defaults to false.
65         If this is set to a non zero number or true (identical to -1 or an
66         unlimited number), the submodule summary will be enabled and a
67         summary of commits for modified submodules will be shown (see
68         --summary-limit option of linkgit:git-submodule[1]). Please note
69         that the summary output command will be suppressed for all
70         submodules when `diff.ignoreSubmodules` is set to 'all' or only
71         for those submodules where `submodule.<name>.ignore=all`. The only
72         exception to that rule is that status and commit will show staged
73         submodule changes. To
74         also view the summary for ignored submodules you can either use
75         the --ignore-submodules=dirty command-line option or the 'git
76         submodule summary' command, which shows a similar output but does
77         not honor these settings.