diff mbox series

docs/drm: Add a new bullet to the uAPI requirements (v2)

Message ID 20210804185704.624883-1-jason@jlekstrand.net (mailing list archive)
State New, archived
Headers show
Series docs/drm: Add a new bullet to the uAPI requirements (v2) | expand

Commit Message

Jason Ekstrand Aug. 4, 2021, 6:57 p.m. UTC 
While tracking down various bits of i915 uAPI, it's been difficult to
find the userspace much of the time because no one bothers to mention it
in commit messages.  Require the kernel patch to be a one-stop shop for
finding the various bits which were used to justify the new uAPI.

v2 (Daniel Vetter):
 - Minor wording tweaks

Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Dave Airlie <airlied@redhat.com>
---
 Documentation/gpu/drm-uapi.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Daniel Stone Aug. 4, 2021, 9:36 p.m. UTC | #1 
On Wed, 4 Aug 2021 at 19:57, Jason Ekstrand <jason@jlekstrand.net> wrote:
> While tracking down various bits of i915 uAPI, it's been difficult to
> find the userspace much of the time because no one bothers to mention it
> in commit messages.  Require the kernel patch to be a one-stop shop for
> finding the various bits which were used to justify the new uAPI.

Acked-by: Daniel Stone <daniels@collabora.com>
diff mbox series

Patch

diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 199afb503ab1..7b398c6fadc6 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -109,6 +109,11 @@  leads to a few additional requirements:
   userspace patches land. uAPI always flows from the kernel, doing things the
   other way round risks divergence of the uAPI definitions and header files.
 
+- The kernel patch which adds the new uAPI **must** reference the patch series
+  or merge requests in the userspaces projects which demonstrate the use of the
+  new uAPI and against which the review was done so that future developers can
+  find all of the pieces which tie together.
+
 These are fairly steep requirements, but have grown out from years of shared
 pain and experience with uAPI added hastily, and almost always regretted about
 just as fast. GFX devices change really fast, requiring a paradigm shift and