use 'init' instead of 'init-db' for shipped docs and tools

[git.git] / Documentation / config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 744484b98230457b8cc79063c4ffdeec4cac7b0c..f7dba8977f4eb9a59171247250e136a33b1f7533 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -100,7 +100,7 @@ core.sharedRepository::
        group-writable). When 'all' (or 'world' or 'everybody'), the
        repository will be readable by all users, additionally to being
        group-shareable. When 'umask' (or 'false'), git will use permissions
-       reported by umask(2). See gitlink:git-init-db[1]. False by default.
+       reported by umask(2). See gitlink:git-init[1]. False by default.
 
 core.warnAmbiguousRefs::
        If true, git will warn you if the ref name you passed it is ambiguous
@@ -123,20 +123,28 @@ core.packedGitWindowSize::
        single mapping operation.  Larger window sizes may allow
        your system to process a smaller number of large pack files
        more quickly.  Smaller window sizes will negatively affect
-       performance due to increased calls to the opreating system's
+       performance due to increased calls to the operating system's
        memory manager, but may improve performance when accessing
-       a large number of large pack files.  Default is 32 MiB,
-       which should be reasonable for all users/operating systems.
-       You probably do not need to adjust this value.
+       a large number of large pack files.
++
+Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
+MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
+be reasonable for all users/operating systems.  You probably do
+not need to adjust this value.
++
+Common unit suffixes of 'k', 'm', or 'g' are supported.
 
 core.packedGitLimit::
        Maximum number of bytes to map simultaneously into memory
        from pack files.  If Git needs to access more than this many
        bytes at once to complete an operation it will unmap existing
        regions to reclaim virtual address space within the process.
-       Default is 256 MiB, which should be reasonable for all
-       users/operating systems, except on largest Git projects.
-       You probably do not need to adjust this value.
++
+Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
+This should be reasonable for all users/operating systems, except on
+the largest projects.  You probably do not need to adjust this value.
++
+Common unit suffixes of 'k', 'm', or 'g' are supported.
 
 alias.*::
        Command aliases for the gitlink:git[1] command wrapper - e.g.
@@ -165,6 +173,21 @@ branch.<name>.merge::
        this option, `git pull` defaults to merge the first refspec fetched.
        Specify multiple values to get an octopus merge.
 
+color.branch::
+       A boolean to enable/disable color in the output of
+       gitlink:git-branch[1]. May be set to `true` (or `always`),
+       `false` (or `never`) or `auto`, in which case colors are used
+       only when the output is to a terminal. Defaults to false.
+
+color.branch.<slot>::
+       Use customized color for branch coloration. `<slot>` is one of
+       `current` (the current branch), `local` (a local branch),
+       `remote` (a tracking branch in refs/remotes/), `plain` (other
+       refs), or `reset` (the normal terminal color).  The value for
+       these configuration variables can be one of: `normal`, `bold`,
+       `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`,
+       `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`.
+
 color.diff::
        When true (or `always`), always use colors in patch.
        When false (or `never`), never.  When set to `auto`, use
@@ -175,11 +198,8 @@ color.diff.<slot>::
        specifies which part of the patch to use the specified
        color, and is one of `plain` (context text), `meta`
        (metainformation), `frag` (hunk header), `old` (removed
-       lines), or `new` (added lines).  The value for these
-       configuration variables can be one of: `normal`, `bold`,
-       `dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
-       `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
-       `white`.
+       lines), or `new` (added lines).  The values of these
+       variables may be specified as in color.branch.<slot>.
 
 color.pager::
        A boolean to enable/disable colored output when the pager is in
@@ -197,7 +217,7 @@ color.status.<slot>::
        `added` or `updated` (files which are added but not committed),
        `changed` (files which are changed but not added in the index),
        or `untracked` (files which are not tracked by git). The values of
-       these variables may be specified as in color.diff.<slot>.
+       these variables may be specified as in color.branch.<slot>.
 
 diff.renameLimit::
        The number of files to consider when performing the copy/rename