]> git.ipfire.org Git - thirdparty/git.git/commit
meson: generate user manual
authorPatrick Steinhardt <ps@pks.im>
Fri, 27 Dec 2024 13:59:34 +0000 (14:59 +0100)
committerJunio C Hamano <gitster@pobox.com>
Fri, 27 Dec 2024 16:28:10 +0000 (08:28 -0800)
commitae0b33939d233fa340f1ebb768588dc46a128e4c
tree39890618ab300e7fcbeca32b49722047798eef39
parent851ecc4290cbdb57f36f10b77da9c1ae13c10469
meson: generate user manual

Our documentation contains a user manual that gives people a short
introduction to Git. Our Makefile knows to generate the manual into
three different formats: an HTML page, a PDF and an info page. The Meson
build instructions don't yet generate any of these.

While wiring up all these formats I hit a couple of road blocks with how
we generate our info pages. Even though I eventually resolved these, it
made me question whether anybody actually uses info pages in the first
place. Checking through a couple of downstream consumers I couldn't find
a single user of either the info pages nor of our PDF manual in Arch
Linux, Debian, Fedora, Ubuntu, FreeBSD or OpenBSDFedora. So it's rather
safe to assume that there aren't really any users out there, and thus
the added complexity does not seem worth it.

Wire up support for building the user manual in HTML format and
conciously skip over the other two formats. This is basically a form of
silent deprecation: if people out there use the other two formats they
will eventually complain about them missing in Meson, which means we can
wire them up at a later point. If they don't we can phase out these
formats eventually.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/meson.build