[dpdk-dev,v2] doc: add maintainers section to the contributors guide

Message ID 1518512912-149012-1-git-send-email-ciara.power@intel.com
State Accepted, archived
Headers show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Ciara Power Feb. 13, 2018, 9:08 a.m.
Add a maintainers section to the contributors guide to have a low tech
location to check/link to the current maintainers. This file is included
dynamically from the MAINTAINERS file in the root directory of the DPDK
source when the docs are built. This also allows us to link to the file
from other sections of the docs.

Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 doc/guides/contributing/patches.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Mcnamara, John Feb. 13, 2018, 9:48 a.m. | #1
> -----Original Message-----
> From: Power, Ciara
> Sent: Tuesday, February 13, 2018 9:09 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; Power, Ciara <ciara.power@intel.com>
> Subject: [PATCH v2] doc: add maintainers section to the contributors guide
> 
> Add a maintainers section to the contributors guide to have a low tech
> location to check/link to the current maintainers. This file is included
> dynamically from the MAINTAINERS file in the root directory of the DPDK
> source when the docs are built. This also allows us to link to the file
> from other sections of the docs.
> 
> Signed-off-by: Ciara Power <ciara.power@intel.com>

This will be useful.

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Feb. 13, 2018, 11:20 p.m. | #2
> > Add a maintainers section to the contributors guide to have a low tech
> > location to check/link to the current maintainers. This file is included
> > dynamically from the MAINTAINERS file in the root directory of the DPDK
> > source when the docs are built. This also allows us to link to the file
> > from other sections of the docs.
> > 
> > Signed-off-by: Ciara Power <ciara.power@intel.com>
> 
> This will be useful.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

You find it more useful than http://dpdk.org/browse/dpdk/plain/MAINTAINERS ?

Applied, thanks

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 3c2f310..2287835 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -551,3 +551,12 @@  patch accepted. The general cycle for patch review and acceptance is:
      than rework of the original.
    * Trivial patches may be merged sooner than described above at the tree committer's
      discretion.
+
+DPDK Maintainers
+----------------
+
+The following are the DPDK maintainers as listed in the ``MAINTAINERS`` file
+in the DPDK root directory.
+
+.. literalinclude:: ../../../MAINTAINERS
+   :lines: 3-