Re: [PATCH] drm: Docbook fixes

Daniel Vetter
2014-08-05T07:28:26Z

On Tue, Aug 5, 2014 at 4:51 AM, Dave Airlie <airlied@gmail.com> wrote:
> On 30 July 2014 23:36, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>> Bunch of small leftovers spotted by looking at the make htmldocs output.
>>
>> I've left out dp mst, there's too much amiss there.
>
> (btw this patch doesn't apply cleanly - modeset_lock seems different).

It is on top of the atomic prep patches, so follows the code move for
modeset_lock_all stuff.

> Just spotted this comment!
> I do wonder if I should really be documenting the internals of that
> struct in docbook,
>
> The main reason its there is to embed in the driver, I don't think
> drivers should be
> looking inside it too often, and we certainly shouldn't be generating info about
> most of the members in the interface docs for driver writers.

Hm right, besides the header structs it's just one parameter that's
missing. I'll augment the patch. On a quick look documentation for
return value semantics is missing a bit, but I'm too lazy to add that
everywhere. Maybe when I have an excuse to read through the dp mst
code ;-)
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch