[PATCH 2/2] drm/doc: Add RFC section

Jason Ekstrand jason at jlekstrand.net
Thu Mar 25 02:37:25 UTC 2021


Acked-by: Jason Ekstrand <jason at jlekstrand.net>

On March 24, 2021 16:10:48 Daniel Vetter <daniel.vetter at ffwll.ch> wrote:

> 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)
>
> Cc: Simon Ser <contact at emersion.fr>
> Cc: Jani Nikula <jani.nikula at linux.intel.com>
> Cc: Joonas Lahtinen <joonas.lahtinen at linux.intel.com>
> Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Cc: Jason Ekstrand <jason at jlekstrand.net>
> Cc: Dave Airlie <airlied at redhat.com>
> Acked-by: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Acked-by: Dave Airlie <airlied at redhat.com>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> ---
> Documentation/gpu/index.rst |  1 +
> Documentation/gpu/rfc.rst   | 17 +++++++++++++++++
> 2 files changed, 18 insertions(+)
> create mode 100644 Documentation/gpu/rfc.rst
>
> diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst
> index c9a51e3bfb5a..df58cb826d68 100644
> --- a/Documentation/gpu/index.rst
> +++ b/Documentation/gpu/index.rst
> @@ -16,6 +16,7 @@ Linux GPU Driver Developer's Guide
>    vga-switcheroo
>    vgaarbiter
>    todo
> +   rfc
>
> .. only::  subproject and html
>
> diff --git a/Documentation/gpu/rfc.rst b/Documentation/gpu/rfc.rst
> new file mode 100644
> index 000000000000..a8621f7dab8b
> --- /dev/null
> +++ b/Documentation/gpu/rfc.rst
> @@ -0,0 +1,17 @@
> +===============
> +GPU RFC Section
> +===============
> +
> +For complex work, especially new uapi, it is often good to nail the high level
> +design issues before getting lost in the code details. This section is 
> meant to
> +host such documentation:
> +
> +* Each RFC should be a section in this file, explaining the goal and main 
> design
> +  considerations. Especially for uapi make sure you Cc: all relevant project
> +  mailing lists and involved people outside of dri-devel.
> +
> +* For uapi structures add a file to this directory with and then pull the
> +  kerneldoc in like with real uapi headers.
> +
> +* Once the code has landed move all the documentation to the right places in
> +  the main core, helper or driver sections.
> --
> 2.31.0

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/dri-devel/attachments/20210324/cc2977bd/attachment-0001.htm>


More information about the dri-devel mailing list