Skip to content

Commit

Permalink
doc: build manpage from fio_doc.rst instead of fio_man.rst
Browse files Browse the repository at this point in the history
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
vincentkfu committed Sep 27, 2022
1 parent 0574e8c commit 6112c0f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 34 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Expand Up @@ -318,7 +318,7 @@ def fio_version():
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('fio_man', 'fio', 'flexible I/O tester',
('fio_doc', 'fio', 'flexible I/O tester',
[author], 1)
]

Expand Down
42 changes: 21 additions & 21 deletions doc/fio_doc.rst
Expand Up @@ -7,45 +7,45 @@ fio - Flexible I/O tester rev. |version|

.. include:: ../HOWTO.rst

.. only:: not man

Examples
========

Examples
========
.. include:: fio_examples.rst

.. include:: fio_examples.rst


TODO
====

TODO
====

GFIO TODO
---------

GFIO TODO
---------
.. include:: ../GFIO-TODO

.. include:: ../GFIO-TODO

Server TODO
-----------

Server TODO
-----------
.. include:: ../SERVER-TODO

.. include:: ../SERVER-TODO

Steady State TODO
-----------------

Steady State TODO
-----------------
.. include:: ../STEADYSTATE-TODO

.. include:: ../STEADYSTATE-TODO


Moral License
=============

Moral License
=============
.. include:: ../MORAL-LICENSE

.. include:: ../MORAL-LICENSE

License
=======

License
=======

.. literalinclude:: ../COPYING
.. literalinclude:: ../COPYING
12 changes: 0 additions & 12 deletions doc/fio_man.rst

This file was deleted.

0 comments on commit 6112c0f

Please sign in to comment.