Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: build manpage from fio_doc.rst instead of fio_man.rst
Sphinx prints warnings when it encounters duplicate labels. In HOWTO.rst are labels for int, irange, and bool. We include HOWTO.rst in both fio_doc.rst and fio_man.rst. Since labels must be unique across all files, Sphinx prints warnings for these labels. For an unknown reason, Sphinx previously did not issue warnings for the duplicate labels mentioned above until 5.2.0. But Sphinx 5.2.1 is now installed for the macOS 11 image in GitHub Actions. So now we see Sphinx warnings when building documentation in GitHub Actions. Our CI treats Sphinx warnings as test failures. So our macOS builds are marked as failures. Resolve this problem by eliminating the separate fio_man.rst file and just building the manpage from the largely equivalent fio_doc.rst. Successful build with 5.1.1: https://github.com/axboe/fio/actions/runs/3106980788/jobs/5034529793 Failed build with 5.2.1: https://github.com/axboe/fio/actions/runs/3129974184/jobs/5079696775 Link: sphinx-doc/sphinx#10781 Link: sphinx-doc/sphinx#10870 Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
- Loading branch information