vga_switcheroo docs (was: Re: [PATCH v2.1 1/3] vga_switcheroo: Add support for switching only the DDC)

[Lukas Wunner]

Hi Daniel,

On Tue, Aug 25, 2015 at 10:12:50AM +0200, Daniel Vetter wrote:
> Since you're just diggin around in switcheroo code it would be awesome to
> write proper kerneldoc for all the functions exposed to drivers, move the
> above to a proper kerneldoc for the vfunc tables

Alright, a patch set with vga_switcheroo docs is coming up right after this
e-mail. I also fixed some bugs and cosmetic issues while I was at it.

To ease reviewing I've pushed this to GitHub:
https://github.com/l1k/linux/commits/vga_switcheroo_docs

Patch #2 requires Markdown support so you may want to postpone that single
patch for now. The patches are based on today's topic/drm-misc.


> (there's new support for adding kerneldoc split up per member instead of
> one big pile squashed at the top).

To be honest the data structures aren't that large so I felt that the
traditional "docs above, struct below" way is clearer and more concise
in this case.


> And then bind it together with the overview sections with DOC
> comments in Documentation/DocBook/drm.tmpl.

vga_switcheroo is a subsystem of its own which interfaces not just with
DRM but also with multiplexer drivers, ALSA and power management,
so I put it in a separate .tmpl file.


Thanks,

Lukas