From: Christian Couder <christian.couder@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Nguyen Thai Ngoc Duy" <pclouds@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Christian Couder" <chriscool@tuxfamily.org>
Subject: [PATCH v1 19/19] Documentation/git-update-index: explain splitIndex.*
Date: Sun, 23 Oct 2016 11:26:48 +0200 [thread overview]
Message-ID: <20161023092648.12086-20-chriscool@tuxfamily.org> (raw)
In-Reply-To: <20161023092648.12086-1-chriscool@tuxfamily.org>
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
Documentation/git-update-index.txt | 33 +++++++++++++++++++++++++--------
1 file changed, 25 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index e091b2a..635d157 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -163,14 +163,10 @@ may not support it yet.
--split-index::
--no-split-index::
- Enable or disable split index mode. If enabled, the index is
- split into two files, $GIT_DIR/index and $GIT_DIR/sharedindex.<SHA-1>.
- Changes are accumulated in $GIT_DIR/index while the shared
- index file contains all index entries stays unchanged. If
- split-index mode is already enabled and `--split-index` is
- given again, all changes in $GIT_DIR/index are pushed back to
- the shared index file. This mode is designed for very large
- indexes that take a significant amount of time to read or write.
+ Enable or disable split index mode. If split-index mode is
+ already enabled and `--split-index` is given again, all
+ changes in $GIT_DIR/index are pushed back to the shared index
+ file.
+
These options take effect whatever the value of the `core.splitIndex`
configuration variable (see linkgit:git-config[1]). But a warning is
@@ -394,6 +390,27 @@ Although this bit looks similar to assume-unchanged bit, its goal is
different from assume-unchanged bit's. Skip-worktree also takes
precedence over assume-unchanged bit when both are set.
+Split index
+-----------
+
+This mode is designed for very large indexes that take a significant
+amount of time to read or write.
+
+In this mode, the index is split into two files, $GIT_DIR/index and
+$GIT_DIR/sharedindex.<SHA-1>. Changes are accumulated in
+$GIT_DIR/index, the split index, while the shared index file contains
+all index entries and stays unchanged.
+
+All changes in the split index are pushed back to the shared index
+file when the number of entries in the split index reaches a level
+specified by the splitIndex.maxPercentChange config variable (see
+linkgit:git-config[1]).
+
+Each time a new shared index file is created, the old shared index
+files are deleted if they are older than what is specified by the
+splitIndex.sharedIndexExpire config variable (see
+linkgit:git-config[1]).
+
Untracked cache
---------------
--
2.10.1.462.g7e1e03a
next prev parent reply other threads:[~2016-10-23 9:27 UTC|newest]
Thread overview: 66+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-23 9:26 [PATCH v1 00/19] Add configuration options for split-index Christian Couder
2016-10-23 9:26 ` [PATCH v1 01/19] split-index: s/eith/with/ typo fix Christian Couder
2016-10-23 9:26 ` [PATCH v1 02/19] config: add git_config_get_split_index() Christian Couder
2016-10-23 9:26 ` [PATCH v1 03/19] split-index: add {add,remove}_split_index() functions Christian Couder
2016-10-25 9:58 ` Duy Nguyen
2016-10-29 22:06 ` Christian Couder
2016-11-07 10:08 ` Duy Nguyen
2016-11-09 9:24 ` Duy Nguyen
2016-11-09 14:47 ` Christian Couder
2016-10-23 9:26 ` [PATCH v1 04/19] read-cache: add and then use tweak_split_index() Christian Couder
2016-10-23 9:26 ` [PATCH v1 05/19] update-index: warn in case of split-index incoherency Christian Couder
2016-10-25 10:00 ` Duy Nguyen
2016-10-29 22:19 ` Christian Couder
2016-11-01 19:05 ` Junio C Hamano
2016-11-01 23:00 ` Christian Couder
2016-11-02 1:37 ` Junio C Hamano
2016-10-23 9:26 ` [PATCH v1 06/19] t1700: add tests for core.splitIndex Christian Couder
2016-10-23 9:26 ` [PATCH v1 07/19] Documentation/config: add information " Christian Couder
2016-10-23 9:26 ` [PATCH v1 08/19] Documentation/git-update-index: talk about core.splitIndex config var Christian Couder
2016-10-23 9:26 ` [PATCH v1 09/19] config: add git_config_get_max_percent_split_change() Christian Couder
2016-10-25 10:06 ` Duy Nguyen
2016-10-29 22:24 ` Christian Couder
2016-11-01 19:13 ` Junio C Hamano
2016-11-05 0:27 ` Christian Couder
2016-10-23 9:26 ` [PATCH v1 10/19] read-cache: regenerate shared index if necessary Christian Couder
2016-10-23 16:07 ` Ramsay Jones
2016-10-29 22:40 ` Christian Couder
2016-10-25 10:16 ` Duy Nguyen
2016-10-29 22:58 ` Christian Couder
2016-10-23 9:26 ` [PATCH v1 11/19] t1700: add tests for splitIndex.maxPercentChange Christian Couder
2016-11-01 19:15 ` Junio C Hamano
2016-10-23 9:26 ` [PATCH v1 12/19] Documentation/config: add splitIndex.maxPercentChange Christian Couder
2016-11-01 19:19 ` Junio C Hamano
2016-11-05 0:45 ` Christian Couder
2016-11-06 17:16 ` Junio C Hamano
[not found] ` <CAP8UFD1YL+RgdqbV0V1OnC=sJHJFc_an02Q9JeDNapW+u1CZcA@mail.gmail.com>
2016-11-07 9:38 ` Duy Nguyen
2016-11-18 14:34 ` Christian Couder
2016-11-22 10:35 ` Duy Nguyen
2016-11-22 13:13 ` Christian Couder
2016-11-22 13:20 ` Duy Nguyen
2016-10-23 9:26 ` [PATCH v1 13/19] sha1_file: make check_and_freshen_file() non static Christian Couder
2016-10-23 9:26 ` [PATCH v1 14/19] read-cache: touch shared index files when used Christian Couder
2016-10-25 10:26 ` Duy Nguyen
2016-11-01 19:23 ` Junio C Hamano
2016-10-23 9:26 ` [PATCH v1 15/19] config: add git_config_get_date_string() from gc.c Christian Couder
2016-11-01 19:28 ` Junio C Hamano
2016-11-23 15:04 ` Christian Couder
2016-11-23 17:34 ` Junio C Hamano
2016-11-28 16:19 ` Christian Couder
2016-11-28 16:56 ` Junio C Hamano
2016-10-23 9:26 ` [PATCH v1 16/19] read-cache: unlink old sharedindex files Christian Couder
2016-10-25 10:43 ` Duy Nguyen
2016-10-27 10:25 ` Duy Nguyen
2016-10-27 12:14 ` Christian Couder
2016-10-27 16:13 ` Junio C Hamano
2016-10-29 3:30 ` Duy Nguyen
2016-10-23 9:26 ` [PATCH v1 17/19] t1700: test shared index file expiration Christian Couder
2016-10-23 9:26 ` [PATCH v1 18/19] Documentation/config: add splitIndex.sharedIndexExpire Christian Couder
2016-10-23 9:26 ` Christian Couder [this message]
2016-10-24 18:07 ` [PATCH v1 00/19] Add configuration options for split-index Junio C Hamano
2016-10-25 9:30 ` Duy Nguyen
2016-10-25 17:21 ` Junio C Hamano
2016-10-26 9:25 ` Duy Nguyen
2016-10-26 16:14 ` Junio C Hamano
2016-10-25 10:52 ` Duy Nguyen
2016-11-03 14:34 ` Christian Couder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161023092648.12086-20-chriscool@tuxfamily.org \
--to=christian.couder@gmail.com \
--cc=avarab@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=pclouds@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).