Pandoc do a passable job of generating man pages out of Markdown, but pandoc itself is a horrible build dependency for the mundane task of generating man pages. We've avoided this build dependency by shipping rendered man-pages in our source releases. That was not such a big deal in the autotools ecosystem where source releases are *built*, but that's really an oxymoron. We want to move to a model where our source releases are really nothing more than what git-archive outputs, and something that anybody can verify anywhere at all.
To preserve man page availability, switch over to a tool that we can trivially add as a hard build requirement. scdoc is a trivially buildable piece of < 1000 lines of C code and depends on nothing that rpm doesn't otherwise depend. Being a specialized tool for man pages, I think it also does a better job at it than pandoc. This is quite a chainsaw change, the main purpose is just to make our man pages buildable with scdoc. Making it pretty and unifying all the wildly different styles is a job for another day. Fixes: #3563 You can view, comment on, or merge this pull request online at: https://github.com/rpm-software-management/rpm/pull/3591 -- Commit Summary -- * Convert man pages to specialist tooling: scdoc -- File Changes -- M INSTALL (3) M docs/README.md (3) M docs/man/CMakeLists.txt (18) M docs/man/gendiff.1.md (36) M docs/man/rpm-misc.8.md (87) M docs/man/rpm-plugin-audit.8.md (85) M docs/man/rpm-plugin-dbus-announce.8.md (27) M docs/man/rpm-plugin-fapolicyd.8.md (22) M docs/man/rpm-plugin-ima.8.md (26) M docs/man/rpm-plugin-prioreset.8.md (26) M docs/man/rpm-plugin-selinux.8.md (28) M docs/man/rpm-plugin-syslog.8.md (24) M docs/man/rpm-plugin-systemd-inhibit.8.md (30) M docs/man/rpm-plugin-unshare.8.md (44) M docs/man/rpm-plugins.8.md (36) M docs/man/rpm.8.md (1163) M docs/man/rpm2archive.8.md (63) M docs/man/rpm2cpio.8.md (38) M docs/man/rpmbuild.8.md (373) M docs/man/rpmdb.8.md (51) M docs/man/rpmdeps.8.md (65) M docs/man/rpmgraph.8.md (40) M docs/man/rpmkeys.8.md (64) M docs/man/rpmlua.8.md (57) M docs/man/rpmsign.8.md (206) M docs/man/rpmsort.8.md (35) M docs/man/rpmspec.8.md (176) -- Patch Links -- https://github.com/rpm-software-management/rpm/pull/3591.patch https://github.com/rpm-software-management/rpm/pull/3591.diff -- Reply to this email directly or view it on GitHub: https://github.com/rpm-software-management/rpm/pull/3591 You are receiving this because you are subscribed to this thread. Message ID: <rpm-software-management/rpm/pull/3...@github.com>
_______________________________________________ Rpm-maint mailing list Rpm-maint@lists.rpm.org https://lists.rpm.org/mailman/listinfo/rpm-maint
