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 v2 21/21] Documentation/git-update-index: explain splitIndex.*
Date: Sat, 17 Dec 2016 15:55:47 +0100 [thread overview]
Message-ID: <20161217145547.11748-22-chriscool@tuxfamily.org> (raw)
In-Reply-To: <20161217145547.11748-1-chriscool@tuxfamily.org>
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
Documentation/config.txt | 6 +++---
Documentation/git-update-index.txt | 37 +++++++++++++++++++++++++++++--------
2 files changed, 32 insertions(+), 11 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 8fbef25cb1..52a3cac4ff 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -2782,9 +2782,9 @@ splitIndex.sharedIndexExpire::
index file is created. The value "now" expires all entries
immediately, and "never" suppresses expiration altogether.
The default value is "one.week.ago".
- Note that each time a new split-index file is created, the
- mtime of the related shared index file is updated to the
- current time.
+ Note that each time a split index based on a shared index file
+ is either created or read from, the mtime of the shared index
+ file is updated to the current time.
See linkgit:git-update-index[1].
status.relativePaths::
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index e091b2a409..46c953b2f2 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,31 @@ 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 their mtime is older than what is specified by
+the splitIndex.sharedIndexExpire config variable (see
+linkgit:git-config[1]).
+
+To avoid deleting a shared index file that is still used, its mtime is
+updated to the current time everytime a new split index based on the
+shared index file is either created or read from.
+
Untracked cache
---------------
--
2.11.0.49.g2414764.dirty
next prev parent reply other threads:[~2016-12-17 14:56 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-17 14:55 [PATCH v2 00/21] Add configuration options for split-index Christian Couder
2016-12-17 14:55 ` [PATCH v2 01/21] config: mark an error message up for translation Christian Couder
2016-12-17 14:55 ` [PATCH v2 02/21] config: add git_config_get_split_index() Christian Couder
2016-12-19 11:14 ` Duy Nguyen
2016-12-26 8:15 ` Christian Couder
2016-12-17 14:55 ` [PATCH v2 03/21] split-index: add {add,remove}_split_index() functions Christian Couder
2016-12-17 14:55 ` [PATCH v2 04/21] read-cache: add and then use tweak_split_index() Christian Couder
2016-12-19 11:18 ` Duy Nguyen
2016-12-26 8:20 ` Christian Couder
2016-12-17 14:55 ` [PATCH v2 05/21] update-index: warn in case of split-index incoherency Christian Couder
2016-12-17 14:55 ` [PATCH v2 06/21] t1700: add tests for core.splitIndex Christian Couder
2016-12-17 14:55 ` [PATCH v2 07/21] Documentation/config: add information " Christian Couder
2016-12-17 14:55 ` [PATCH v2 08/21] Documentation/git-update-index: talk about core.splitIndex config var Christian Couder
2016-12-17 14:55 ` [PATCH v2 09/21] config: add git_config_get_max_percent_split_change() Christian Couder
2016-12-17 14:55 ` [PATCH v2 10/21] read-cache: regenerate shared index if necessary Christian Couder
2016-12-19 11:48 ` Duy Nguyen
2016-12-26 8:33 ` Christian Couder
2016-12-17 14:55 ` [PATCH v2 11/21] t1700: add tests for splitIndex.maxPercentChange Christian Couder
2016-12-17 14:55 ` [PATCH v2 12/21] Documentation/config: add splitIndex.maxPercentChange Christian Couder
2016-12-17 14:55 ` [PATCH v2 13/21] sha1_file: make check_and_freshen_file() non static Christian Couder
2016-12-17 14:55 ` [PATCH v2 14/21] read-cache: touch shared index files when used Christian Couder
2016-12-17 14:55 ` [PATCH v2 15/21] config: add git_config_get_expiry() from gc.c Christian Couder
2016-12-17 14:55 ` [PATCH v2 16/21] read-cache: unlink old sharedindex files Christian Couder
2016-12-19 11:58 ` Duy Nguyen
2016-12-26 9:54 ` Christian Couder
2016-12-17 14:55 ` [PATCH v2 17/21] t1700: test shared index file expiration Christian Couder
2016-12-17 14:55 ` [PATCH v2 18/21] read-cache: refactor read_index_from() Christian Couder
2016-12-17 14:55 ` [PATCH v2 19/21] read-cache: use freshen_shared_index() in read_index_from() Christian Couder
2016-12-17 14:55 ` [PATCH v2 20/21] Documentation/config: add splitIndex.sharedIndexExpire Christian Couder
2016-12-17 14:55 ` Christian Couder [this message]
2016-12-17 15:35 ` [PATCH v2 00/21] Add configuration options for split-index Christian Couder
2016-12-19 12:02 ` Duy Nguyen
2016-12-19 21:03 ` Junio C Hamano
2016-12-26 10:32 ` 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=20161217145547.11748-22-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).