index-format.txt: document v2 format of file system monitor extension
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 <jeffhost@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff Hostetler committed
Dec 14, 2020 at 13:33 UTC
5885367e8f4d9fa2637642bb2eb1db8542ffd551
1 file changed
+8
-2
Documentation/technical/index-format.txt
+8
-2
@@ -304,12 +304,18 @@ The remaining data of each directory block is grouped by type:
304
305
The extension starts with
306
307
- - 32-bit version number: the current supported version is 1.
307
+ - 32-bit version number: the current supported versions are 1 and 2.
308
309
- - 64-bit time: the extension data reflects all changes through the given
309
+ - (Version 1)
310
+ 64-bit time: the extension data reflects all changes through the given
311
time which is stored as the nanoseconds elapsed since midnight,
312
January 1, 1970.
313
314
+ - (Version 2)
315
+ A null terminated string: an opaque token defined by the file system
316
+ monitor application. The extension data reflects all changes relative
317
+ to that token.
318
+
319
- 32-bit bitmap size: the size of the CE_FSMONITOR_VALID bitmap.
320
321
- An ewah bitmap, the n-th bit indicates whether the n-th index entry