Skip to content

Commit 38b92fd

Browse files
committed
git_config_set_multivar_in_file_gently(): add a lock timeout
In particular when multiple processes want to write to the config simultaneously, it would come in handy to not fail immediately when another process locked the config, but to gently try again. This will help with Scalar's functional test suite which wants to register multiple repositories for maintenance semi-simultaneously. As not all code paths calling this function read the config (e.g. `git config`), we have to read the config setting via `git_config_get_ulong()`. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
1 parent 535f82e commit 38b92fd

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

Documentation/config/core.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,3 +795,12 @@ core.WSLCompat::
795795
The default value is false. When set to true, Git will set the mode
796796
bits of the file in the way of wsl, so that the executable flag of
797797
files can be set or read correctly.
798+
799+
core.configWriteLockTimeoutMS::
800+
When processes try to write to the config concurrently, it is likely
801+
that one process "wins" and the other process(es) fail to lock the
802+
config file. By configuring a timeout larger than zero, Git can be
803+
told to try to lock the config again a couple times within the
804+
specified timeout. If the timeout is configure to zero (which is the
805+
default), Git will fail immediately when the config is already
806+
locked.

config.c

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2953,6 +2953,7 @@ int repo_config_set_multivar_in_file_gently(struct repository *r,
29532953
const char *comment,
29542954
unsigned flags)
29552955
{
2956+
static unsigned long timeout_ms = ULONG_MAX;
29562957
int fd = -1, in_fd = -1;
29572958
int ret;
29582959
struct lock_file lock = LOCK_INIT;
@@ -2981,11 +2982,16 @@ int repo_config_set_multivar_in_file_gently(struct repository *r,
29812982
if (!config_filename)
29822983
config_filename = filename_buf = repo_git_path(r, "config");
29832984

2985+
if ((long)timeout_ms < 0 &&
2986+
repo_config_get_ulong(r, "core.configWriteLockTimeoutMS", &timeout_ms))
2987+
timeout_ms = 0;
2988+
29842989
/*
29852990
* The lock serves a purpose in addition to locking: the new
29862991
* contents of .git/config will be written into it.
29872992
*/
2988-
fd = hold_lock_file_for_update(&lock, config_filename, 0);
2993+
fd = hold_lock_file_for_update_timeout(&lock, config_filename, 0,
2994+
timeout_ms);
29892995
if (fd < 0) {
29902996
error_errno(_("could not lock config file %s"), config_filename);
29912997
ret = CONFIG_NO_LOCK;

0 commit comments

Comments
 (0)