Re: [PATCH 0/3 v2] PM / docs: linux/pm.h kerneldocs update and conversion of two docs to reST
From: Rafael J. Wysocki
Date: Mon Feb 06 2017 - 16:08:51 EST
On Mon, Feb 6, 2017 at 7:28 PM, Jonathan Corbet <corbet@xxxxxxx> wrote:
> On Thu, 02 Feb 2017 01:30:08 +0100
> "Rafael J. Wysocki" <rjw@xxxxxxxxxxxxx> wrote:
>
>> This is a new (and hopefully final) iteration of the series of patches starting
>> the conversion of power management driver API documentation.
>>
>> Patch [1/3] updates kerneldoc comments in include/linux/pm.h (to make the
>> documentation generated out of them look better), patch [2/3] converts
>> Documentation/power/devices.txt to reST, and patch [3/3] does the same thing
>> to Documentation/power/notifiers.txt (the new files go into the driver-api subdir
>> and are hooked up to that manual).
>>
>> Patch [1/3] has not been changed since the previous iteration. Patch [2/3]
>> addresses some comments from Lukas and patch [3/3] has been trivially
>> rebased.
>>
>> Please apply unless there are any objections.
>
> Just applied them, thanks.
Thank you!
> One thing I do notice is that, while you update the kerneldoc comments,
> nothing in the associated documentation pulls them in. That would be a
> good future enhancement...:)
They are pulled in by patch [2/3] via types.rst (AFAICS).
I guess that's a bit confusing (sorry about that), but I wanted to
avoid putting too much stuff into one patch.
Thanks,
Rafael