[V3] doc: add guideines for initial PMD submission

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


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(+)


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.