Skip to content

Commit fd7761a

Browse files
committed
Merge branch 'nd/config-split'
Split the overly large Documentation/config.txt file into million little pieces. This potentially allows each individual piece included into the manual page of the command it affects more easily. * nd/config-split: (81 commits) config.txt: remove config/dummy.txt config.txt: move worktree.* to a separate file config.txt: move web.* to a separate file config.txt: move versionsort.* to a separate file config.txt: move user.* to a separate file config.txt: move url.* to a separate file config.txt: move uploadpack.* to a separate file config.txt: move uploadarchive.* to a separate file config.txt: move transfer.* to a separate file config.txt: move tag.* to a separate file config.txt: move submodule.* to a separate file config.txt: move stash.* to a separate file config.txt: move status.* to a separate file config.txt: move splitIndex.* to a separate file config.txt: move showBranch.* to a separate file config.txt: move sequencer.* to a separate file config.txt: move sendemail-config.txt to config/ config.txt: move reset.* to a separate file config.txt: move rerere.* to a separate file config.txt: move repack.* to a separate file ...
2 parents 8858448 + 6053f1a commit fd7761a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+2980
-2894
lines changed

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ docdep_prereqs = \
285285
mergetools-list.made $(mergetools_txt) \
286286
cmd-list.made $(cmds_txt)
287287

288-
doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
288+
doc.dep : $(docdep_prereqs) $(wildcard *.txt) $(wildcard config/*.txt) build-docdep.perl
289289
$(QUIET_GEN)$(RM) $@+ $@ && \
290290
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
291291
mv $@+ $@

Documentation/config.txt

Lines changed: 111 additions & 2839 deletions
Large diffs are not rendered by default.

Documentation/config/add.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
add.ignoreErrors::
2+
add.ignore-errors (deprecated)::
3+
Tells 'git add' to continue adding files when some files cannot be
4+
added due to indexing errors. Equivalent to the `--ignore-errors`
5+
option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
6+
as it does not follow the usual naming convention for configuration
7+
variables.

Documentation/config/advice.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
advice.*::
2+
These variables control various optional help messages designed to
3+
aid new users. All 'advice.*' variables default to 'true', and you
4+
can tell Git that you do not need help by setting these to 'false':
5+
+
6+
--
7+
pushUpdateRejected::
8+
Set this variable to 'false' if you want to disable
9+
'pushNonFFCurrent',
10+
'pushNonFFMatching', 'pushAlreadyExists',
11+
'pushFetchFirst', and 'pushNeedsForce'
12+
simultaneously.
13+
pushNonFFCurrent::
14+
Advice shown when linkgit:git-push[1] fails due to a
15+
non-fast-forward update to the current branch.
16+
pushNonFFMatching::
17+
Advice shown when you ran linkgit:git-push[1] and pushed
18+
'matching refs' explicitly (i.e. you used ':', or
19+
specified a refspec that isn't your current branch) and
20+
it resulted in a non-fast-forward error.
21+
pushAlreadyExists::
22+
Shown when linkgit:git-push[1] rejects an update that
23+
does not qualify for fast-forwarding (e.g., a tag.)
24+
pushFetchFirst::
25+
Shown when linkgit:git-push[1] rejects an update that
26+
tries to overwrite a remote ref that points at an
27+
object we do not have.
28+
pushNeedsForce::
29+
Shown when linkgit:git-push[1] rejects an update that
30+
tries to overwrite a remote ref that points at an
31+
object that is not a commit-ish, or make the remote
32+
ref point at an object that is not a commit-ish.
33+
statusHints::
34+
Show directions on how to proceed from the current
35+
state in the output of linkgit:git-status[1], in
36+
the template shown when writing commit messages in
37+
linkgit:git-commit[1], and in the help message shown
38+
by linkgit:git-checkout[1] when switching branch.
39+
statusUoption::
40+
Advise to consider using the `-u` option to linkgit:git-status[1]
41+
when the command takes more than 2 seconds to enumerate untracked
42+
files.
43+
commitBeforeMerge::
44+
Advice shown when linkgit:git-merge[1] refuses to
45+
merge to avoid overwriting local changes.
46+
resetQuiet::
47+
Advice to consider using the `--quiet` option to linkgit:git-reset[1]
48+
when the command takes more than 2 seconds to enumerate unstaged
49+
changes after reset.
50+
resolveConflict::
51+
Advice shown by various commands when conflicts
52+
prevent the operation from being performed.
53+
implicitIdentity::
54+
Advice on how to set your identity configuration when
55+
your information is guessed from the system username and
56+
domain name.
57+
detachedHead::
58+
Advice shown when you used linkgit:git-checkout[1] to
59+
move to the detach HEAD state, to instruct how to create
60+
a local branch after the fact.
61+
checkoutAmbiguousRemoteBranchName::
62+
Advice shown when the argument to
63+
linkgit:git-checkout[1] ambiguously resolves to a
64+
remote tracking branch on more than one remote in
65+
situations where an unambiguous argument would have
66+
otherwise caused a remote-tracking branch to be
67+
checked out. See the `checkout.defaultRemote`
68+
configuration variable for how to set a given remote
69+
to used by default in some situations where this
70+
advice would be printed.
71+
amWorkDir::
72+
Advice that shows the location of the patch file when
73+
linkgit:git-am[1] fails to apply it.
74+
rmHints::
75+
In case of failure in the output of linkgit:git-rm[1],
76+
show directions on how to proceed from the current state.
77+
addEmbeddedRepo::
78+
Advice on what to do when you've accidentally added one
79+
git repo inside of another.
80+
ignoredHook::
81+
Advice shown if a hook is ignored because the hook is not
82+
set as executable.
83+
waitingForEditor::
84+
Print a message to the terminal whenever Git is waiting for
85+
editor input from the user.
86+
--

Documentation/config/alias.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
alias.*::
2+
Command aliases for the linkgit:git[1] command wrapper - e.g.
3+
after defining "alias.last = cat-file commit HEAD", the invocation
4+
"git last" is equivalent to "git cat-file commit HEAD". To avoid
5+
confusion and troubles with script usage, aliases that
6+
hide existing Git commands are ignored. Arguments are split by
7+
spaces, the usual shell quoting and escaping is supported.
8+
A quote pair or a backslash can be used to quote them.
9+
+
10+
If the alias expansion is prefixed with an exclamation point,
11+
it will be treated as a shell command. For example, defining
12+
"alias.new = !gitk --all --not ORIG_HEAD", the invocation
13+
"git new" is equivalent to running the shell command
14+
"gitk --all --not ORIG_HEAD". Note that shell commands will be
15+
executed from the top-level directory of a repository, which may
16+
not necessarily be the current directory.
17+
`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
18+
from the original current directory. See linkgit:git-rev-parse[1].

Documentation/config/am.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
am.keepcr::
2+
If true, git-am will call git-mailsplit for patches in mbox format
3+
with parameter `--keep-cr`. In this case git-mailsplit will
4+
not remove `\r` from lines ending with `\r\n`. Can be overridden
5+
by giving `--no-keep-cr` from the command line.
6+
See linkgit:git-am[1], linkgit:git-mailsplit[1].
7+
8+
am.threeWay::
9+
By default, `git am` will fail if the patch does not apply cleanly. When
10+
set to true, this setting tells `git am` to fall back on 3-way merge if
11+
the patch records the identity of blobs it is supposed to apply to and
12+
we have those blobs available locally (equivalent to giving the `--3way`
13+
option from the command line). Defaults to `false`.
14+
See linkgit:git-am[1].

Documentation/config/apply.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apply.ignoreWhitespace::
2+
When set to 'change', tells 'git apply' to ignore changes in
3+
whitespace, in the same way as the `--ignore-space-change`
4+
option.
5+
When set to one of: no, none, never, false tells 'git apply' to
6+
respect all whitespace differences.
7+
See linkgit:git-apply[1].
8+
9+
apply.whitespace::
10+
Tells 'git apply' how to handle whitespaces, in the same way
11+
as the `--whitespace` option. See linkgit:git-apply[1].

Documentation/config/blame.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
blame.blankBoundary::
2+
Show blank commit object name for boundary commits in
3+
linkgit:git-blame[1]. This option defaults to false.
4+
5+
blame.coloring::
6+
This determines the coloring scheme to be applied to blame
7+
output. It can be 'repeatedLines', 'highlightRecent',
8+
or 'none' which is the default.
9+
10+
blame.date::
11+
Specifies the format used to output dates in linkgit:git-blame[1].
12+
If unset the iso format is used. For supported values,
13+
see the discussion of the `--date` option at linkgit:git-log[1].
14+
15+
blame.showEmail::
16+
Show the author email instead of author name in linkgit:git-blame[1].
17+
This option defaults to false.
18+
19+
blame.showRoot::
20+
Do not treat root commits as boundaries in linkgit:git-blame[1].
21+
This option defaults to false.

Documentation/config/branch.txt

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
branch.autoSetupMerge::
2+
Tells 'git branch' and 'git checkout' to set up new branches
3+
so that linkgit:git-pull[1] will appropriately merge from the
4+
starting point branch. Note that even if this option is not set,
5+
this behavior can be chosen per-branch using the `--track`
6+
and `--no-track` options. The valid settings are: `false` -- no
7+
automatic setup is done; `true` -- automatic setup is done when the
8+
starting point is a remote-tracking branch; `always` --
9+
automatic setup is done when the starting point is either a
10+
local branch or remote-tracking
11+
branch. This option defaults to true.
12+
13+
branch.autoSetupRebase::
14+
When a new branch is created with 'git branch' or 'git checkout'
15+
that tracks another branch, this variable tells Git to set
16+
up pull to rebase instead of merge (see "branch.<name>.rebase").
17+
When `never`, rebase is never automatically set to true.
18+
When `local`, rebase is set to true for tracked branches of
19+
other local branches.
20+
When `remote`, rebase is set to true for tracked branches of
21+
remote-tracking branches.
22+
When `always`, rebase will be set to true for all tracking
23+
branches.
24+
See "branch.autoSetupMerge" for details on how to set up a
25+
branch to track another branch.
26+
This option defaults to never.
27+
28+
branch.sort::
29+
This variable controls the sort ordering of branches when displayed by
30+
linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
31+
value of this variable will be used as the default.
32+
See linkgit:git-for-each-ref[1] field names for valid values.
33+
34+
branch.<name>.remote::
35+
When on branch <name>, it tells 'git fetch' and 'git push'
36+
which remote to fetch from/push to. The remote to push to
37+
may be overridden with `remote.pushDefault` (for all branches).
38+
The remote to push to, for the current branch, may be further
39+
overridden by `branch.<name>.pushRemote`. If no remote is
40+
configured, or if you are not on any branch, it defaults to
41+
`origin` for fetching and `remote.pushDefault` for pushing.
42+
Additionally, `.` (a period) is the current local repository
43+
(a dot-repository), see `branch.<name>.merge`'s final note below.
44+
45+
branch.<name>.pushRemote::
46+
When on branch <name>, it overrides `branch.<name>.remote` for
47+
pushing. It also overrides `remote.pushDefault` for pushing
48+
from branch <name>. When you pull from one place (e.g. your
49+
upstream) and push to another place (e.g. your own publishing
50+
repository), you would want to set `remote.pushDefault` to
51+
specify the remote to push to for all branches, and use this
52+
option to override it for a specific branch.
53+
54+
branch.<name>.merge::
55+
Defines, together with branch.<name>.remote, the upstream branch
56+
for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
57+
branch to merge and can also affect 'git push' (see push.default).
58+
When in branch <name>, it tells 'git fetch' the default
59+
refspec to be marked for merging in FETCH_HEAD. The value is
60+
handled like the remote part of a refspec, and must match a
61+
ref which is fetched from the remote given by
62+
"branch.<name>.remote".
63+
The merge information is used by 'git pull' (which at first calls
64+
'git fetch') to lookup the default branch for merging. Without
65+
this option, 'git pull' defaults to merge the first refspec fetched.
66+
Specify multiple values to get an octopus merge.
67+
If you wish to setup 'git pull' so that it merges into <name> from
68+
another branch in the local repository, you can point
69+
branch.<name>.merge to the desired branch, and use the relative path
70+
setting `.` (a period) for branch.<name>.remote.
71+
72+
branch.<name>.mergeOptions::
73+
Sets default options for merging into branch <name>. The syntax and
74+
supported options are the same as those of linkgit:git-merge[1], but
75+
option values containing whitespace characters are currently not
76+
supported.
77+
78+
branch.<name>.rebase::
79+
When true, rebase the branch <name> on top of the fetched branch,
80+
instead of merging the default branch from the default remote when
81+
"git pull" is run. See "pull.rebase" for doing this in a non
82+
branch-specific manner.
83+
+
84+
When `merges`, pass the `--rebase-merges` option to 'git rebase'
85+
so that the local merge commits are included in the rebase (see
86+
linkgit:git-rebase[1] for details).
87+
+
88+
When preserve, also pass `--preserve-merges` along to 'git rebase'
89+
so that locally committed merge commits will not be flattened
90+
by running 'git pull'.
91+
+
92+
When the value is `interactive`, the rebase is run in interactive mode.
93+
+
94+
*NOTE*: this is a possibly dangerous operation; do *not* use
95+
it unless you understand the implications (see linkgit:git-rebase[1]
96+
for details).
97+
98+
branch.<name>.description::
99+
Branch description, can be edited with
100+
`git branch --edit-description`. Branch description is
101+
automatically added in the format-patch cover letter or
102+
request-pull summary.

Documentation/config/browser.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
browser.<tool>.cmd::
2+
Specify the command to invoke the specified browser. The
3+
specified command is evaluated in shell with the URLs passed
4+
as arguments. (See linkgit:git-web{litdd}browse[1].)
5+
6+
browser.<tool>.path::
7+
Override the path for the given tool that may be used to
8+
browse HTML help (see `-w` option in linkgit:git-help[1]) or a
9+
working repository in gitweb (see linkgit:git-instaweb[1]).

0 commit comments

Comments
 (0)