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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Tue, 13 Dec 2022 12:41:13 -0800 (PST)
From:   matthew.gerlach@...ux.intel.com
To:     Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
cc:     Bagas Sanjaya <bagasdotme@...il.com>, hao.wu@...el.com,
        yilun.xu@...el.com, russell.h.weight@...el.com,
        basheer.ahmed.muddebihal@...el.com, trix@...hat.com,
        mdf@...nel.org, linux-fpga@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        tianfei.zhang@...el.com, corbet@....net,
        gregkh@...uxfoundation.org, linux-serial@...r.kernel.org,
        jirislaby@...nel.org, geert+renesas@...der.be,
        niklas.soderlund+renesas@...natech.se, macro@...am.me.uk,
        johan@...nel.org, lukas@...ner.de, ilpo.jarvinen@...ux.intel.com,
        marpagan@...hat.com
Subject: Re: [PATCH v6 1/4] Documentation: fpga: dfl: Add documentation for
 DFHv1



On Tue, 13 Dec 2022, Andy Shevchenko wrote:

> On Tue, Dec 13, 2022 at 08:50:25AM -0800, matthew.gerlach@...ux.intel.com wrote:
>> On Sat, 10 Dec 2022, Bagas Sanjaya wrote:
>>> On Fri, Dec 09, 2022 at 01:45:20PM -0800, matthew.gerlach@...ux.intel.com 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
>
>
>