config.txt: move receive-config.txt to config/
[gitweb.git] / Documentation / config.txt
index babe2e56828667a84e627cab5ecc27b22526e096..465dc2abec37b74f4785b34f33c8d26d345ab4e6 100644 (file)
@@ -377,218 +377,21 @@ include::config/mergetool.txt[]
 
 include::config/notes.txt[]
 
-pack.window::
-       The size of the window used by linkgit:git-pack-objects[1] when no
-       window size is given on the command line. Defaults to 10.
-
-pack.depth::
-       The maximum delta depth used by linkgit:git-pack-objects[1] when no
-       maximum depth is given on the command line. Defaults to 50.
-       Maximum value is 4095.
-
-pack.windowMemory::
-       The maximum size of memory that is consumed by each thread
-       in linkgit:git-pack-objects[1] for pack window memory when
-       no limit is given on the command line.  The value can be
-       suffixed with "k", "m", or "g".  When left unconfigured (or
-       set explicitly to 0), there will be no limit.
-
-pack.compression::
-       An integer -1..9, indicating the compression level for objects
-       in a pack file. -1 is the zlib default. 0 means no
-       compression, and 1..9 are various speed/size tradeoffs, 9 being
-       slowest.  If not set,  defaults to core.compression.  If that is
-       not set,  defaults to -1, the zlib default, which is "a default
-       compromise between speed and compression (currently equivalent
-       to level 6)."
-+
-Note that changing the compression level will not automatically recompress
-all existing objects. You can force recompression by passing the -F option
-to linkgit:git-repack[1].
-
-pack.island::
-       An extended regular expression configuring a set of delta
-       islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
-       for details.
-
-pack.islandCore::
-       Specify an island name which gets to have its objects be
-       packed first. This creates a kind of pseudo-pack at the front
-       of one pack, so that the objects from the specified island are
-       hopefully faster to copy into any pack that should be served
-       to a user requesting these objects. In practice this means
-       that the island specified should likely correspond to what is
-       the most commonly cloned in the repo. See also "DELTA ISLANDS"
-       in linkgit:git-pack-objects[1].
-
-pack.deltaCacheSize::
-       The maximum memory in bytes used for caching deltas in
-       linkgit:git-pack-objects[1] before writing them out to a pack.
-       This cache is used to speed up the writing object phase by not
-       having to recompute the final delta result once the best match
-       for all objects is found.  Repacking large repositories on machines
-       which are tight with memory might be badly impacted by this though,
-       especially if this cache pushes the system into swapping.
-       A value of 0 means no limit. The smallest size of 1 byte may be
-       used to virtually disable this cache. Defaults to 256 MiB.
-
-pack.deltaCacheLimit::
-       The maximum size of a delta, that is cached in
-       linkgit:git-pack-objects[1]. This cache is used to speed up the
-       writing object phase by not having to recompute the final delta
-       result once the best match for all objects is found.
-       Defaults to 1000. Maximum value is 65535.
-
-pack.threads::
-       Specifies the number of threads to spawn when searching for best
-       delta matches.  This requires that linkgit: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.
-       Specifying 0 will cause Git to auto-detect the number of CPU's
-       and set the number of threads accordingly.
-
-pack.indexVersion::
-       Specify the default pack index version.  Valid values are 1 for
-       legacy pack index used by Git versions prior to 1.5.2, and 2 for
-       the new pack index with capabilities for packs larger than 4 GB
-       as well as proper protection against the repacking of corrupted
-       packs.  Version 2 is the default.  Note that version 2 is enforced
-       and this config option ignored whenever the corresponding pack is
-       larger than 2 GB.
-+
-If you have an old Git that does not understand the version 2 `*.idx` file,
-cloning or fetching over a non native protocol (e.g. "http")
-that will copy both `*.pack` file and corresponding `*.idx` file from the
-other side may give you a repository that cannot be accessed with your
-older version of Git. If the `*.pack` file is smaller than 2 GB, however,
-you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
-the `*.idx` file.
-
-pack.packSizeLimit::
-       The maximum size of a pack.  This setting only affects
-       packing to a file when repacking, i.e. the git:// protocol
-       is unaffected.  It can be overridden by the `--max-pack-size`
-       option of linkgit:git-repack[1].  Reaching this limit results
-       in the creation of multiple packfiles; which in turn prevents
-       bitmaps from being created.
-       The minimum size allowed is limited to 1 MiB.
-       The default is unlimited.
-       Common unit suffixes of 'k', 'm', or 'g' are
-       supported.
-
-pack.useBitmaps::
-       When true, git will use pack bitmaps (if available) when packing
-       to stdout (e.g., during the server side of a fetch). Defaults to
-       true. You should not generally need to turn this off unless
-       you are debugging pack bitmaps.
-
-pack.writeBitmaps (deprecated)::
-       This is a deprecated synonym for `repack.writeBitmaps`.
-
-pack.writeBitmapHashCache::
-       When true, git will include a "hash cache" section in the bitmap
-       index (if one is written). This cache can be used to feed git's
-       delta heuristics, potentially leading to better deltas between
-       bitmapped and non-bitmapped objects (e.g., when serving a fetch
-       between an older, bitmapped pack and objects that have been
-       pushed since the last gc). The downside is that it consumes 4
-       bytes per object of disk space, and that JGit's bitmap
-       implementation does not understand it, causing it to complain if
-       Git and JGit are used on the same repository. Defaults to false.
-
-pager.<cmd>::
-       If the value is boolean, turns on or off pagination of the
-       output of a particular Git subcommand when writing to a tty.
-       Otherwise, turns on pagination for the subcommand using the
-       pager specified by the value of `pager.<cmd>`.  If `--paginate`
-       or `--no-pager` is specified on the command line, it takes
-       precedence over this option.  To disable pagination for all
-       commands, set `core.pager` or `GIT_PAGER` to `cat`.
-
-pretty.<name>::
-       Alias for a --pretty= format string, as specified in
-       linkgit:git-log[1]. Any aliases defined here can be used just
-       as the built-in pretty formats could. For example,
-       running `git config pretty.changelog "format:* %H %s"`
-       would cause the invocation `git log --pretty=changelog`
-       to be equivalent to running `git log "--pretty=format:* %H %s"`.
-       Note that an alias with the same name as a built-in format
-       will be silently ignored.
-
-protocol.allow::
-       If set, provide a user defined default policy for all protocols which
-       don't explicitly have a policy (`protocol.<name>.allow`).  By default,
-       if unset, known-safe protocols (http, https, git, ssh, file) have a
-       default policy of `always`, known-dangerous protocols (ext) have a
-       default policy of `never`, and all other protocols have a default
-       policy of `user`.  Supported policies:
-+
---
-
-* `always` - protocol is always able to be used.
-
-* `never` - protocol is never able to be used.
+include::config/pack.txt[]
 
-* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
-  either unset or has a value of 1.  This policy should be used when you want a
-  protocol to be directly usable by the user but don't want it used by commands which
-  execute clone/fetch/push commands without user input, e.g. recursive
-  submodule initialization.
-
---
-
-protocol.<name>.allow::
-       Set a policy to be used by protocol `<name>` with clone/fetch/push
-       commands. See `protocol.allow` above for the available policies.
-+
-The protocol names currently used by git are:
-+
---
-  - `file`: any local file-based path (including `file://` URLs,
-    or local paths)
+include::config/pager.txt[]
 
-  - `git`: the anonymous git protocol over a direct TCP
-    connection (or proxy, if configured)
+include::config/pretty.txt[]
 
-  - `ssh`: git over ssh (including `host:path` syntax,
-    `ssh://`, etc).
-
-  - `http`: git over http, both "smart http" and "dumb http".
-    Note that this does _not_ include `https`; if you want to configure
-    both, you must do so individually.
-
-  - any external helpers are named by their protocol (e.g., use
-    `hg` to allow the `git-remote-hg` helper)
---
-
-protocol.version::
-       Experimental. If set, clients will attempt to communicate with a
-       server using the specified protocol version.  If unset, no
-       attempt will be made by the client to communicate using a
-       particular protocol version, this results in protocol version 0
-       being used.
-       Supported versions:
-+
---
-
-* `0` - the original wire protocol.
-
-* `1` - the original wire protocol with the addition of a version string
-  in the initial response from the server.
-
-* `2` - link:technical/protocol-v2.html[wire protocol version 2].
-
---
+include::config/protocol.txt[]
 
-include::pull-config.txt[]
+include::config/pull.txt[]
 
-include::push-config.txt[]
+include::config/push.txt[]
 
-include::rebase-config.txt[]
+include::config/rebase.txt[]
 
-include::receive-config.txt[]
+include::config/receive.txt[]
 
 remote.pushDefault::
        The remote to push to by default.  Overrides