| Message ID | 9b910a44f4143c94787110a688f2b17ba4eeb0fc.1637218943.git.dyroneteng@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | ad506e6780daf7e54571c1a647814c5a10682a77 |
| Headers | show |
| Series | midx: fix a formatting issue in docs | expand |
On 11/18/2021 2:11 AM, Teng Long wrote: > 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. Thank you for the detailed message! > -- A list of packfile names. > -- A sorted list of object IDs. > -- A list of metadata for the ith object ID including: > - - A value j referring to the jth packfile. > - - An offset within the jth packfile for the object. > -- If large offsets are required, we use another list of large > +* A list of packfile names. > +* A sorted list of object IDs. > +* A list of metadata for the ith object ID including: > +** A value j referring to the jth packfile. > +** An offset within the jth packfile for the object. > +* If large offsets are required, we use another list of large > offsets similar to version 2 pack-indexes. LGTM! Thanks, -Stolee
Teng Long <dyroneteng@gmail.com> writes: > 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. Thanks, will apply.
diff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt index fb688976c4..642e2517f3 100644 --- a/Documentation/technical/multi-pack-index.txt +++ b/Documentation/technical/multi-pack-index.txt @@ -17,12 +17,12 @@ is not feasible due to storage space or excessive repack times. The multi-pack-index (MIDX for short) stores a list of objects and their offsets into multiple packfiles. It contains: -- A list of packfile names. -- A sorted list of object IDs. -- A list of metadata for the ith object ID including: - - A value j referring to the jth packfile. - - An offset within the jth packfile for the object. -- If large offsets are required, we use another list of large +* A list of packfile names. +* A sorted list of object IDs. +* A list of metadata for the ith object ID including: +** A value j referring to the jth packfile. +** An offset within the jth packfile for the object. +* If large offsets are required, we use another list of large offsets similar to version 2 pack-indexes. Thus, we can provide O(log N) lookup time for any number
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 <me@ttaylorr.com> Reviewed-by: Derrick Stolee <stolee@gmail.com> Signed-off-by: Teng Long <dyroneteng@gmail.com> --- Documentation/technical/multi-pack-index.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)