[Intel-gfx] [PATCH 03/59] drm/prime: Update docs

[Emil Velikov]

On 2019/06/14, Daniel Vetter wrote:
> Yes this is a bit a big patch, but since it's essentially a complete
> rewrite of all the prime docs I didn't see how to better split it up.
> 
> Changes:
> - Consistently point to drm_gem_object_funcs as the preferred hooks,
>   where applicable.
> 
> - Reorder all the functions in drm_prime.[hc] into three groups: core,
>   export helpers, import helpers.
> 
> - Document all the hooks in &drm_driver that lacked kerneldoc.
> 
> - Completely new overview section, which now also includes the cleaned
>   up lifetime/reference counting subchapter. I also mentioned the weak
>   references in there due to the lookup caches.
> 
> - Completely rewritten helper intro section, highlight the
>   import/export related functionality.
> 
> - Polish for all the functions and more cross references.
> 
> I also sprinkled a bunch of todos all over.
> 
> Most important: 0 code changes in here. The cleanup motivated by
> reading and improving all this will follow later on.
> 
> v2: Actually update the prime helper docs. Plus add a few FIXMEs that
> I won't address right away in subsequent cleanup patches.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> ---
>  Documentation/gpu/drm-mm.rst |  40 +-
>  drivers/gpu/drm/drm_prime.c  | 851 ++++++++++++++++++-----------------
>  include/drm/drm_drv.h        | 104 ++++-
>  include/drm/drm_gem.h        |  18 +-
>  include/drm/drm_prime.h      |  42 +-
>  5 files changed, 576 insertions(+), 479 deletions(-)
> 
Resuffle is ok. Currently the commit summary says "comments" and we have
851 +/- for a ~960 loc file - not the example we want to set for others.

Can we get this into more managable hunks?

-Emil