[PATCH 02/11] doc: update CONTRIBUTING and add MAINTAINERS file

Thu Oct 25 20:13:23 UTC 2018

On Thu, Oct 25, 2018 at 09:42:47AM -0700, Rodrigo Vivi wrote:
> On Thu, Oct 25, 2018 at 12:05:19PM -0400, Sean Paul wrote:
> > On Thu, Oct 25, 2018 at 06:54:26PM +0300, Jani Nikula wrote:
> > > On Thu, 25 Oct 2018, Sean Paul <sean at poorly.run> wrote:
> > > > On Thu, Oct 25, 2018 at 06:22:02PM +0300, Jani Nikula wrote:
> > > >> Refresh contributing, accept issues at fdo gitlab, and add separate
> > > >> maintainers file for clarity.
> > > >> 
> > > >> Signed-off-by: Jani Nikula <jani.nikula at intel.com>
> > > >> ---
> > > >>  CONTRIBUTING.rst | 20 +++++++++++++++-----
> > > >>  MAINTAINERS.rst  | 10 ++++++++++
> > > >>  index.rst        |  1 +
> > > >>  3 files changed, 26 insertions(+), 5 deletions(-)
> > > >>  create mode 100644 MAINTAINERS.rst
> > > >> 
> > > >> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
> > > >> index c7846e318b7e..2a83590e0442 100644
> > > >> --- a/CONTRIBUTING.rst
> > > >> +++ b/CONTRIBUTING.rst
> > > >> @@ -1,11 +1,21 @@
> > > >> -CONTRIBUTING
> > > >> -============
> > > >> +.. _contributing:
> > > >>  
> > > >> -Submit patches, bug reports, and questions for any of the maintainer tools and
> > > >> -documentation to the dim-tools at lists.freedesktop.org mailing list.
> > > >> +==========================
> > > >> + Contributing and Contact
> > > >> +==========================
> > > >> +
> > > >> +Please use the `dim-tools at lists.freedesktop.org`_ mailing list for
> > > >> +contributions, bug reports, and discussion about the tooling and
> > > >> +documentation. You may also file `issues`_ at the `project home page`_.
> > > >>  
> > > >>  Please make sure your patches pass the build and self tests by running::
> > > >>  
> > > >>    $ make check
> > > >>  
> > > >> -Push the patches once you have an ack from maintainers (Jani/Daniel).
> > > >> +Push the patches once you have an ack from :ref:`maintainers`.
> > > >> +
> > > >> +.. _dim-tools at lists.freedesktop.org: https://lists.freedesktop.org/mailman/listinfo/dim-tools
> > > >> +
> > > >> +.. _issues: https://gitlab.freedesktop.org/drm/maintainer-tools/issues
> > > >> +
> > > >> +.. _project home page: https://gitlab.freedesktop.org/drm/maintainer-tools/
> > > >> diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
> > > >> new file mode 100644
> > > >> index 000000000000..794ab99ae0e4
> > > >> --- /dev/null
> > > >> +++ b/MAINTAINERS.rst
> > > >> @@ -0,0 +1,10 @@
> > > >> +.. _maintainers:
> > > >> +
> > > >> +=============
> > > >> + Maintainers
> > > >> +=============
> > > >> +
> > > >> +The maintainer tools and documentation is maintained by:
> > > >> +
> > > >> +* Daniel Vetter <daniel.vetter at ffwll.ch>
> > > >> +* Jani Nikula <jani.nikula at intel.com>
> > > >
> > > > I wonder if you'd be better off just pointing to [1] instead of trying to keep
> > > > this up-to-date. Unfortunately that page also shows airlied and I as owners
> > > > (which I guess is inherited from the group?).
> > > 
> > > I think I'd probably like to add the MAINTAINERS.rst file anyway, so
> > > this patch is a step in that direction. Looking at [1], the names I'm
> > > adding are already stale, just copy-pasting the status quo... and I
> > > don't even know the difference between owner and maintainer in gitlab
> > > speak. Can you do everything that a maintainer can do?
> > 
> > Owner is a superset of Maintainer, iiuc.
> 
> So in this case we would only see the Daniel and Jani as Owners
> and the rest developers right?

Afaiui Owner exists only at the group level (think of it as folders with
ACL attached), and it allows you to create new projects in that group. All
Owners also automatically get maintainer permissions in all the projects
they're in (plus they can delete projects). Think Owner = your local
sysadmin. Of course fd.o admins have implied Owner rights everywhere.

Unfortunately there's no way to not inherit full maintainer rights if
you're an owner, which would be really nice to avoid accidents. You can
add owners as a lower role in a project, but that doesn't reduce the
rights.  Probably still a good idea to do that, since when the owners
change then they keep the rights. E.g. in igt I'm also listed as Developer
role.

Cheers, Daniel

> 
> So maybe the doc here is useful even when that is fixed there?!
> 
> Anyway, while we don't get that fixed and proper gitlab view in
> place I believe this patch is correct:
> 
> Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>
> 
> > 
> > Sean
> > 
> > > 
> > > BR,
> > > Jani.
> > > 
> > > >
> > > > Sean
> > > >
> > > > [1]- https://gitlab.freedesktop.org/drm/maintainer-tools/project_members
> > > >
> > > >
> > > >
> > > >> diff --git a/index.rst b/index.rst
> > > >> index 46ba235514c8..228ca8790f59 100644
> > > >> --- a/index.rst
> > > >> +++ b/index.rst
> > > >> @@ -17,6 +17,7 @@ Contents:
> > > >>     dim
> > > >>     qf
> > > >>     CONTRIBUTING
> > > >> +   MAINTAINERS
> > > >>     TODO
> > > >>  
> > > >>  Indices and tables
> > > >> -- 
> > > >> 2.11.0
> > > >> 
> > > >> _______________________________________________
> > > >> dim-tools mailing list
> > > >> dim-tools at lists.freedesktop.org
> > > >> https://lists.freedesktop.org/mailman/listinfo/dim-tools
> > > 
> > > -- 
> > > Jani Nikula, Intel Open Source Graphics Center
> > 
> > -- 
> > Sean Paul, Software Engineer, Google / Chromium OS

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch