From: Taylor Blau <me@ttaylorr.com>
Date: Wed, 15 Jun 2022 02:28:42 GMT
Subject: Re: [PATCH v3 0/3] bitmap-format.txt: fix some formatting issues and include checksum info
Message-ID: <YqlD2qtwqmIKG9lo@nand.local>
In-Reply-To: <xmqq8rq4fo6p.fsf@gitster.g>

On Fri, Jun 10, 2022 at 10:01:02AM -0700, Junio C Hamano wrote:
> "Abhradeep Chakraborty via GitGitGadget" <gitgitgadget@gmail.com>
> writes:
>
> > There are some issues in the bitmap-format html page. For example, some
> > nested lists are shown as top-level lists (e.g. [1]- Here
> > BITMAP_OPT_FULL_DAG (0x1) and BITMAP_OPT_HASH_CACHE (0x4) are shown as
> > top-level list). There is also a need of adding info about trailing checksum
> > in the docs.
>
> Quite honestly, I am not sure if a piecemeal "let's make
> <pre>...</pre> a bit prettier" is worth our time.  Especially
> relative to the importance of adding missing information to the
> documentation.
>
> So, if this round (I haven't looked at the formatting changes at all
> yet) turns out to be still not doing the HTML properly, I'd suggest
> shuffling the patches around, add missing information so that readers
> can get the corrections in text regardless of the rest of HTMLify
> effort.  We'll see.

This version of the series significantly improves the readability of the
generated HTML, and I only had a minor comment or two.

So I think that the improvement is worthwhile, though if others disagree
strongly, the third patch should get picked up regardless, since it
addresses a legitimate gap in our documentation.

Thanks,
Taylor