Skip to content

Commit bf45de7

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 af6589c commit bf45de7

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

Documentation/config/core.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -749,3 +749,12 @@ core.abbrev::
749749
If set to "no", no abbreviation is made and the object names
750750
are shown in their full length.
751751
The minimum length is 4.
752+
753+
core.configWriteLockTimeoutMS::
754+
When processes try to write to the config concurrently, it is likely
755+
that one process "wins" and the other process(es) fail to lock the
756+
config file. By configuring a timeout larger than zero, Git can be
757+
told to try to lock the config again a couple times within the
758+
specified timeout. If the timeout is configure to zero (which is the
759+
default), Git will fail immediately when the config is already
760+
locked.

config.c

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3202,6 +3202,7 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
32023202
const char *value_pattern,
32033203
unsigned flags)
32043204
{
3205+
static unsigned long timeout_ms = ULONG_MAX;
32053206
int fd = -1, in_fd = -1;
32063207
int ret;
32073208
struct lock_file lock = LOCK_INIT;
@@ -3222,11 +3223,16 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
32223223
if (!config_filename)
32233224
config_filename = filename_buf = git_pathdup("config");
32243225

3226+
if ((long)timeout_ms < 0 &&
3227+
git_config_get_ulong("core.configWriteLockTimeoutMS", &timeout_ms))
3228+
timeout_ms = 0;
3229+
32253230
/*
32263231
* The lock serves a purpose in addition to locking: the new
32273232
* contents of .git/config will be written into it.
32283233
*/
3229-
fd = hold_lock_file_for_update(&lock, config_filename, 0);
3234+
fd = hold_lock_file_for_update_timeout(&lock, config_filename, 0,
3235+
timeout_ms);
32303236
if (fd < 0) {
32313237
error_errno(_("could not lock config file %s"), config_filename);
32323238
ret = CONFIG_NO_LOCK;

0 commit comments

Comments
 (0)