Skip to content

Commit 4aa173b

Browse files
dschoGit for Windows Build Agent
authored andcommitted
fsmonitor: mark the built-in FSMonitor as experimental
Signed-off-by: Johannes Schindelin <[email protected]>
1 parent fda6f6f commit 4aa173b

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

Documentation/config/core.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ core.fsmonitor::
7070
See the "fsmonitor-watchman" section of linkgit:githooks[5].
7171
+
7272
Note: FSMonitor hooks (and this config setting) are ignored if the
73-
built-in FSMonitor is enabled (see `core.useBuiltinFSMonitor`).
73+
(experimental) built-in FSMonitor is enabled (see
74+
`core.useBuiltinFSMonitor`).
7475

7576
core.fsmonitorHookVersion::
7677
Sets the version of hook that is to be used when calling the
@@ -89,8 +90,9 @@ Note: FSMonitor hooks (and this config setting) are ignored if the
8990
built-in FSMonitor is enabled (see `core.useBuiltinFSMonitor`).
9091

9192
core.useBuiltinFSMonitor::
92-
If set to true, enable the built-in filesystem event watcher (for
93-
technical details, see linkgit:git-fsmonitor--daemon[1]).
93+
(EXPERIMENTAL) If set to true, enable the built-in filesystem
94+
event watcher (for technical details, see
95+
linkgit:git-fsmonitor--daemon[1]).
9496
+
9597
Like external (hook-based) FSMonitors, the built-in FSMonitor can speed up
9698
Git commands that need to refresh the Git index (e.g. `git status`) in a

Documentation/git-fsmonitor--daemon.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-fsmonitor--daemon(1)
33

44
NAME
55
----
6-
git-fsmonitor--daemon - Builtin file system monitor daemon
6+
git-fsmonitor--daemon - (EXPERIMENTAL) Builtin file system monitor daemon
77

88
SYNOPSIS
99
--------
@@ -20,6 +20,9 @@ SYNOPSIS
2020
DESCRIPTION
2121
-----------
2222

23+
NOTE! This command is still only an experiment, subject to change dramatically
24+
(or even to be abandoned).
25+
2326
Monitors files and directories in the working directory for changes using
2427
platform-specific file system notification facilities.
2528

0 commit comments

Comments
 (0)