Skip to content

Commit 17a284d

Browse files
committed
fsmonitor: mark the built-in FSMonitor as experimental
Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 14e280b commit 17a284d

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

Documentation/config/core.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ core.fsmonitor::
6969
+
7070
See the "fsmonitor-watchman" section of linkgit:githooks[5].
7171
+
72-
Note: this option is ignored if the built-in FSMonitor is enabled via the
73-
`core.useBuiltinFSMonitor` option (see linkgit:git-fsmonitor--daemon[1]).
72+
Note: this option is ignored if the experimental built-in FSMonitor is
73+
enabled via the `core.useBuiltinFSMonitor` option (see
74+
linkgit:git-fsmonitor--daemon[1]).
7475

7576
core.fsmonitorHookVersion::
7677
Sets the version of hook that is to be used when calling fsmonitor.
@@ -84,11 +85,11 @@ core.fsmonitorHookVersion::
8485
without race conditions.
8586

8687
core.useBuiltinFSMonitor::
87-
Enable the built-in filesystem event watcher. This requires a
88-
supported platform (such as Windows) and can speed up Git commands
89-
that need to refresh the Git index in a worktree with many files,
90-
such as `git status`. See linkgit:git-fsmonitor--daemon[1] for
91-
details.
88+
(EXPERIMENTAL) Enable the built-in filesystem event watcher. This
89+
requires a supported platform (such as Windows) and can speed up
90+
Git commands that need to refresh the Git index in a worktree
91+
with many files, such as `git status`. See
92+
linkgit:git-fsmonitor--daemon[1] for details.
9293

9394
core.trustctime::
9495
If false, the ctime differences between the index and the

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)