[PATCH 2/2] bitmap-format.txt: add information for trailing checksum

From: Abhradeep Chakraborty via GitGitGadget <gitgitgadget@gmail.com>
Date: Jun 2, 2022, 13:52 UTC
Message-ID: <ba534b5d4868b4451b377e74d1b554fb1d2e8ad2.1654177966.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.1246.git.1654177966.gitgitgadget@gmail.com>

From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>

Bitmap file has a trailing checksum at the end of the file. However there is no information in the bitmap-format documentation about it.

Add a trailer section to include the trailing checksum info in the `Documentation/technical/bitmap-format.txt` file.

Signed-off-by: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
---
 Documentation/technical/bitmap-format.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt
index 110d7ddf8ed..6846e7221a7 100644
--- a/Documentation/technical/bitmap-format.txt
+++ b/Documentation/technical/bitmap-format.txt
@@ -125,6 +125,10 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
 
 			** The compressed bitmap itself, see Appendix A.
 
+	* TRAILER:
+
+		Index checksum of the above contents.
+
 == Appendix A: Serialization format for an EWAH bitmap
 
 Ewah bitmaps are serialized in the same protocol as the JAVAEWAH

-- 
gitgitgadget