Subject: [PATCH] index-format.txt: document v2 format of file system monitor extension

From: "Jeff Hostetler via GitGitGadget" <[email-masked]>
Date: Mon, 14 Dec 2020 13:33:42 +0000

From: Jeff Hostetler <[email-masked]>

Update the documentation of the file system monitor extension to
describe version 2.

The format was extended to support opaque tokens in:
56c6910028 fsmonitor: change last update timestamp on the index_state to opaque token

Signed-off-by: Jeff Hostetler <[email-masked]>
---
    index-format.txt: document v2 format of file system monitor extension
    
    While studying the FSMonitor code I noticed that the documentation for
    the FSMN index extension did not get updated for V2 format.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-813%2Fjeffhostetler%2Ffix-fsmonitor-v2-documentation-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-813/jeffhostetler/fix-fsmonitor-v2-documentation-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/813

 Documentation/technical/index-format.txt | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/technical/index-format.txt b/Documentation/technical/index-format.txt
index f9a3644711b..69edf46c031 100644
--- a/Documentation/technical/index-format.txt
+++ b/Documentation/technical/index-format.txt
@@ -306,12 +306,18 @@ The remaining data of each directory block is grouped by type:
 
   The extension starts with
 
-  - 32-bit version number: the current supported version is 1.
+  - 32-bit version number: the current supported versions are 1 and 2.
 
-  - 64-bit time: the extension data reflects all changes through the given
+  - (Version 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.
 
+  - (Version 2)
+    A null terminated string: an opaque token defined by the file system
+    monitor application.  The extension data reflects all changes relative
+    to that token.
+
   - 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

base-commit: 3cf59784d42c4152a0b3de7bb7a75d0071e5f878
-- 
gitgitgadget