| Message ID | 20210323084453.366863-2-daniel.vetter@ffwll.ch (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/2] drm/i915: add gem/gt TODO | expand |
On Tue, Mar 23, 2021 at 09:44:53AM +0100, Daniel Vetter wrote: > Motivated by the pre-review process for i915 gem/gt features, but > probably useful in general for complex stuff. > > Cc: Jani Nikula <jani.nikula@linux.intel.com> > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> > Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> > Cc: Jason Ekstrand <jason@jlekstrand.net> > Cc: Dave Airlie <airlied@redhat.com> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> > --- > Documentation/gpu/index.rst | 1 + > Documentation/gpu/rfc.rst | 16 ++++++++++++++++ > 2 files changed, 17 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 I understand the motivation here so I didn't commented earlier, but looking now, I'm wondering that this section will polute the official doc... > > .. only:: subproject and html > > diff --git a/Documentation/gpu/rfc.rst b/Documentation/gpu/rfc.rst > new file mode 100644 > index 000000000000..9d0ff2921af8 > --- /dev/null > +++ b/Documentation/gpu/rfc.rst > @@ -0,0 +1,16 @@ > +=============== > +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. > + > +* 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 >
On Tue, Mar 23, 2021 at 08:37:07AM -0400, Rodrigo Vivi wrote: > On Tue, Mar 23, 2021 at 09:44:53AM +0100, Daniel Vetter wrote: > > Motivated by the pre-review process for i915 gem/gt features, but > > probably useful in general for complex stuff. > > > > Cc: Jani Nikula <jani.nikula@linux.intel.com> > > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> > > Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> > > Cc: Jason Ekstrand <jason@jlekstrand.net> > > Cc: Dave Airlie <airlied@redhat.com> > > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> > > --- > > Documentation/gpu/index.rst | 1 + > > Documentation/gpu/rfc.rst | 16 ++++++++++++++++ > > 2 files changed, 17 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 > > I understand the motivation here so I didn't commented earlier, but looking now, > I'm wondering that this section will polute the official doc... We already have this problem between documentation meant for kernel driver developers and documentation meant for userspace developers around uapi and all that. "who is the audience here" is very ill-defined for our current set of docs in Documentation/gpu :-( So I agree with you, but I also don't think this will make things worse. -Daniel > > > > > .. only:: subproject and html > > > > diff --git a/Documentation/gpu/rfc.rst b/Documentation/gpu/rfc.rst > > new file mode 100644 > > index 000000000000..9d0ff2921af8 > > --- /dev/null > > +++ b/Documentation/gpu/rfc.rst > > @@ -0,0 +1,16 @@ > > +=============== > > +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. > > + > > +* 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 > >
On Tue, Mar 23, 2021 at 02:10:17PM +0100, Daniel Vetter wrote: > On Tue, Mar 23, 2021 at 08:37:07AM -0400, Rodrigo Vivi wrote: > > On Tue, Mar 23, 2021 at 09:44:53AM +0100, Daniel Vetter wrote: > > > Motivated by the pre-review process for i915 gem/gt features, but > > > probably useful in general for complex stuff. > > > > > > Cc: Jani Nikula <jani.nikula@linux.intel.com> > > > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> > > > Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> > > > Cc: Jason Ekstrand <jason@jlekstrand.net> > > > Cc: Dave Airlie <airlied@redhat.com> > > > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> > > > --- > > > Documentation/gpu/index.rst | 1 + > > > Documentation/gpu/rfc.rst | 16 ++++++++++++++++ > > > 2 files changed, 17 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 > > > > I understand the motivation here so I didn't commented earlier, but looking now, > > I'm wondering that this section will polute the official doc... > > We already have this problem between documentation meant for kernel driver > developers and documentation meant for userspace developers around uapi > and all that. "who is the audience here" is very ill-defined for our > current set of docs in Documentation/gpu :-( you have a point... another thing that I don't like is the overhead, but otoh it forces us to write more docs... with all the pros and cons understood, let's move on... Acked-by: Rodrigo Vivi <rodrigo.vivi@intel.com> > > So I agree with you, but I also don't think this will make things worse. > -Daniel > > > > > > > > > .. only:: subproject and html > > > > > > diff --git a/Documentation/gpu/rfc.rst b/Documentation/gpu/rfc.rst > > > new file mode 100644 > > > index 000000000000..9d0ff2921af8 > > > --- /dev/null > > > +++ b/Documentation/gpu/rfc.rst > > > @@ -0,0 +1,16 @@ > > > +=============== > > > +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. > > > + > > > +* 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 > > > > > -- > Daniel Vetter > Software Engineer, Intel Corporation > http://blog.ffwll.ch
Side note: I feel like we could have better lines of communication between kernel devs and user-space devs. The new uAPI requirements seem to be a high barrier to entry for kernel devs. However sometimes user-space devs might be interested in helping out with the user-space part… Maybe it would be good to CC e.g. wayland-devel for new RFCs, so that user-space devs can jump in if they're interested. And also provide feedback, since new uAPI is hard to spot in the sea of messages in dri-devel.
On Tue, Mar 23, 2021 at 12:01 PM Simon Ser <contact@emersion.fr> wrote: > > Side note: I feel like we could have better lines of communication > between kernel devs and user-space devs. The new uAPI requirements seem > to be a high barrier to entry for kernel devs. However sometimes > user-space devs might be interested in helping out with the user-space > part… > > Maybe it would be good to CC e.g. wayland-devel for new RFCs, so that > user-space devs can jump in if they're interested. And also provide > feedback, since new uAPI is hard to spot in the sea of messages in > dri-devel. That's a good suggestion. CCing wayland-dev or mesa-dev, as appropriate, with such docs patches sounds like a good idea. I'm not sure where we would put that in here but it would be good to call out.
On Tue, Mar 23, 2021 at 6:55 PM Jason Ekstrand <jason@jlekstrand.net> wrote: > > On Tue, Mar 23, 2021 at 12:01 PM Simon Ser <contact@emersion.fr> wrote: > > > > Side note: I feel like we could have better lines of communication > > between kernel devs and user-space devs. The new uAPI requirements seem > > to be a high barrier to entry for kernel devs. However sometimes > > user-space devs might be interested in helping out with the user-space > > part… > > > > Maybe it would be good to CC e.g. wayland-devel for new RFCs, so that > > user-space devs can jump in if they're interested. And also provide > > feedback, since new uAPI is hard to spot in the sea of messages in > > dri-devel. > > That's a good suggestion. CCing wayland-dev or mesa-dev, as > appropriate, with such docs patches sounds like a good idea. I'm not > sure where we would put that in here but it would be good to call out. I'll add a suggestion to that extend, it's a good one. -Daniel
On Tue, 23 Mar 2021 at 18:45, Daniel Vetter <daniel.vetter@ffwll.ch> wrote: > > Motivated by the pre-review process for i915 gem/gt features, but > probably useful in general for complex stuff. > > Cc: Jani Nikula <jani.nikula@linux.intel.com> > Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> > Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> > Cc: Jason Ekstrand <jason@jlekstrand.net> > Cc: Dave Airlie <airlied@redhat.com> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Let's give it a try, I do like the future ideas of doing things with gitlab issues as well. Acked-by: Dave Airlie <airlied@redhat.com> > --- > Documentation/gpu/index.rst | 1 + > Documentation/gpu/rfc.rst | 16 ++++++++++++++++ > 2 files changed, 17 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..9d0ff2921af8 > --- /dev/null > +++ b/Documentation/gpu/rfc.rst > @@ -0,0 +1,16 @@ > +=============== > +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. > + > +* 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 > > _______________________________________________ > Intel-gfx mailing list > Intel-gfx@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
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..9d0ff2921af8 --- /dev/null +++ b/Documentation/gpu/rfc.rst @@ -0,0 +1,16 @@ +=============== +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. + +* 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.
Motivated by the pre-review process for i915 gem/gt features, but probably useful in general for complex stuff. Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> Cc: Jason Ekstrand <jason@jlekstrand.net> Cc: Dave Airlie <airlied@redhat.com> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> --- Documentation/gpu/index.rst | 1 + Documentation/gpu/rfc.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 Documentation/gpu/rfc.rst