Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Documentation/config/am.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
am.keepcr::
If true, git-am will call git-mailsplit for patches in mbox format
If `true`, git-am will call git-mailsplit for patches in mbox format
with parameter `--keep-cr`. In this case git-mailsplit will
not remove `\r` from lines ending with `\r\n`. Can be overridden
by giving `--no-keep-cr` from the command line.
See linkgit:git-am[1], linkgit:git-mailsplit[1].

am.threeWay::
By default, `git am` will fail if the patch does not apply cleanly. When
set to true, this setting tells `git am` to fall back on 3-way merge if
set to `true`, this setting tells `git am` to fall back on 3-way merge if
the patch records the identity of blobs it is supposed to apply to and
we have those blobs available locally (equivalent to giving the `--3way`
option from the command line). Defaults to `false`.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/config/blame.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
blame.blankBoundary::
Show blank commit object name for boundary commits in
linkgit:git-blame[1]. This option defaults to false.
linkgit:git-blame[1]. This option defaults to `false`.

blame.coloring::
This determines the coloring scheme to be applied to blame
Expand All @@ -14,11 +14,11 @@ blame.date::

blame.showEmail::
Show the author email instead of author name in linkgit:git-blame[1].
This option defaults to false.
This option defaults to `false`.

blame.showRoot::
Do not treat root commits as boundaries in linkgit:git-blame[1].
This option defaults to false.
This option defaults to `false`.

blame.ignoreRevsFile::
Ignore revisions listed in the file, one unabbreviated object name per
Expand Down
10 changes: 5 additions & 5 deletions Documentation/config/branch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
that tracks another branch, this variable tells Git to set
up pull to rebase instead of merge (see `branch.<name>.rebase`).
The valid settings are:
`never`;; rebase is never automatically set to true.
`local`;; rebase is set to true for tracked branches of other local branches.
`remote`;; rebase is set to true for tracked branches of remote-tracking branches.
`always`;; rebase will be set to true for all tracking branches.
`never`;; rebase is never automatically set to `true`.
`local`;; rebase is set to `true` for tracked branches of other local branches.
`remote`;; rebase is set to `true` for tracked branches of remote-tracking branches.
`always`;; rebase will be set to `true` for all tracking branches.

+
See `branch.autoSetupMerge` for details on how to set up a branch to track another branch.
Expand Down Expand Up @@ -81,7 +81,7 @@ This option defaults to `never`.
supported.

`branch.<name>.rebase`::
When true, rebase the branch _<name>_ on top of the fetched branch,
When `true`, rebase the branch _<name>_ on top of the fetched branch,
instead of merging the default branch from the default remote when
`git pull` is run. See `pull.rebase` for doing this in a non
branch-specific manner.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/clean.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
clean.requireForce::
A boolean to make git-clean refuse to delete files unless -f
is given. Defaults to true.
is given. Defaults to `true`.
2 changes: 1 addition & 1 deletion Documentation/config/color.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ color.interactive.<slot>::

color.pager::
A boolean to specify whether `auto` color modes should colorize
output going to the pager. Defaults to true; set this to false
output going to the pager. Defaults to `true`; set this to `false`
if your pager does not understand ANSI color codes.

color.push::
Expand Down
8 changes: 4 additions & 4 deletions Documentation/config/commitgraph.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ commitGraph.maxNewFilters::
commit-graph write` (c.f., linkgit:git-commit-graph[1]).

commitGraph.changedPaths::
If true, then `git commit-graph write` will compute and write
If `true`, then `git commit-graph write` will compute and write
changed-path Bloom filters by default, equivalent to passing
`--changed-paths`. If false or unset, changed-paths Bloom filters will
`--changed-paths`. If `false` or unset, changed-paths Bloom filters will
be written during `git commit-graph write` only if the filters already
exist in the current commit-graph file. This matches the default
behavior of `git commit-graph write` without any `--[no-]changed-paths`
Expand All @@ -20,8 +20,8 @@ commitGraph.changedPaths::
always takes precedence over this configuration. Defaults to unset.

commitGraph.readChangedPaths::
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and
commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if `true`, and
commitGraph.changedPathsVersion=0 if `false`. (If commitGraph.changedPathVersion
is also set, commitGraph.changedPathsVersion takes precedence.)

commitGraph.changedPathsVersion::
Expand Down
72 changes: 36 additions & 36 deletions Documentation/config/core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Git for Windows or Eclipse).
In such a case it may be necessary to set this variable to 'false'.
See linkgit:git-update-index[1].
+
The default is true (when core.filemode is not specified in the config file).
The default is `true` (when core.filemode is not specified in the config file).

core.hideDotFiles::
(Windows-only) If true, mark newly-created directories and files whose
(Windows-only) If `true`, mark newly-created directories and files whose
name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
directory is hidden, but no other files starting with a dot. The
default mode is 'dotGitOnly'.
Expand All @@ -34,35 +34,35 @@ core.ignoreCase::
it is really the same file, and continue to remember it as
"Makefile".
+
The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.ignoreCase true if appropriate when the repository
The default is `false`, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.ignoreCase `true` if appropriate when the repository
is created.
+
Git relies on the proper configuration of this variable for your operating
and file system. Modifying this value may result in unexpected behavior.

core.precomposeUnicode::
This option is only used by Mac OS implementation of Git.
When core.precomposeUnicode=true, Git reverts the unicode decomposition
When core.precomposeUnicode=`true`, Git reverts the unicode decomposition
of filenames done by Mac OS. This is useful when sharing a repository
between Mac OS and Linux or Windows.
(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
When false, file names are handled fully transparent by Git,
When `false`, file names are handled fully transparent by Git,
which is backward compatible with older versions of Git.

core.protectHFS::
If set to true, do not allow checkout of paths that would
If set to `true`, do not allow checkout of paths that would
be considered equivalent to `.git` on an HFS+ filesystem.
Defaults to `true` on Mac OS, and `false` elsewhere.

core.protectNTFS::
If set to true, do not allow checkout of paths that would
If set to `true`, do not allow checkout of paths that would
cause problems with the NTFS filesystem, e.g. conflict with
8.3 "short" names.
Defaults to `true` on Windows, and `false` elsewhere.

core.fsmonitor::
If set to true, enable the built-in file system monitor
If set to `true`, enable the built-in file system monitor
daemon for this working directory (linkgit:git-fsmonitor{litdd}daemon[1]).
+
Like hook-based file system monitors, the built-in file system monitor
Expand Down Expand Up @@ -112,15 +112,15 @@ something that can be used to determine what files have changed
without race conditions.

core.trustctime::
If false, the ctime differences between the index and the
If `false`, the ctime differences between the index and the
working tree are ignored; useful when the inode change time
is regularly modified by something outside Git (file system
crawlers and some backup systems).
See linkgit:git-update-index[1]. True by default.
See linkgit:git-update-index[1]. `True` by default.

core.splitIndex::
If true, the split-index feature of the index will be used.
See linkgit:git-update-index[1]. False by default.
If `true`, the split-index feature of the index will be used.
See linkgit:git-update-index[1]. `False` by default.

core.untrackedCache::
Determines what to do about the untracked cache feature of the
Expand Down Expand Up @@ -156,13 +156,13 @@ core.quotePath::
backslashes in the same way C escapes control characters (e.g.
`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
values larger than 0x80 (e.g. octal `\302\265` for "micro" in
UTF-8). If this variable is set to false, bytes higher than
UTF-8). If this variable is set to `false`, bytes higher than
0x80 are not considered "unusual" any more. Double-quotes,
backslash and control characters are always escaped regardless
of the setting of this variable. A simple space character is
not considered "unusual". Many commands can output pathnames
completely verbatim using the `-z` option. The default value
is true.
is `true`.

core.eol::
Sets the line ending type to use in the working directory for
Expand All @@ -176,7 +176,7 @@ core.eol::
is set to `true` or `input`.

core.safecrlf::
If true, makes Git check if converting `CRLF` is reversible when
If `true`, makes Git check if converting `CRLF` is reversible when
end-of-line conversion is active. Git will verify if a command
modifies a file in the work tree either directly or indirectly.
For example, committing a file followed by checking out the
Expand Down Expand Up @@ -223,7 +223,7 @@ mechanism.
core.autocrlf::
Setting this variable to "true" is the same as setting
the `text` attribute to "auto" on all files and core.eol to "crlf".
Set to true if you want to have `CRLF` line endings in your
Set to `true` if you want to have `CRLF` line endings in your
working directory and the repository has LF line endings.
This variable can be set to 'input',
in which case no output conversion is performed.
Expand All @@ -235,14 +235,14 @@ core.checkRoundtripEncoding::
The default value is `SHIFT-JIS`.

core.symlinks::
If false, symbolic links are checked out as small plain files that
If `false`, symbolic links are checked out as small plain files that
contain the link text. linkgit:git-update-index[1] and
linkgit:git-add[1] will not change the recorded type to regular
file. Useful on filesystems like FAT that do not support
symbolic links.
+
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.symlinks false if appropriate when the repository
The default is `true`, except linkgit:git-clone[1] or linkgit:git-init[1]
will probe and set core.symlinks `false` if appropriate when the repository
is created.

core.gitProxy::
Expand Down Expand Up @@ -271,7 +271,7 @@ core.sshCommand::
when the environment variable is set.

core.ignoreStat::
If true, Git will avoid using lstat() calls to detect if files have
If `true`, Git will avoid using lstat() calls to detect if files have
changed by setting the "assume-unchanged" bit for those tracked files
which it has updated identically in both the index and working tree.
+
Expand All @@ -283,7 +283,7 @@ Git will not normally detect changes to those files.
This is useful on systems where lstat() calls are very slow, such as
CIFS/Microsoft Windows.
+
False by default.
`False` by default.

core.preferSymlinkRefs::
Instead of the default "symref" format for HEAD
Expand Down Expand Up @@ -313,16 +313,16 @@ core.alternateRefsPrefixes::
`core.alternateRefsPrefixes` has no effect.

core.bare::
If true this repository is assumed to be 'bare' and has no
If `true` this repository is assumed to be 'bare' and has no
working directory associated with it. If this is the case a
number of commands that require a working directory will be
disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
+
This setting is automatically guessed by linkgit:git-clone[1] or
linkgit:git-init[1] when the repository was created. By default a
repository that ends in "/.git" is assumed to be not bare (bare =
false), while all other repositories are assumed to be bare (bare
= true).
`false`), while all other repositories are assumed to be bare (bare
= `true`).

core.worktree::
Set the path to the root of the working tree.
Expand All @@ -349,7 +349,7 @@ read-only snapshot of the same index to a location different from the
repository's usual working tree).

core.lockfilePid::
If true, Git will create a PID file alongside lock files. When a
If `true`, Git will create a PID file alongside lock files. When a
lock acquisition fails and a PID file exists, Git can provide
additional diagnostic information about the process holding the
lock, including whether it is still running. Defaults to `false`.
Expand All @@ -374,8 +374,8 @@ core.logAllRefUpdates::
This information can be used to determine what commit
was the tip of a branch "2 days ago".
+
This value is true by default in a repository that has
a working directory associated with it, and false by
This value is `true` by default in a repository that has
a working directory associated with it, and `false` by
default in a bare repository.

core.repositoryFormatVersion::
Expand All @@ -395,11 +395,11 @@ core.sharedRepository::
the repo read/write-able for the owner and group, but inaccessible to
others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
repository that is group-readable but not group-writable.
See linkgit:git-init[1]. False by default.
See linkgit:git-init[1]. `False` by default.

core.warnAmbiguousRefs::
If true, Git will warn you if the ref name you passed it is ambiguous
and might match multiple refs in the repository. True by default.
If `true`, Git will warn you if the ref name you passed it is ambiguous
and might match multiple refs in the repository. `True` by default.

core.compression::
An integer -1..9, indicating a default compression level.
Expand Down Expand Up @@ -708,7 +708,7 @@ core.fsyncObjectFiles::
This setting is deprecated. Use core.fsync instead.
+
This setting affects data added to the Git repository in loose-object
form. When set to true, Git will issue an fsync or similar system call
form. When set to `true`, Git will issue an fsync or similar system call
to flush caches so that loose-objects remain consistent in the face
of a unclean system shutdown.

Expand All @@ -719,7 +719,7 @@ This can speed up operations like 'git diff' and 'git status' especially
on filesystems like NFS that have weak caching semantics and thus
relatively high IO latencies. When enabled, Git will do the
index comparison to the filesystem data in parallel, allowing
overlapping IO's. Defaults to true.
overlapping IO's. Defaults to `true`.

core.unsetenvvars::
Windows-only: comma-separated list of environment variables'
Expand All @@ -746,8 +746,8 @@ This setting defaults to "refs/notes/commits", and it can be overridden by
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].

core.commitGraph::
If true, then git will read the commit-graph file (if it exists)
to parse the graph structure of commits. Defaults to true. See
If `true`, then git will read the commit-graph file (if it exists)
to parse the graph structure of commits. Defaults to `true`. See
linkgit:git-commit-graph[1] for more information.

core.useReplaceRefs::
Expand All @@ -758,7 +758,7 @@ core.useReplaceRefs::
core.multiPackIndex::
Use the multi-pack-index file to track multiple packfiles using a
single index. See linkgit:git-multi-pack-index[1] for more
information. Defaults to true.
information. Defaults to `true`.

core.sparseCheckout::
Enable "sparse checkout" feature. See linkgit:git-sparse-checkout[1]
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config/credential.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ credential.interactive::

credential.useHttpPath::
When acquiring credentials, consider the "path" component of an http
or https URL to be important. Defaults to false. See
or https URL to be important. Defaults to `false`. See
linkgit:gitcredentials[7] for more information.

credential.sanitizePrompt::
Expand Down
14 changes: 7 additions & 7 deletions Documentation/config/fetch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
in `git pull`) will recursively fetch into populated submodules.
This option can be set either to a boolean value or to `on-demand`.
Setting it to a boolean changes the behavior of fetch and pull to
recurse unconditionally into submodules when set to true or to not
recurse at all when set to false. When set to `on-demand`, fetch and
recurse unconditionally into submodules when set to `true` or to not
recurse at all when set to `false`. When set to `on-demand`, fetch and
pull will only recurse into a populated submodule when its
superproject retrieves a commit that updates the submodule's
reference.
Defaults to `on-demand`, or to the value of `submodule.recurse` if set.

`fetch.fsckObjects`::
If it is set to true, git-fetch-pack will check all fetched
If it is set to `true`, git-fetch-pack will check all fetched
objects. See `transfer.fsckObjects` for what's
checked. Defaults to `false`. If not set, the value of
`transfer.fsckObjects` is used instead.
Expand All @@ -38,20 +38,20 @@
`transfer.unpackLimit` is used instead.

`fetch.prune`::
If true, fetch will automatically behave as if the `--prune`
If `true`, fetch will automatically behave as if the `--prune`
option was given on the command line. See also `remote.<name>.prune`
and the PRUNING section of linkgit:git-fetch[1].

`fetch.pruneTags`::
If true, fetch will automatically behave as if the
If `true`, fetch will automatically behave as if the
`refs/tags/*:refs/tags/*` refspec was provided when pruning,
if not set already. This allows for setting both this option
and `fetch.prune` to maintain a 1=1 mapping to upstream
refs. See also `remote.<name>.pruneTags` and the PRUNING
section of linkgit:git-fetch[1].

`fetch.all`::
If true, fetch will attempt to update all available remotes.
If `true`, fetch will attempt to update all available remotes.
This behavior can be overridden by passing `--no-all` or by
explicitly specifying one or more remote(s) to fetch from.
Defaults to `false`.
Expand Down Expand Up @@ -95,7 +95,7 @@ For submodules, this setting can be overridden using the `submodule.fetchJobs`
config setting.

`fetch.writeCommitGraph`::
Set to true to write a commit-graph after every `git fetch` command
Set to `true` to write a commit-graph after every `git fetch` command
that downloads a pack-file from a remote. Using the `--split` option,
most executions will create a very small commit-graph file on top of
the existing commit-graph file(s). Occasionally, these files will
Expand Down
Loading
Loading