[49/78] config.txt: move pack.* to a separate file

Message ID	20181027062351.30446-50-pclouds@gmail.com (mailing list archive)
State	New, archived
Headers	show Return-Path: <git-owner@kernel.org> From: =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41jIER1eQ==?= <pclouds@gmail.com> To: git@vger.kernel.org Cc: Junio C Hamano <gitster@pobox.com>, =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmc=?= =?utf-8?b?4buNYyBEdXk=?= <pclouds@gmail.com> Subject: [PATCH 49/78] config.txt: move pack.* to a separate file Date: Sat, 27 Oct 2018 08:23:22 +0200 Message-Id: <20181027062351.30446-50-pclouds@gmail.com> In-Reply-To: <20181027062351.30446-1-pclouds@gmail.com> References: <20181027062351.30446-1-pclouds@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: git-owner@vger.kernel.org Precedence: bulk
Series	nd/config-split reroll \| expand [00/78] nd/config-split reroll [01/78] Update makefile in preparation for Documentation/config/.txt [02/78] config.txt: move advice. to a separate file [03/78] config.txt: move core.* to a separate file [04/78] config.txt: move add.* to a separate file [05/78] config.txt: move alias.* to a separate file [06/78] config.txt: move am.* to a separate file [07/78] config.txt: move apply.* to a separate file [08/78] config.txt: move blame.* to a separate file [09/78] config.txt: move branch.* to a separate file [10/78] config.txt: move browser.* to a separate file [11/78] config.txt: move checkout.* to a separate file [12/78] config.txt: move clean.* to a separate file [13/78] config.txt: move color.* to a separate file [14/78] config.txt: move column.* to a separate file [15/78] config.txt: move commit.* to a separate file [16/78] config.txt: move credential.* to a separate file [17/78] config.txt: move completion.* to a separate file [18/78] config.txt: move diff-config.txt to config/ [19/78] config.txt: move difftool.* to a separate file [20/78] config.txt: move fastimport.* to a separate file [21/78] config.txt: move fetch-config.txt to config/ [22/78] config.txt: move filter.* to a separate file [23/78] config.txt: move format-config.txt to config/ [24/78] config.txt: move fmt-merge-msg-config.txt to config/ [25/78] config.txt: move fsck.* to a separate file [26/78] config.txt: move gc.* to a separate file [27/78] config.txt: move gitcvs-config.txt to config/ [28/78] config.txt: move gitweb.* to a separate file [29/78] config.txt: move grep.* to a separate file [30/78] config.txt: move gpg.* to a separate file [31/78] config.txt: move gui-config.txt to config/ [32/78] config.txt: move guitool.* to a separate file [33/78] config.txt: move help.* to a separate file [34/78] config.txt: move ssh.* to a separate file [35/78] config.txt: move http.* to a separate file [36/78] config.txt: move i18n.* to a separate file [37/78] git-imap-send.txt: move imap.* to a separate file [38/78] config.txt: move index.* to a separate file [39/78] config.txt: move init.* to a separate file [40/78] config.txt: move instaweb.* to a separate file [41/78] config.txt: move interactive.* to a separate file [42/78] config.txt: move log.* to a separate file [43/78] config.txt: move mailinfo.* to a separate file [44/78] config.txt: move mailmap.* to a separate file [45/78] config.txt: move man.* to a separate file [46/78] config.txt: move merge-config.txt to config/ [47/78] config.txt: move mergetool.* to a separate file [48/78] config.txt: move notes.* to a separate file [49/78] config.txt: move pack.* to a separate file [50/78] config.txt: move pager.* to a separate file [51/78] config.txt: move pretty.* to a separate file [52/78] config.txt: move protocol.* to a separate file [53/78] config.txt: move pull-config.txt to config/ [54/78] config.txt: move push-config.txt to config/ [55/78] config.txt: move rebase-config.txt to config/ [56/78] config.txt: move receive-config.txt to config/ [57/78] config.txt: move remote.* to a separate file [58/78] config.txt: move remotes.* to a separate file [59/78] config.txt: move repack.* to a separate file [60/78] config.txt: move rerere.* to a separate file [61/78] config.txt: move reset.* to a separate file [62/78] config.txt: move sendemail-config.txt to config/ [63/78] config.txt: move sequencer.* to a separate file [64/78] config.txt: move showBranch.* to a separate file [65/78] config.txt: move splitIndex.* to a separate file [66/78] config.txt: move status.* to a separate file [67/78] config.txt: move stash.* to a separate file [68/78] config.txt: move submodule.* to a separate file [69/78] config.txt: move tag.* to a separate file [70/78] config.txt: move transfer.* to a separate file [71/78] config.txt: move uploadarchive.* to a separate file [72/78] config.txt: move uploadpack.* to a separate file [73/78] config.txt: move url.* to a separate file [74/78] config.txt: move user.* to a separate file [75/78] config.txt: move versionsort.* to a separate file [76/78] config.txt: move web.* to a separate file [77/78] config.txt: move worktree.* to a separate file

diff --git a/Documentation/config.txt b/Documentation/config.txt index babe2e5682..4e839db64c 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -377,126 +377,7 @@ 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. +include::config/pack.txt[] pager.<cmd>:: If the value is boolean, turns on or off pagination of the diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.txt new file mode 100644 index 0000000000..edac75c83f --- /dev/null +++ b/Documentation/config/pack.txt @@ -0,0 +1,120 @@ +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.

[49/78] config.txt: move pack.* to a separate file

Commit Message

Patch