Re: [RFC] DRM developer guide

[Renato C. <sev...@gm...>]

On Thu, Jun 19, 2008 at 11:13 PM, Jesse Barnes <jes...@in...> wrote:
> In a shameless attempt to capitalize on the recent enthusiasm for documenting
> things, I've put together a skeletal DRM developer guide.
>
> The intent of the guide is to provide information to developers about the
> complex new memory management and mode setting subsystems that are being
> added to the DRM.  My hope is that the guide will provide people with enough
> info to either add support for these features to existing drivers, or to
> write new drivers from scratch.
>
> It's obviously incomplete, but I wanted to get some feedback about how things
> are structured and on logistical questions like what formats we should use.
>
> The attached PDF was generated from the attached DocBook template, and
> references Linux kernel doc comments in the sources.  Unfortunately, the
> current DRM has a mix of Linux kernel doc and doxygen documentation, and only
> some of the very recent stuff is actually accurate and usable.
>
> Anyone have suggestions on any of the above?  My focus now is to get the mode
> setting and memory management sections fleshed out, followed by some of the
> simpler stuff, and I'm definitely interested in getting feedback on what's
> there now.
>
> Any thoughts?

I can't comment on the technical aspects, but it is definitely an
important initiative. The current trend everywhere is that programmers
write code and not documentation. Unfortunately this leads to a
steeper learning curve as the code increases in complexity, which is
bad for the newcomers.

Personally I've read the pdf with much interest, and it did clarify
some doubts I had. I'm looking forward for the next versions ;)

Thanks!
  Renato Caldas

> Thanks,
> Jesse