Re: [PATCH v6 1/4] Documentation: fpga: dfl: Add documentation for DFHv1

From: matthew . gerlach
Date: Tue Dec 13 2022 - 15:41:08 EST




On Tue, 13 Dec 2022, Andy Shevchenko wrote:

On Tue, Dec 13, 2022 at 08:50:25AM -0800, matthew.gerlach@xxxxxxxxxxxxxxx wrote:
On Sat, 10 Dec 2022, Bagas Sanjaya wrote:
On Fri, Dec 09, 2022 at 01:45:20PM -0800, matthew.gerlach@xxxxxxxxxxxxxxx wrote:

...

Open discussion
===============
FME driver exports one ioctl (DFL_FPGA_FME_PORT_PR) for partial reconfiguration

What about this wording below (including fitting the prose within 80 columns)?

The wording you suggest is an improvement. I will include your suggestions.
I mistakenly thought that Restructured Text needed list items to be a single
line and checkpatch.pl did not flag the long lines.

I usually test the output with rst2pdf. You can also try kernel doc script to
produce man and HTML and see how they are rendered.

I have been using 'make htmldocs' and viewing the output. I will checkout rst2pdf as well.

Thanks for the feedback,
Matthew Gerlach


--
With Best Regards,
Andy Shevchenko