drm/i915/uapi: convert i915_query and friend to kernel doc
authorMatthew Auld <matthew.auld@intel.com>
Mon, 19 Apr 2021 10:57:41 +0000 (11:57 +0100)
committerMatthew Auld <matthew.auld@intel.com>
Tue, 20 Apr 2021 09:11:01 +0000 (10:11 +0100)
commite3bdccafb5bcfab286f4f3d57d35efc4e7368c18
tree8eb919b7ef0793ebd92ea437bc6841e86902ae00
parent19d053d477a145069bc2c38b28dcee773690c804
drm/i915/uapi: convert i915_query and friend to kernel doc

Add a note about the two-step process.

v2(Tvrtko):
  - Also document the other method of just passing in a buffer which is
    large enough, which avoids two ioctl calls. Can make sense for
    smaller query items.
v3: prefer kernel-doc references for structs and members

Suggested-by: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Matthew Auld <matthew.auld@intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Daniel Vetter <daniel.vetter@intel.com>
Cc: Kenneth Graunke <kenneth@whitecape.org>
Cc: Jason Ekstrand <jason@jlekstrand.net>
Cc: Dave Airlie <airlied@gmail.com>
Cc: dri-devel@lists.freedesktop.org
Cc: mesa-dev@lists.freedesktop.org
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net>
Link: https://patchwork.freedesktop.org/patch/msgid/20210419105741.27844-4-matthew.auld@intel.com
include/uapi/drm/i915_drm.h