• Daniel Vetter's avatar
    drm/prime: Update docs · 805dc614
    Daniel Vetter authored
    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.
    
    - 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.
    
    v3:
    - Split out the function moving. This patch is now exclusively
      documentation changes.
    - Typos and nits (Sam).
    
    v4: Polish suggestions from Noralf.
    Acked-by: default avatarGerd Hoffmann <kraxel@redhat.com>
    Acked-by: default avatarEmil Velikov <emil.velikov@collabora.com>
    Acked-by: default avatarNoralf Trønnes <noralf@tronnes.org>
    Cc: Thomas Zimmermann <tzimmermann@suse.de>
    Cc: Gerd Hoffmann <kraxel@redhat.com>
    Cc: Noralf Trønnes <noralf@tronnes.org>
    Cc: Sam Ravnborg <sam@ravnborg.org>
    Cc: Eric Anholt <eric@anholt.net>
    Cc: Emil Velikov <emil.l.velikov@gmail.com>
    Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
    Link: https://patchwork.freedesktop.org/patch/msgid/20190620124615.24434-1-daniel.vetter@ffwll.ch
    805dc614
drm_gem.h 12.1 KB