Re: [PATCH v2 0/3] bitmap-format.txt: fix some formatting issues and include checksum info

From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
Date: Jun 8, 2022, 17:12 UTC
Message-ID: <20220608171257.10455-1-chakrabortyabhradeep79@gmail.com>
In-Reply-To: <xmqqo7z4ur2i.fsf@gitster.g>

Junio C Hamano <gitster@pobox.com> wrote:

Show 8 quoted lines

> No, this is not quite ready for production.
>
> Almost all the "indented" material are shown in fixed-width
> typewriter format in the resulting HTML output.
>
> Look how ugly the output from it is.  Not your fault; it is mostly
> because when the original text was written, it was not even meant to
> be given to AsciiDoc.

Actually, I am wondering how git-scm.com is able to produce a html page for bitmap-format.txt (if it is not passing to asciidoc). The design of asciidoc generated html pages in `make docs` are not same as the design of production html page designs. Probably, production uses some extra css code to beautify the asciidoc generated html files.

So, the generated html file (production version) is not as bad as the locally built generated html. I need some understanding of the working of git-scm though (to verify it).

If you see other locally built html pages - they would look similar to the bitmap-format html page. But in production, they are beautiful enough.

By the way, I forgot to inform that https://git-scm.com/docs/pack-format#_original_version_1_pack_idx_files_have_the_following_format also has some weird formatting issues. See the <pre> block after the pack-idx structure drawing. There are other issues also which you can find (like having unnecessary indentations e.g. here[1] the second block under the "The header is followed by number of object entries....").

Thanks :)

[1] https://git-scm.com/docs/pack-format#_pack_pack_files_have_the_following_format