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

[PATCH v12 18/20] index-helper: optionally automatically run

From
David Turner <dturner@twopensource.com>
Date
May 19, 2016, 21:45 UTC
Message-ID
<1463694357-6503-19-git-send-email-dturner@twopensource.com>
In-Reply-To
<1463694357-6503-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  | 20 ++++++++++++++++++++
 3 files changed, 59 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 6d3fe71..76aecca 100644
--- a/read-cache.c
+++ b/read-cache.c
@@ -22,6 +22,7 @@
 #include "pkt-line.h"
 #include "sigchain.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
 
@@ -1794,6 +1822,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;
 	}
 	sigchain_push(SIGPIPE, SIG_IGN);
@@ -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..3cfdf63 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,21 @@ test_expect_success 'index-helper is quiet with --autorun' '
 	git index-helper --autorun
 '
 
+test_expect_success 'index-helper autorun works' '
+	test_when_finished "git index-helper --kill" &&
+	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 &&
+	test_must_be_empty 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: Duy NguyenNext: Duy Nguyen
Message 43 of 49 in “index-helper/watchman”
  1. 00/20 index-helper/watchmanDavid Turner, May 19, 2016
  2. 01/20 read-cache.c: fix constness of verify_hdr()David Turner, May 19, 2016
  3. 02/20 read-cache: allow to keep mmap'd memory after readingDavid Turner, May 19, 2016
  4. 03/20 pkt-line: add gentle version of packet_writeDavid Turner, May 19, 2016
  5. Duy NguyenJun 25, 2016
  6. 04/20 index-helper: new daemon for caching index and related stuffDavid Turner, May 19, 2016
  7. Christian CouderJun 17, 2016
  8. Duy NguyenJun 25, 2016
  9. Duy NguyenJun 25, 2016
  10. David TurnerJun 25, 2016
  11. Duy NguyenJun 26, 2016
  12. David TurnerJun 26, 2016
  13. Duy NguyenJun 27, 2016
  14. Eric WongJun 26, 2016
  15. David TurnerJun 26, 2016
  16. Eric WongJun 26, 2016
  17. 05/20 index-helper: add --strictDavid Turner, May 19, 2016
  18. Duy NguyenJun 25, 2016
  19. 06/20 daemonize(): set a flag before exiting the main processDavid Turner, May 19, 2016
  20. 07/20 index-helper: add --detachDavid Turner, May 19, 2016
  21. Duy NguyenJun 25, 2016
  22. 08/20 index-helper: log warningsDavid Turner, May 19, 2016
  23. 09/20 read-cache: add watchman 'WAMA' extensionDavid Turner, May 19, 2016
  24. Duy NguyenJun 25, 2016
  25. 10/20 watchman: support watchman to reduce index refresh costDavid Turner, May 19, 2016
  26. Christian CouderJun 17, 2016
  27. 11/20 index-helper: use watchman to avoid refreshing index with lstat()David Turner, May 19, 2016
  28. Duy NguyenJun 17, 2016
  29. David TurnerJun 17, 2016
  30. David TurnerJun 19, 2016
  31. David TurnerJun 23, 2016
  32. Duy NguyenJun 23, 2016
  33. Duy NguyenJun 25, 2016
  34. 12/20 update-index: enable/disable watchman supportDavid Turner, May 19, 2016
  35. Duy NguyenJun 25, 2016
  36. 13/20 unpack-trees: preserve index extensionsDavid Turner, May 19, 2016
  37. 14/20 watchman: add a config option to enable the extensionDavid Turner, May 19, 2016
  38. 15/20 index-helper: kill modeDavid Turner, May 19, 2016
  39. 16/20 index-helper: don't run if already runningDavid Turner, May 19, 2016
  40. Christian CouderJun 17, 2016
  41. 17/20 index-helper: autorun modeDavid Turner, May 19, 2016
  42. Duy NguyenJun 25, 2016
  43. 18/20 index-helper: optionally automatically runDavid Turner, May 19, 2016
  44. Duy NguyenJun 25, 2016
  45. 19/20 trace: measure where the time is spent in the index-heavy operationsDavid Turner, May 19, 2016
  46. 20/20 index-helper: indexhelper.exitafter configDavid Turner, May 19, 2016
  47. Duy NguyenJun 25, 2016
  48. Duy NguyenJun 25, 2016
  49. David TurnerJun 26, 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.