git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-04-28 02:23:48 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity

fsmonitor: reintroduce core.useBuiltinFSMonitor

Browse Source 
Reintroduce the 'core.useBuiltinFSMonitor' config setting (originally added
in 0a756b2a25 (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 <vdye@github.com>
This commit is contained in:
Victoria Dye
2022-04-04 15:38:58 -07:00
committed by Matthew John Cheetham
parent 31694915b4
commit e890ff37e8
4 changed files with 37 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/config/advice.txt
View File

@@ -138,4 +138,7 @@ advice.*::
checkout.
diverging::
Advice shown when a fast-forward is not possible.
useCoreFSMonitorConfig::
Advice shown if the deprecated 'core.useBuiltinFSMonitor' config
setting is in use.
--