Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 13 Dec 2022 12:41:13 -0800 (PST)
From:   matthew.gerlach@linux.intel.com
To:     Andy Shevchenko <andriy.shevchenko@linux.intel.com>
cc:     Bagas Sanjaya <bagasdotme@gmail.com>, hao.wu@intel.com,
        yilun.xu@intel.com, russell.h.weight@intel.com,
        basheer.ahmed.muddebihal@intel.com, trix@redhat.com,
        mdf@kernel.org, linux-fpga@vger.kernel.org,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        tianfei.zhang@intel.com, corbet@lwn.net,
        gregkh@linuxfoundation.org, linux-serial@vger.kernel.org,
        jirislaby@kernel.org, geert+renesas@glider.be,
        niklas.soderlund+renesas@ragnatech.se, macro@orcam.me.uk,
        johan@kernel.org, lukas@wunner.de, ilpo.jarvinen@linux.intel.com,
        marpagan@redhat.com
Subject: Re: [PATCH v6 1/4] Documentation: fpga: dfl: Add documentation for
 DFHv1
In-Reply-To: <Y5jX/eXrFdAO7xml@smile.fi.intel.com>
Message-ID: <alpine.DEB.2.22.394.2212131239410.3747445@rhweight-WRK1>
References: <20221209214523.3484193-1-matthew.gerlach@linux.intel.com> <20221209214523.3484193-2-matthew.gerlach@linux.intel.com> <Y5P6NjDxy/S7nlF7@debian.me> <alpine.DEB.2.22.394.2212130844330.3732069@rhweight-WRK1> <Y5jX/eXrFdAO7xml@smile.fi.intel.com>
User-Agent: Alpine 2.22 (DEB 394 2020-01-19)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII; format=flowed
Precedence: bulk


On Tue, 13 Dec 2022, Andy Shevchenko wrote:

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