path: root/Documentation/technical
diff options
authorBen Peart <>2017-09-22 16:35:41 (GMT)
committerJunio C Hamano <>2017-10-01 08:23:05 (GMT)
commit780494b1f5c3744860c485d1e9f1b23879f8936f (patch)
tree004b18325fca198ffb5e15b827728c6abf9f9edc /Documentation/technical
parent883e248b8a0fd88773cb902ab8e91273eb147d07 (diff)
fsmonitor: add documentation for the fsmonitor extension.
This includes the core.fsmonitor setting, the fsmonitor integration hook, and the fsmonitor index extension. Also add documentation for the new fsmonitor options to ls-files and update-index. Signed-off-by: Ben Peart <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/technical')
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/technical/index-format.txt b/Documentation/technical/index-format.txt
index ade0b0c..db35726 100644
--- a/Documentation/technical/index-format.txt
+++ b/Documentation/technical/index-format.txt
@@ -295,3 +295,22 @@ The remaining data of each directory block is grouped by type:
in the previous ewah bitmap.
- One NUL.
+== File System Monitor cache
+ The file system monitor cache tracks files for which the core.fsmonitor
+ hook has told us about changes. The signature for this extension is
+ { 'F', 'S', 'M', 'N' }.
+ The extension starts with
+ - 32-bit version number: the current supported version is 1.
+ - 64-bit time: the extension data reflects all changes through the given
+ time which is stored as the nanoseconds elapsed since midnight,
+ January 1, 1970.
+ - 32-bit bitmap size: the size of the CE_FSMONITOR_VALID bitmap.
+ - An ewah bitmap, the n-th bit indicates whether the n-th index entry