Merge branch 'jc/autogc' into js/rebase-i
[gitweb.git] / Documentation / config.txt
index de9e72b562eec6310af23cb4e5ef237268e8df2a..2f04226988cb070a8fede8db757949ea7cab09c7 100644 (file)
@@ -192,7 +192,7 @@ core.worktree::
        variable and the '--work-tree' command line option.
 
 core.logAllRefUpdates::
-       Updates to a ref <ref> is logged to the file
+       Enable the reflog. Updates to a ref <ref> is logged to the file
        "$GIT_DIR/logs/<ref>", by appending the new and old
        SHA1, the date/time and the reason of the update, but
        only when the file exists.  If this configuration
@@ -283,7 +283,7 @@ core.excludesfile::
 
 core.editor::
        Commands such as `commit` and `tag` that lets you edit
-       messages by lauching an editor uses the value of this
+       messages by launching an editor uses the value of this
        variable when it is set, and the environment variable
        `GIT_EDITOR` is not set.  The order of preference is
        `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
@@ -301,12 +301,12 @@ alias.*::
        hide existing git commands are ignored. Arguments are split by
        spaces, the usual shell quoting and escaping is supported.
        quote pair and a backslash can be used to quote them.
-
-       If the alias expansion is prefixed with an exclamation point,
-       it will be treated as a shell command.  For example, defining
-       "alias.new = !gitk --all --not ORIG_HEAD", the invocation
-       "git new" is equivalent to running the shell command
-       "gitk --all --not ORIG_HEAD".
++
+If the alias expansion is prefixed with an exclamation point,
+it will be treated as a shell command.  For example, defining
+"alias.new = !gitk --all --not ORIG_HEAD", the invocation
+"git new" is equivalent to running the shell command
+"gitk --all --not ORIG_HEAD".
 
 apply.whitespace::
        Tells `git-apply` how to handle whitespaces, in the same way
@@ -396,6 +396,16 @@ color.status.<slot>::
 commit.template::
        Specify a file to use as the template for new commit messages.
 
+diff.autorefreshindex::
+       When using `git diff` to compare with work tree
+       files, do not consider stat-only change as changed.
+       Instead, silently run `git update-index --refresh` to
+       update the cached stat information for paths whose
+       contents in the work tree match the contents in the
+       index.  This option defaults to true.  Note that this
+       affects only `git diff` Porcelain, and not lower level
+       `diff` commands, such as `git diff-files`.
+
 diff.renameLimit::
        The number of files to consider when performing the copy/rename
        detection; equivalent to the git diff option '-l'.
@@ -429,6 +439,19 @@ gc.aggressiveWindow::
        algorithm used by 'git gc --aggressive'.  This defaults
        to 10.
 
+gc.auto::
+       When there are approximately more than this many loose
+       objects in the repository, `git gc --auto` will pack them.
+       Some Porcelain commands use this command to perform a
+       light-weight garbage collection from time to time.  Setting
+       this to 0 disables it.
+
+gc.autopacklimit::
+       When there are more than this many packs that are not
+       marked with `*.keep` file in the repository, `git gc
+       --auto` consolidates them into one larger pack.  Setting
+       this to 0 disables this.
+
 gc.packrefs::
        `git gc` does not run `git pack-refs` in a bare repository by
        default so that older dumb-transport clients can still fetch
@@ -465,11 +488,11 @@ rerere.enabled::
        be encountered again.  See gitlink:git-rerere[1].
 
 gitcvs.enabled::
-       Whether the cvs server interface is enabled for this repository.
+       Whether the CVS server interface is enabled for this repository.
        See gitlink:git-cvsserver[1].
 
 gitcvs.logfile::
-       Path to a log file where the cvs server interface well... logs
+       Path to a log file where the CVS server interface well... logs
        various stuff. See gitlink:git-cvsserver[1].
 
 gitcvs.allbinary::
@@ -500,10 +523,10 @@ gitcvs.dbuser, gitcvs.dbpass::
        'gitcvs.dbuser' supports variable substitution (see
        gitlink:git-cvsserver[1] for details).
 
-All gitcvs variables except for 'gitcvs.allbinary' can also specifed
-as 'gitcvs.<access_method>.<varname>' (where 'access_method' is one
-of "ext" and "pserver") to make them apply only for the given access
-method.
+All gitcvs variables except for 'gitcvs.allbinary' can also be
+specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
+is one of "ext" and "pserver") to make them apply only for the given
+access method.
 
 http.sslVerify::
        Whether to verify the SSL certificate when fetching or pushing
@@ -615,14 +638,22 @@ pack.compression::
        not set,  defaults to -1.
 
 pack.deltaCacheSize::
-       The maxium memory in bytes used for caching deltas in
+       The maximum memory in bytes used for caching deltas in
        gitlink:git-pack-objects[1].
        A value of 0 means no limit. Defaults to 0.
 
 pack.deltaCacheLimit::
-       The maxium size of a delta, that is cached in
+       The maximum size of a delta, that is cached in
        gitlink:git-pack-objects[1]. Defaults to 1000.
 
+pack.threads::
+       Specifies the number of threads to spawn when searching for best
+       delta matches.  This requires that gitlink:git-pack-objects[1]
+       be compiled with pthreads otherwise this option is ignored with a
+       warning. This is meant to reduce packing time on multiprocessor
+       machines. The required amount of memory for the delta search window
+       is however multiplied by the number of threads.
+
 pull.octopus::
        The default merge strategy to use when pulling multiple branches
        at once.
@@ -675,15 +706,11 @@ showbranch.default::
        See gitlink:git-show-branch[1].
 
 tar.umask::
-       By default, gitlink:git-tar-tree[1] sets file and directories modes
-       to 0666 or 0777. While this is both useful and acceptable for projects
-       such as the Linux Kernel, it might be excessive for other projects.
-       With this variable, it becomes possible to tell
-       gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
-       The special value "user" indicates that the user's current umask will
-       be used. This should be enough for most projects, as it will lead to
-       the same permissions as gitlink:git-checkout[1] would use. The default
-       value remains 0, which means world read-write.
+       This variable can be used to restrict the permission bits of
+       tar archive entries.  The default is 0002, which turns off the
+       world write bit.  The special value "user" indicates that the
+       archiving user's umask will be used instead.  See umask(2) and
+       gitlink:git-archive[1].
 
 user.email::
        Your email address to be recorded in any newly created commits.