Browse Source

fsmonitor: add documentation for allowRemote and socketDir options

Add documentation for 'fsmonitor.allowRemote' and 'fsmonitor.socketDir'.
Call-out experimental nature of 'fsmonitor.allowRemote' and limited
filesystem support for 'fsmonitor.socketDir'.

Signed-off-by: Eric DeCosta <edecosta@mathworks.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Eric DeCosta 2 years ago committed by Junio C Hamano
parent
commit
5aa9e3262e
  1. 2
      Documentation/config.txt
  2. 11
      Documentation/config/fsmonitor--daemon.txt
  3. 37
      Documentation/git-fsmonitor--daemon.txt

2
Documentation/config.txt

@ -423,6 +423,8 @@ include::config/filter.txt[] @@ -423,6 +423,8 @@ include::config/filter.txt[]

include::config/fsck.txt[]

include::config/fsmonitor--daemon.txt[]

include::config/gc.txt[]

include::config/gitcvs.txt[]

11
Documentation/config/fsmonitor--daemon.txt

@ -0,0 +1,11 @@ @@ -0,0 +1,11 @@
fsmonitor.allowRemote::
By default, the fsmonitor daemon refuses to work against network-mounted
repositories. Setting `fsmonitor.allowRemote` to `true` overrides this
behavior. Only respected when `core.fsmonitor` is set to `true`.

fsmonitor.socketDir::
This Mac OS-specific option, if set, specifies the directory in
which to create the Unix domain socket used for communication
between the fsmonitor daemon and various Git commands. The directory must
reside on a native Mac OS filesystem. Only respected when `core.fsmonitor`
is set to `true`.

37
Documentation/git-fsmonitor--daemon.txt

@ -3,7 +3,7 @@ git-fsmonitor{litdd}daemon(1) @@ -3,7 +3,7 @@ git-fsmonitor{litdd}daemon(1)

NAME
----
git-fsmonitor--daemon - A Built-in File System Monitor
git-fsmonitor--daemon - A Built-in Filesystem Monitor

SYNOPSIS
--------
@ -17,7 +17,7 @@ DESCRIPTION @@ -17,7 +17,7 @@ DESCRIPTION
-----------

A daemon to watch the working directory for file and directory
changes using platform-specific file system notification facilities.
changes using platform-specific filesystem notification facilities.

This daemon communicates directly with commands like `git status`
using the link:technical/api-simple-ipc.html[simple IPC] interface
@ -63,13 +63,44 @@ CAVEATS @@ -63,13 +63,44 @@ CAVEATS
-------

The fsmonitor daemon does not currently know about submodules and does
not know to filter out file system events that happen within a
not know to filter out filesystem events that happen within a
submodule. If fsmonitor daemon is watching a super repo and a file is
modified within the working directory of a submodule, it will report
the change (as happening against the super repo). However, the client
will properly ignore these extra events, so performance may be affected
but it will not cause an incorrect result.

By default, the fsmonitor daemon refuses to work against network-mounted
repositories; this may be overridden by setting `fsmonitor.allowRemote` to
`true`. Note, however, that the fsmonitor daemon is not guaranteed to work
correctly with all network-mounted repositories and such use is considered
experimental.

On Mac OS, the inter-process communication (IPC) between various Git
commands and the fsmonitor daemon is done via a Unix domain socket (UDS) -- a
special type of file -- which is supported by native Mac OS filesystems,
but not on network-mounted filesystems, NTFS, or FAT32. Other filesystems
may or may not have the needed support; the fsmonitor daemon is not guaranteed
to work with these filesystems and such use is considered experimental.

By default, the socket is created in the `.git` directory, however, if the
`.git` directory is on a network-mounted filesystem, it will be instead be
created at `$HOME/.git-fsmonitor-*` unless `$HOME` itself is on a
network-mounted filesystem in which case you must set the configuration
variable `fsmonitor.socketDir` to the path of a directory on a Mac OS native
filesystem in which to create the socket file.

If none of the above directories (`.git`, `$HOME`, or `fsmonitor.socketDir`)
is on a native Mac OS file filesystem the fsmonitor daemon will report an
error that will cause the daemon and the currently running command to exit.

CONFIGURATION
-------------

include::includes/cmd-config-section-all.txt[]

include::config/fsmonitor--daemon.txt[]

GIT
---
Part of the linkgit:git[1] suite

Loading…
Cancel
Save