Skip to content

Commit e890ff3

Browse files
vdyemjcheetham
authored andcommitted
fsmonitor: reintroduce core.useBuiltinFSMonitor
Reintroduce the 'core.useBuiltinFSMonitor' config setting (originally added in 0a756b2 (fsmonitor: config settings are repository-specific, 2021-03-05)) after its removal from the upstream version of FSMonitor. Upstream, the 'core.useBuiltinFSMonitor' setting was rendered obsolete by "overloading" the 'core.fsmonitor' setting to take a boolean value. However, several applications (e.g., 'scalar') utilize the original config setting, so it should be preserved for a deprecation period before complete removal: * if 'core.fsmonitor' is a boolean, the user is correctly using the new config syntax; do not use 'core.useBuiltinFSMonitor'. * if 'core.fsmonitor' is unspecified, use 'core.useBuiltinFSMonitor'. * if 'core.fsmonitor' is a path, override and use the builtin FSMonitor if 'core.useBuiltinFSMonitor' is 'true'; otherwise, use the FSMonitor hook indicated by the path. Additionally, for this deprecation period, advise users to switch to using 'core.fsmonitor' to specify their use of the builtin FSMonitor. Signed-off-by: Victoria Dye <[email protected]>
1 parent 3169491 commit e890ff3

File tree

4 files changed

+37
-2
lines changed

4 files changed

+37
-2
lines changed

Documentation/config/advice.txt

+3
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,7 @@ advice.*::
138138
checkout.
139139
diverging::
140140
Advice shown when a fast-forward is not possible.
141+
useCoreFSMonitorConfig::
142+
Advice shown if the deprecated 'core.useBuiltinFSMonitor' config
143+
setting is in use.
141144
--

advice.c

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ static struct {
7777
[ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
7878
[ADVICE_SUBMODULES_NOT_UPDATED] = { "submodulesNotUpdated", 1 },
7979
[ADVICE_UPDATE_SPARSE_PATH] = { "updateSparsePath", 1 },
80+
[ADVICE_USE_CORE_FSMONITOR_CONFIG] = { "useCoreFSMonitorConfig", 1 },
8081
[ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
8182
};
8283

advice.h

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ struct string_list;
4747
ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
4848
ADVICE_SUBMODULES_NOT_UPDATED,
4949
ADVICE_UPDATE_SPARSE_PATH,
50+
ADVICE_USE_CORE_FSMONITOR_CONFIG,
5051
ADVICE_WAITING_FOR_EDITOR,
5152
ADVICE_SKIPPED_CHERRY_PICKS,
5253
};

fsmonitor-settings.c

+32-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#include "fsmonitor-ipc.h"
66
#include "fsmonitor-settings.h"
77
#include "fsmonitor-path-utils.h"
8+
#include "advice.h"
89

910
/*
1011
* We keep this structure defintion private and have getters
@@ -99,6 +100,31 @@ static struct fsmonitor_settings *alloc_settings(void)
99100
return s;
100101
}
101102

103+
static int check_deprecated_builtin_config(struct repository *r)
104+
{
105+
int core_use_builtin_fsmonitor = 0;
106+
107+
/*
108+
* If 'core.useBuiltinFSMonitor' is set, print a deprecation warning
109+
* suggesting the use of 'core.fsmonitor' instead. If the config is
110+
* set to true, set the appropriate mode and return 1 indicating that
111+
* the check resulted the config being set by this (deprecated) setting.
112+
*/
113+
if(!repo_config_get_bool(r, "core.useBuiltinFSMonitor", &core_use_builtin_fsmonitor) &&
114+
core_use_builtin_fsmonitor) {
115+
if (!git_env_bool("GIT_SUPPRESS_USEBUILTINFSMONITOR_ADVICE", 0)) {
116+
advise_if_enabled(ADVICE_USE_CORE_FSMONITOR_CONFIG,
117+
_("core.useBuiltinFSMonitor=true is deprecated;"
118+
"please set core.fsmonitor=true instead"));
119+
setenv("GIT_SUPPRESS_USEBUILTINFSMONITOR_ADVICE", "1", 1);
120+
}
121+
fsm_settings__set_ipc(r);
122+
return 1;
123+
}
124+
125+
return 0;
126+
}
127+
102128
static void lookup_fsmonitor_settings(struct repository *r)
103129
{
104130
const char *const_str;
@@ -124,12 +150,16 @@ static void lookup_fsmonitor_settings(struct repository *r)
124150
return;
125151

126152
case 1: /* config value was unset */
153+
if (check_deprecated_builtin_config(r))
154+
return;
155+
127156
const_str = getenv("GIT_TEST_FSMONITOR");
128157
break;
129158

130159
case -1: /* config value set to an arbitrary string */
131-
if (repo_config_get_pathname(r, "core.fsmonitor", &const_str))
132-
return; /* should not happen */
160+
if (check_deprecated_builtin_config(r) ||
161+
repo_config_get_pathname(r, "core.fsmonitor", &const_str))
162+
return;
133163
break;
134164

135165
default: /* should not happen */

0 commit comments

Comments
 (0)