]> git.ipfire.org Git - thirdparty/git.git/commit
midx: fix a formatting issue in "multi-pack-index.txt"
authorTeng Long <dyroneteng@gmail.com>
Thu, 18 Nov 2021 07:11:14 +0000 (15:11 +0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 18 Nov 2021 19:31:07 +0000 (11:31 -0800)
commitad506e6780daf7e54571c1a647814c5a10682a77
treec09201325e27186ecfc970f925e6bb76a31c66e4
parent94f6e3e283f2adfc518b39cfc39291f1c2832ad0
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 <me@ttaylorr.com>
Reviewed-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Teng Long <dyroneteng@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/multi-pack-index.txt