[V3] doc: add guideines for initial PMD submission

Message ID 20190412102651.5855-1-ramirose@gmail.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • [V3] doc: add guideines for initial PMD submission
Related show

Checks

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

Commit Message

Rami Rosen April 12, 2019, 10:26 a.m.
This patch for DPDK Contributor's Guidelines indicates the repos
against which a new PMD should be prepared; for example, for new 
network ethernet PMDs it should be dpdk-next-net, and for new crypto
PMDs it should be dpdk-next-crypto. For other new PMDs, the  
contributor should refer to the MAINTAINERS file. Though this may seem
obvious, it is not mentioned in DPDK documentation.

Cc: stable@dpdk.org  
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
V3 changes:
  * Fix a typo.
V2 changes:
  * Fix according to feedback from Fiona Trahe and Akhil Goyal.  

 doc/guides/contributing/patches.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Mcnamara, John May 2, 2019, 3:59 p.m. | #1
> -----Original Message-----
> From: Rami Rosen [mailto:ramirose@gmail.com]
> Sent: Friday, April 12, 2019 11:27 AM
> To: dev@dpdk.org
> Cc: Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; Mcnamara,
> John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; stable@dpdk.org; Rami Rosen
> <ramirose@gmail.com>
> Subject: [PATCH V3] doc: add guideines for initial PMD submission
> 
> This patch for DPDK Contributor's Guidelines indicates the repos against
> which a new PMD should be prepared; for example, for new network ethernet
> PMDs it should be dpdk-next-net, and for new crypto PMDs it should be
> dpdk-next-crypto. For other new PMDs, the contributor should refer to the
> MAINTAINERS file. Though this may seem obvious, it is not mentioned in
> DPDK documentation.
> 

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon May 13, 2019, 8 p.m. | #2
02/05/2019 17:59, Mcnamara, John:
> From: Rami Rosen [mailto:ramirose@gmail.com]
> > 
> > This patch for DPDK Contributor's Guidelines indicates the repos against
> > which a new PMD should be prepared; for example, for new network ethernet
> > PMDs it should be dpdk-next-net, and for new crypto PMDs it should be
> > dpdk-next-crypto. For other new PMDs, the contributor should refer to the
> > MAINTAINERS file. Though this may seem obvious, it is not mentioned in
> > DPDK documentation.
> > 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

The MAINTAINERS file is already part of the documentation:
	http://doc.dpdk.org/guides/contributing/patches.html#dpdk-maintainers
Should we add a reference to this chapter?

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index d8404e623..110cac41e 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -148,6 +148,14 @@  Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines
 
 * If you add new files or directories you should add your name to the ``MAINTAINERS`` file.
 
+* Initial submission of new PMDs should be prepared against a corresponding repo.
+
+* Thus, for example, initial submission of a new network PMD should be prepared against dpdk-next-net repo.
+
+* Likewise, initial submission of a new crypto or compression PMD should be prepared against dpdk-next-crypto repo.
+
+* For other PMDs and more info, refer to the ``MAINTAINERS`` file.
+
 * New external functions should be added to the local ``version.map`` file.
   See the :doc:`Guidelines for ABI policy and versioning </contributing/versioning>`.
   New external functions should also be added in alphabetical order.