mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
On several distributions `pandoc` is not available via the default repositories, and thus not available in the build environments for the distribution packages. That means, the man page can't be bundled along with the packages generated for those distributions. But since this is a valuable asset for some users, instead of requiring `pandoc` in order to have a man page be generated during the build, so it can be installed, bundle a pre-cooked version that corresponds to the current version of the `README.md` file. This way, the man page can always be packaged, and is now always installed, even if `ENABLE_DOC` is set to `0` (the default). This also means, whenever the `README.md` file is changed, the bundled man page needs to be regenerated, so it stays in sync. As a safeguard we also add a checksum of the `README.md` file that is regenerated along with the man page. This checksum is tested even when `pandoc` is not available, and the user is notified whenever it runs out of sync (with a hint as to how to remedy it). Nothing changes for the compile/installation workflow, if `ENABLE_DOC` is set to `1`. Suggested-by: Jens Remus <jremus@linux.ibm.com> Reviewed-by: Steffen Maier <maier@linux.ibm.com> Signed-off-by: Benjamin Block <bblock@linux.ibm.com> Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
2 lines
76 B
Plaintext
2 lines
76 B
Plaintext
8e604dab39577678bc9f24bfe5e2ee35354b2f4b1759edd16093157b1ecce9d3 README.md
|