Skip to content

Commit ad506e6

Browse files
dyronegitster
authored andcommitted
midx: fix a formatting issue in "multi-pack-index.txt"
There is a formatting issue in "multi-pack-index.html", corresponding to the nesting bulleted list of a wrong usage in "multi-pack-index.txt" and this commit fix the problem. In ASCIIDOC, it doesn't treat an indented character as the beginning of a sub-list. If we want to write a nested bulleted list, we could just use ASTERISK without any DASH like: " * Level 1 list item ** Level 2 list item *** Level 3 list item ** Level 2 list item * Level 1 list item ** Level 2 list item * Level 1 list item " The DASH can be used for bulleted list too, But the DASH is suggested only to be used as the marker for the first level because the DASH doesn’t work well or a best practice for nested lists, like (dash is as level 2 below): " * Level 1 list item - Level 2 list item * Level 1 list item " ASTERISK is recommanded to use because it works intuitively and clearly ("marker length = nesting level") in nested lists, but the DASH can't. However, when you want to write a non-nested bulleted lists, DASH works too, like: " - Level 1 list item - Level 1 list item - Level 1 list item " Reviewed-by: Taylor Blau <[email protected]> Reviewed-by: Derrick Stolee <[email protected]> Signed-off-by: Teng Long <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 94f6e3e commit ad506e6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/technical/multi-pack-index.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ is not feasible due to storage space or excessive repack times.
1717
The multi-pack-index (MIDX for short) stores a list of objects
1818
and their offsets into multiple packfiles. It contains:
1919

20-
- A list of packfile names.
21-
- A sorted list of object IDs.
22-
- A list of metadata for the ith object ID including:
23-
- A value j referring to the jth packfile.
24-
- An offset within the jth packfile for the object.
25-
- If large offsets are required, we use another list of large
20+
* A list of packfile names.
21+
* A sorted list of object IDs.
22+
* A list of metadata for the ith object ID including:
23+
** A value j referring to the jth packfile.
24+
** An offset within the jth packfile for the object.
25+
* If large offsets are required, we use another list of large
2626
offsets similar to version 2 pack-indexes.
2727

2828
Thus, we can provide O(log N) lookup time for any number

0 commit comments

Comments
 (0)