> -----Original Message----- > From: fio-owner@xxxxxxxxxxxxxxx [mailto:fio-owner@xxxxxxxxxxxxxxx] On > Behalf Of Kris Davis > Sent: Thursday, March 15, 2018 3:38 PM > Subject: RE: Patch to add read and write fua bit options to the SG engine > > A question - how is the man page expected to be handled (manually > updated)? I saw that running "make -C doc man" would generate a man page, > which included changes from the HOWTO. However, even if I build that > doc/output/man/fio.1 file from a master level image, it does to appear to > equal what is in "fio.1" at the root directory. I've never manually > written a man page before, so I might guess that it depends on the tool > images on whatever machine is used to build the man page. > > Anyway - what's the right way to handle the man pages > -- manually edit and include in patch? > -- build via make, copy to the root dir, and then include in patch? > -- something else? fio.1 is the "source code." Manually edit it and handcode the ancient troff formatting. Patch f80dba8d2fc3052a added automatic generation of an fio.1 from README and HOWTO, but I don't think anyone uses that output. It requires more packages to be present (something called sphinx and who knows what else). There have been over 70 direct patches to fio.1 since then, ignoring that auto-generated version. HOWTO and the manpage are always falling out of sync, so it'd be nice if we only had one authoritative source file. --- Robert Elliott, HPE Persistent Memory ��.n��������+%������w��{.n�������^n�r������&��z�ޗ�zf���h���~����������_��+v���)ߣ�
