From f86b901f2c0b0a66a6e4bbfff011bab4eebbc421 Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Fri, 5 Mar 2021 23:07:26 +0100 Subject: [PATCH] fsmonitor: mark the built-in FSMonitor as experimental Signed-off-by: Johannes Schindelin Signed-off-by: Jeff Hostetler --- Documentation/config/core.txt | 4 ++-- Documentation/git-fsmonitor--daemon.txt | 5 ++++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Documentation/config/core.txt b/Documentation/config/core.txt index 4f6e519bc0..0210f330d7 100644 --- a/Documentation/config/core.txt +++ b/Documentation/config/core.txt @@ -71,7 +71,7 @@ git by avoiding unnecessary scanning of files that have not changed. + See the "fsmonitor-watchman" section of linkgit:githooks[5]. + -Note: The value of this config setting is ignored if the +Note: The value of this config setting is ignored if the (experimental) built-in file system monitor is enabled (see `core.useBuiltinFSMonitor`). core.fsmonitorHookVersion:: @@ -91,7 +91,7 @@ Note: The value of this config setting is ignored if the built-in file system monitor is enabled (see `core.useBuiltinFSMonitor`). core.useBuiltinFSMonitor:: - If set to true, enable the built-in file system monitor + (EXPERIMENTAL) If set to true, enable the built-in file system monitor daemon for this working directory (linkgit:git-fsmonitor--daemon[1]). + Like hook-based file system monitors, the built-in file system monitor diff --git a/Documentation/git-fsmonitor--daemon.txt b/Documentation/git-fsmonitor--daemon.txt index 154e7684da..cf1d4556a5 100644 --- a/Documentation/git-fsmonitor--daemon.txt +++ b/Documentation/git-fsmonitor--daemon.txt @@ -3,7 +3,7 @@ git-fsmonitor--daemon(1) NAME ---- -git-fsmonitor--daemon - A Built-in File System Monitor +git-fsmonitor--daemon - (EXPERIMENTAL) A Built-in File System Monitor SYNOPSIS -------- @@ -16,6 +16,9 @@ SYNOPSIS DESCRIPTION ----------- +NOTE! This command is still only an experiment, subject to change dramatically +(or even to be abandoned). + A daemon to watch the working directory for file and directory changes using platform-specific file system notification facilities.