giteveryday: unbreak rendering with AsciiDoctor
commit9574901c02d5f216efe20a9995c2f2056360f9f1
authorJohannes Schindelin <johannes.schindelin@gmx.de>
Mon, 2 Jan 2017 16:04:05 +0000 (2 17:04 +0100)
committerJunio C Hamano <gitster@pobox.com>
Sat, 7 Jan 2017 22:03:40 +0000 (7 14:03 -0800)
tree56fa4e90fc86202c437606a05c8e9c01bf937498
parente05806da9ec4aff8adfed142ab2a2b3b02e33c8c
giteveryday: unbreak rendering with AsciiDoctor

The "giteveryday" document has a callout list that contains a code
block. This is not a problem for AsciiDoc, but AsciiDoctor sadly was
explicitly designed *not* to render this correctly [*1*]. The symptom is
an unhelpful

line 322: callout list item index: expected 1 got 12
line 325: no callouts refer to list item 1
line 325: callout list item index: expected 2 got 13
line 327: no callouts refer to list item 2

In Git for Windows, we rely on the speed improvement of AsciiDoctor (on
this developer's machine, `make -j15 html` takes roughly 30 seconds with
AsciiDoctor, 70 seconds with AsciiDoc), therefore we need a way to
render this correctly.

The easiest way out is to simplify the callout list, as suggested by
AsciiDoctor's author, even while one may very well disagree with him
that a code block hath no place in a callout list.

*1*: https://github.com/asciidoctor/asciidoctor/issues/1478

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/giteveryday.txt