Re: [PATCH v2 1/3] bitmap-format.txt: feed the file to asciidoc to generate html

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 7, 2022, 18:39 UTC
Message-ID: <xmqqa6aowc6r.fsf@gitster.g>
In-Reply-To: <a1b9bd9af90df88b7ce14de60a9626d2a1f2d3e8.1654623814.git.gitgitgadget@gmail.com>

"Abhradeep Chakraborty via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 12 quoted lines

> From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
>
> Documentation/Makefile does not include bitmap-format.txt to generate
> a html page using asciidoc.
>
> Teach Documentation/Makefile to also generate a html page for
> Documentation/technical/bitmap-format.txt file.
>
> Signed-off-by: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
> ---
>  Documentation/Makefile | 1 +
>  1 file changed, 1 insertion(+)

The change itself is obviously correct (assuming that it is worth passing the document to AsciiDoc, instead of reading it in text, that is).

Show 12 quoted lines

> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index d3f043f50d2..8d405a14330 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -94,6 +94,7 @@ TECH_DOCS += MyFirstContribution
>  TECH_DOCS += MyFirstObjectWalk
>  TECH_DOCS += SubmittingPatches
>  TECH_DOCS += ToolsForGit
> +TECH_DOCS += technical/bitmap-format
>  TECH_DOCS += technical/bundle-format
>  TECH_DOCS += technical/hash-function-transition
>  TECH_DOCS += technical/http-protocol

Is bitmap-format the only one that is not fed to AsciiDoc, by the way? Are there other 'text-only' document that is worth converting to AsciiDoc?

It is outside the scope of this series, of course, to actually adjusting them, but since you are already doing the homework, I thought you might already know the answer, which may become a source of inspriation for others to find something to work on.

Thanks.