doc: build manpage from fio_doc.rst instead of fio_man.rst
authorVincent Fu <vincent.fu@samsung.com>
Tue, 27 Sep 2022 14:43:49 +0000 (07:43 -0700)
committerVincent Fu <vincent.fu@samsung.com>
Tue, 27 Sep 2022 15:58:25 +0000 (11:58 -0400)
commit6112c0f5a86c6b437e7158ab40a6e9384ce95e85
treeabd0e36c0acd8543311b7e1a73d8ac00ee7541db
parent0574e8c3b2b47e1e2564c2f50ea0b6f2629f2e48
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: https://github.com/sphinx-doc/sphinx/pull/10781
Link: https://github.com/sphinx-doc/sphinx/issues/10870
Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
doc/conf.py
doc/fio_doc.rst
doc/fio_man.rst [deleted file]