Skip to content

Commit e1a5e6a

Browse files
committed
drm/doc: Add RFC section
Motivated by the pre-review process for i915 gem/gt features, but probably useful in general for complex stuff. v2: Add reminder to not forget userspace projects in the discussion (Simon, Jason) v3: Actually put this into a folder, so we have it all (.rst files and headers for kerneldoc) contained somewhere separate (Jason) Cc: Simon Ser <[email protected]> Cc: Jani Nikula <[email protected]> Cc: Joonas Lahtinen <[email protected]> Cc: Rodrigo Vivi <[email protected]> Cc: Jason Ekstrand <[email protected]> Cc: Dave Airlie <[email protected]> Acked-by: Jason Ekstrand <[email protected]> Acked-by: Simon Ser <[email protected]> Acked-by: Rodrigo Vivi <[email protected]> Acked-by: Dave Airlie <[email protected]> Signed-off-by: Daniel Vetter <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent 6ab61ad commit e1a5e6a

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

Documentation/gpu/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Linux GPU Driver Developer's Guide
1616
vga-switcheroo
1717
vgaarbiter
1818
todo
19+
rfc/index
1920

2021
.. only:: subproject and html
2122

Documentation/gpu/rfc/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
===============
2+
GPU RFC Section
3+
===============
4+
5+
For complex work, especially new uapi, it is often good to nail the high level
6+
design issues before getting lost in the code details. This section is meant to
7+
host such documentation:
8+
9+
* Each RFC should be a section in this file, explaining the goal and main design
10+
considerations. Especially for uapi make sure you Cc: all relevant project
11+
mailing lists and involved people outside of dri-devel.
12+
13+
* For uapi structures add a file to this directory with and then pull the
14+
kerneldoc in like with real uapi headers.
15+
16+
* Once the code has landed move all the documentation to the right places in
17+
the main core, helper or driver sections.

0 commit comments

Comments
 (0)