]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Doc: fix Asciidoctor css workaround
authorJunio C Hamano <gitster@pobox.com>
Mon, 22 Jul 2024 21:17:55 +0000 (14:17 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 23 Jul 2024 18:02:52 +0000 (11:02 -0700)
The previous step introduced docinfo.html to be used to tweak the
CSS used by the asciidoctor, that by default renders <code> inside
<pre> as a block element, breaking the SYNOPSIS section of a few
pages that adopted a new convention we use since Git 2.45.

But in this project, HTML files are all generated.  We do not force
any human to write HTML by hand, which is an unusual and cruel
punishment.  "*.html" is in the .gitignore file, and "make clean"
removes them.  Having a tracked .html file makes "make clean" make
the tree dirty by removing the tracked docinfo.html file.

Let's do an obvious, minimum and stupid workaround to generate that
file at runtime instead.  The mark-up is being rethought in a major
way for the next development cycle, and the CSS workaround we added
in the previous step may have to adjusted, possibly in a large way,
anyway.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/.gitignore
Documentation/Makefile
Documentation/docinfo-html.in [moved from Documentation/docinfo.html with 100% similarity]

index d11567fbbe71352e1385bb3af88bcee29808d60c..a48448de32f98b1a054b36e886ea920bccebc494 100644 (file)
@@ -1,6 +1,5 @@
 *.xml
 *.html
-!/docinfo.html
 *.[1-8]
 *.made
 *.texi
index 78e407e4bd1608eb4d48e854af112ddc6bff8752..371d56eb5eb261a75c49e71ddae44b1a6aaf3fa4 100644 (file)
@@ -209,6 +209,8 @@ XMLTO_EXTRA += --skip-validation
 XMLTO_EXTRA += -x manpage.xsl
 endif
 
+ASCIIDOC_DEPS += docinfo.html
+
 SHELL_PATH ?= $(SHELL)
 # Shell quote;
 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
@@ -337,6 +339,9 @@ clean:
        $(RM) $(cmds_txt) $(mergetools_txt) *.made
        $(RM) GIT-ASCIIDOCFLAGS
 
+docinfo.html: docinfo-html.in
+       $(QUIET_GEN)$(RM) $@ && cat $< >$@
+
 $(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS)
        $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -d manpage -o $@ $<