Skip to content

Commit f6611df

Browse files
Abhra303gitster
authored andcommitted
bitmap-format.txt: fix some formatting issues
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e14d1df commit f6611df

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

Documentation/technical/bitmap-format.txt

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
3939

4040
== On-disk format
4141

42-
- A header appears at the beginning:
42+
* A header appears at the beginning:
4343

4444
4-byte signature: {'B', 'I', 'T', 'M'}
4545

@@ -48,9 +48,7 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
4848
of the bitmap index (the same one as JGit).
4949

5050
2-byte flags (network byte order)
51-
5251
The following flags are supported:
53-
5452
- BITMAP_OPT_FULL_DAG (0x1) REQUIRED
5553
This flag must always be present. It implies that the
5654
bitmap index has been generated for a packfile or
@@ -60,31 +58,27 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
6058
requirement for the bitmap index format, also present in
6159
JGit, that greatly reduces the complexity of the
6260
implementation.
63-
6461
- BITMAP_OPT_HASH_CACHE (0x4)
6562
If present, the end of the bitmap file contains
6663
`N` 32-bit name-hash values, one per object in the
6764
pack/MIDX. The format and meaning of the name-hash is
6865
described below.
6966

7067
4-byte entry count (network byte order)
71-
7268
The total count of entries (bitmapped commits) in this bitmap index.
7369

7470
20-byte checksum
75-
7671
The SHA1 checksum of the pack/MIDX this bitmap index
7772
belongs to.
7873

79-
- 4 EWAH bitmaps that act as type indexes
74+
* 4 EWAH bitmaps that act as type indexes
8075

8176
Type indexes are serialized after the hash cache in the shape
8277
of four EWAH bitmaps stored consecutively (see Appendix A for
8378
the serialization format of an EWAH bitmap).
8479

8580
There is a bitmap for each Git object type, stored in the following
8681
order:
87-
8882
- Commits
8983
- Trees
9084
- Blobs
@@ -97,17 +91,17 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
9791
in a full set (all bits set), and the AND of all 4 bitmaps will
9892
result in an empty bitmap (no bits set).
9993

100-
- N entries with compressed bitmaps, one for each indexed commit
94+
* N entries with compressed bitmaps, one for each indexed commit
10195

10296
Where `N` is the total amount of entries in this bitmap index.
10397
Each entry contains the following:
10498

105-
- 4-byte object position (network byte order)
99+
** 4-byte object position (network byte order)
106100
The position **in the index for the packfile or
107101
multi-pack index** where the bitmap for this commit is
108102
found.
109103

110-
- 1-byte XOR-offset
104+
** 1-byte XOR-offset
111105
The xor offset used to compress this bitmap. For an entry
112106
in position `x`, a XOR offset of `y` means that the actual
113107
bitmap representing this commit is composed by XORing the
@@ -124,12 +118,12 @@ MIDXs, both the bit-cache and rev-cache extensions are required.
124118
with **previous** bitmaps, not bitmaps that will come afterwards
125119
in the index.
126120

127-
- 1-byte flags for this bitmap
121+
** 1-byte flags for this bitmap
128122
At the moment the only available flag is `0x1`, which hints
129123
that this bitmap can be re-used when rebuilding bitmap indexes
130124
for the repository.
131125

132-
- The compressed bitmap itself, see Appendix A.
126+
** The compressed bitmap itself, see Appendix A.
133127

134128
== Appendix A: Serialization format for an EWAH bitmap
135129

0 commit comments

Comments
 (0)