From: "Abhradeep Chakraborty via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Taylor Blau <me@ttaylorr.com>, Vicent Marti <tanoku@gmail.com>,
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>,
Derrick Stolee <derrickstolee@github.com>,
Junio C Hamano <gitster@pobox.com>,
Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>,
Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
Subject: [PATCH v2 2/3] bitmap-format.txt: fix some formatting issues
Date: Tue, 07 Jun 2022 17:43:33 +0000 [thread overview]
Message-ID: <cb919513c14d426b51051ee5c16badec37538032.1654623814.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1246.v2.git.1654623814.gitgitgadget@gmail.com>
From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
The asciidoc generated html for `Documentation/technical/bitmap-
format.txt` is broken. This is mainly because `-` is used for nested
lists (which is not allowed in asciidoc) instead of `*`.
Fix these and also reformat it (e.g. removing some blank lines) for
better readability of the html page.
Signed-off-by: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
---
Documentation/technical/bitmap-format.txt | 20 +++++++-------------
1 file changed, 7 insertions(+), 13 deletions(-)
diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt
index 04b3ec21785..f22669b5916 100644
--- a/Documentation/technical/bitmap-format.txt
+++ b/Documentation/technical/bitmap-format.txt
@@ -39,7 +39,7 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
== On-disk format
- - A header appears at the beginning:
+ * A header appears at the beginning:
4-byte signature: {'B', 'I', 'T', 'M'}
@@ -48,9 +48,7 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
of the bitmap index (the same one as JGit).
2-byte flags (network byte order)
-
The following flags are supported:
-
- BITMAP_OPT_FULL_DAG (0x1) REQUIRED
This flag must always be present. It implies that the
bitmap index has been generated for a packfile or
@@ -60,7 +58,6 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
requirement for the bitmap index format, also present in
JGit, that greatly reduces the complexity of the
implementation.
-
- BITMAP_OPT_HASH_CACHE (0x4)
If present, the end of the bitmap file contains
`N` 32-bit name-hash values, one per object in the
@@ -68,15 +65,13 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
described below.
4-byte entry count (network byte order)
-
The total count of entries (bitmapped commits) in this bitmap index.
20-byte checksum
-
The SHA1 checksum of the pack/MIDX this bitmap index
belongs to.
- - 4 EWAH bitmaps that act as type indexes
+ * 4 EWAH bitmaps that act as type indexes
Type indexes are serialized after the hash cache in the shape
of four EWAH bitmaps stored consecutively (see Appendix A for
@@ -84,7 +79,6 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
There is a bitmap for each Git object type, stored in the following
order:
-
- Commits
- Trees
- Blobs
@@ -97,17 +91,17 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
in a full set (all bits set), and the AND of all 4 bitmaps will
result in an empty bitmap (no bits set).
- - N entries with compressed bitmaps, one for each indexed commit
+ * N entries with compressed bitmaps, one for each indexed commit
Where `N` is the total amount of entries in this bitmap index.
Each entry contains the following:
- - 4-byte object position (network byte order)
+ ** 4-byte object position (network byte order)
The position **in the index for the packfile or
multi-pack index** where the bitmap for this commit is
found.
- - 1-byte XOR-offset
+ ** 1-byte XOR-offset
The xor offset used to compress this bitmap. For an entry
in position `x`, a XOR offset of `y` means that the actual
bitmap representing this commit is composed by XORing the
@@ -124,12 +118,12 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
with **previous** bitmaps, not bitmaps that will come afterwards
in the index.
- - 1-byte flags for this bitmap
+ ** 1-byte flags for this bitmap
At the moment the only available flag is `0x1`, which hints
that this bitmap can be re-used when rebuilding bitmap indexes
for the repository.
- - The compressed bitmap itself, see Appendix A.
+ ** The compressed bitmap itself, see Appendix A.
== Appendix A: Serialization format for an EWAH bitmap
--
gitgitgadget
next prev parent reply other threads:[~2022-06-07 18:03 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-02 13:52 [PATCH 0/2] bitmap-format.txt: fix some formatting issues and include checksum info Abhradeep Chakraborty via GitGitGadget
2022-06-02 13:52 ` [PATCH 1/2] bitmap-format.txt: fix some formatting issues Abhradeep Chakraborty via GitGitGadget
2022-06-06 15:55 ` Junio C Hamano
2022-06-07 10:25 ` Abhradeep Chakraborty
2022-06-02 13:52 ` [PATCH 2/2] bitmap-format.txt: add information for trailing checksum Abhradeep Chakraborty via GitGitGadget
2022-06-07 17:43 ` [PATCH v2 0/3] bitmap-format.txt: fix some formatting issues and include checksum info Abhradeep Chakraborty via GitGitGadget
2022-06-07 17:43 ` [PATCH v2 1/3] bitmap-format.txt: feed the file to asciidoc to generate html Abhradeep Chakraborty via GitGitGadget
2022-06-07 18:39 ` Junio C Hamano
2022-06-08 15:02 ` Abhradeep Chakraborty
2022-06-07 20:21 ` Taylor Blau
2022-06-07 17:43 ` Abhradeep Chakraborty via GitGitGadget [this message]
2022-06-07 20:51 ` [PATCH v2 2/3] bitmap-format.txt: fix some formatting issues Taylor Blau
2022-06-07 22:02 ` Junio C Hamano
2022-06-08 16:06 ` Abhradeep Chakraborty
2022-06-08 15:40 ` Abhradeep Chakraborty
2022-06-07 17:43 ` [PATCH v2 3/3] bitmap-format.txt: add information for trailing checksum Abhradeep Chakraborty via GitGitGadget
2022-06-07 20:56 ` Taylor Blau
2022-06-08 16:15 ` Abhradeep Chakraborty
2022-06-07 18:28 ` [PATCH v2 0/3] bitmap-format.txt: fix some formatting issues and include checksum info Junio C Hamano
2022-06-07 20:58 ` Taylor Blau
2022-06-07 21:00 ` Junio C Hamano
2022-06-08 17:12 ` Abhradeep Chakraborty
2022-06-10 10:54 ` [PATCH v3 " Abhradeep Chakraborty via GitGitGadget
2022-06-10 10:54 ` [PATCH v3 1/3] bitmap-format.txt: feed the file to asciidoc to generate html Abhradeep Chakraborty via GitGitGadget
2022-06-10 10:54 ` [PATCH v3 2/3] bitmap-format.txt: fix some formatting issues Abhradeep Chakraborty via GitGitGadget
2022-06-15 2:27 ` Taylor Blau
2022-06-15 14:28 ` Abhradeep Chakraborty
2022-06-10 10:54 ` [PATCH v3 3/3] bitmap-format.txt: add information for trailing checksum Abhradeep Chakraborty via GitGitGadget
2022-06-10 17:01 ` [PATCH v3 0/3] bitmap-format.txt: fix some formatting issues and include checksum info Junio C Hamano
2022-06-15 2:28 ` Taylor Blau
2022-06-15 22:41 ` Junio C Hamano
2022-06-16 5:03 ` [PATCH v4 " Abhradeep Chakraborty via GitGitGadget
2022-06-16 5:03 ` [PATCH v4 1/3] bitmap-format.txt: feed the file to asciidoc to generate html Abhradeep Chakraborty via GitGitGadget
2022-06-16 5:03 ` [PATCH v4 2/3] bitmap-format.txt: fix some formatting issues Abhradeep Chakraborty via GitGitGadget
2022-06-16 5:03 ` [PATCH v4 3/3] bitmap-format.txt: add information for trailing checksum Abhradeep Chakraborty via GitGitGadget
2022-06-16 18:53 ` [PATCH v4 0/3] bitmap-format.txt: fix some formatting issues and include checksum info Junio C Hamano
2022-06-16 21:18 ` Taylor Blau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cb919513c14d426b51051ee5c16badec37538032.1654623814.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=chakrabortyabhradeep79@gmail.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=kaartic.sivaraam@gmail.com \
--cc=me@ttaylorr.com \
--cc=tanoku@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.