RE: [PATCH] docs: generate manpage from README and HOWTO

[Vincent Fu <vincent.fu@samsung.com>]

> -----Original Message-----
> From: Vincent Fu
> Sent: Wednesday, March 2, 2022 10:22 AM
> To: fio@vger.kernel.org; axboe@kernel.dk; martin.steigerwald@proact.de;
> sandeen@redhat.com
> Cc: Vincent Fu <vincent.fu@samsung.com>
> Subject: [PATCH] docs: generate manpage from README and HOWTO
> 
> We have a longstanding problem where fio documentation updates must be
> made to both the HOWTO and manpage.
> 
> Here is a solution that generates a manpage from the README and HOWTO
> using Sphinx.
> 
> The downside to being able to maintain only one version of the
> documentation is that this will cause a bit of trouble for those who package
> fio and users building fio without Sphinx support will no longer have a
> manpage.
> 
> Does this seem like a reasonable tradeoff? If so, I will follow up with patches
> to remove the original manpage and update the Sphinx-generated manpage
> to have the standard NAME, SYNOPSIS, DESCRIPTION, etc layout.
> 

Oops, this was intended to be a RFC.