git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v7 17/19] index-helper: optionally automatically run

From
David Turner <dturner@twopensource.com>
Date
Apr 30, 2016, 01:02 UTC
Message-ID
<1461978133-13966-18-git-send-email-dturner@twopensource.com>
In-Reply-To
<1461978133-13966-1-git-send-email-dturner@twopensource.com>

Introduce a new config option, indexhelper.autorun, to automatically run git index-helper before starting up a builtin git command. This enables users to keep index-helper running without manual intervention.

Signed-off-by: David Turner <dturner@twopensource.com>
---
 Documentation/config.txt |  4 ++++
 read-cache.c             | 37 +++++++++++++++++++++++++++++++++++--
 t/t7900-index-helper.sh  | 19 +++++++++++++++++++
 3 files changed, 58 insertions(+), 2 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 15001ce..385ea66 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1856,6 +1856,10 @@ index.version::
 	Specify the version with which new index files should be
 	initialized.  This does not affect existing repositories.
 
+indexhelper.autorun::
+	Automatically run git index-helper when any builtin git
+	command is run inside a repository.
+
 init.templateDir::
 	Specify the directory from which templates will be copied.
 	(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
diff --git a/read-cache.c b/read-cache.c
index 5f5e933..99eeee4 100644
--- a/read-cache.c
+++ b/read-cache.c
@@ -21,6 +21,7 @@
 #include "unix-socket.h"
 #include "pkt-line.h"
 #include "ewah/ewok.h"
+#include "run-command.h"
 
 static struct cache_entry *refresh_cache_entry(struct cache_entry *ce,
 					       unsigned int options);
@@ -1723,6 +1724,33 @@ static void post_read_index_from(struct index_state *istate)
 	tweak_untracked_cache(istate);
 }
 
+static int want_auto_index_helper(void)
+{
+	int want = -1;
+	const char *value = NULL;
+	const char *key = "indexhelper.autorun";
+
+	if (git_config_key_is_valid(key) &&
+	    !git_config_get_value(key, &value)) {
+		int b = git_config_maybe_bool(key, value);
+		want = b >= 0 ? b : 0;
+	}
+	return want;
+}
+
+static void autorun_index_helper(void)
+{
+	const char *argv[] = {"git-index-helper", "--detach", "--autorun", NULL};
+	if (want_auto_index_helper() <= 0)
+		return;
+
+	trace_argv_printf(argv, "trace: auto index-helper:");
+
+	if (run_command_v_opt(argv,
+			      RUN_SILENT_EXEC_FAILURE | RUN_CLEAN_ON_EXIT))
+		warning(_("You specified indexhelper.autorun, but running git-index-helper failed."));
+}
+
 /* in ms */
 #define WATCHMAN_TIMEOUT 1000
 
@@ -1796,6 +1824,7 @@ static int poke_daemon(struct index_state *istate,
 	if (fd < 0) {
 		warning("Failed to connect to index-helper socket");
 		unlink(git_path("index-helper.sock"));
+		autorun_index_helper();
 		return -1;
 	}
 
@@ -1833,9 +1862,13 @@ static int try_shm(struct index_state *istate)
 	int fd = -1;
 
 	if (!is_main_index(istate) ||
-	    old_size <= 20 ||
-	    stat(git_path("index-helper.sock"), &st))
+	    old_size <= 20)
 		return -1;
+
+	if (stat(git_path("index-helper.sock"), &st)) {
+		autorun_index_helper();
+		return -1;
+	}
 	if (poke_daemon(istate, &st, 0))
 		return -1;
 	sha1 = (unsigned char *)istate->mmap + old_size - 20;
diff --git a/t/t7900-index-helper.sh b/t/t7900-index-helper.sh
index aa6e5fc..2d3ce3c 100755
--- a/t/t7900-index-helper.sh
+++ b/t/t7900-index-helper.sh
@@ -16,6 +16,9 @@ test -n "$NO_MMAP" && {
 }
 
 test_expect_success 'index-helper smoke test' '
+	# We need an existing commit so that the index exists (otherwise,
+	# the index-helper will not be autostarted)
+	test_commit x &&
 	git index-helper --exit-after 1 &&
 	test_path_is_missing .git/index-helper.sock
 '
@@ -46,4 +49,20 @@ test_expect_success 'index-helper is quiet with --autorun' '
 	git index-helper --autorun
 '
 
+test_expect_success 'index-helper autorun works' '
+	rm -f .git/index-helper.sock &&
+	git status &&
+	test_path_is_missing .git/index-helper.sock &&
+	test_config indexhelper.autorun true &&
+	git status &&
+	test -S .git/index-helper.sock &&
+	git status 2>err &&
+	test -S .git/index-helper.sock &&
+	! grep -q . err &&
+	git index-helper --kill &&
+	test_config indexhelper.autorun false &&
+	git status &&
+	test_path_is_missing .git/index-helper.sock
+'
+
 test_done
-- 
2.4.2.767.g62658d5-twtrsrc
Previous: David TurnerNext: David Turner
Message 18 of 20 in “index-helper/watchman”
  1. 00/19 index-helper/watchmanDavid Turner, Apr 30, 2016
  2. 01/19 read-cache.c: fix constness of verify_hdr()David Turner, Apr 30, 2016
  3. 02/19 read-cache: allow to keep mmap'd memory after readingDavid Turner, Apr 30, 2016
  4. 03/19 index-helper: new daemon for caching index and related stuffDavid Turner, Apr 30, 2016
  5. 04/19 index-helper: add --strictDavid Turner, Apr 30, 2016
  6. 05/19 index-helper: log warningsDavid Turner, Apr 30, 2016
  7. 06/19 daemonize(): set a flag before exiting the main processDavid Turner, Apr 30, 2016
  8. 07/19 index-helper: add --detachDavid Turner, Apr 30, 2016
  9. 08/19 read-cache: add watchman 'WAMA' extensionDavid Turner, Apr 30, 2016
  10. 09/19 Add watchman support to reduce index refresh costDavid Turner, Apr 30, 2016
  11. 10/19 index-helper: use watchman to avoid refreshing index with lstat()David Turner, Apr 30, 2016
  12. 11/19 update-index: enable/disable watchman supportDavid Turner, Apr 30, 2016
  13. 12/19 unpack-trees: preserve index extensionsDavid Turner, Apr 30, 2016
  14. 13/19 watchman: add a config option to enable the extensionDavid Turner, Apr 30, 2016
  15. 14/19 index-helper: kill modeDavid Turner, Apr 30, 2016
  16. 15/19 index-helper: don't run if already runningDavid Turner, Apr 30, 2016
  17. 16/19 index-helper: autorun modeDavid Turner, Apr 30, 2016
  18. 17/19 index-helper: optionally automatically runDavid Turner, Apr 30, 2016
  19. 18/19 Add tracing to measure where most of the time is spentDavid Turner, Apr 30, 2016
  20. 19/19 untracked-cache: config optionDavid Turner, Apr 30, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.