summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRami Rosen <ramirose@gmail.com>2019-04-12 13:26:51 +0300
committerThomas Monjalon <thomas@monjalon.net>2019-08-11 11:34:24 +0200
commit78b04aaf77d2d429b79373a696ff30adedc7c327 (patch)
tree1e2846470d165364896fe6dad499cd9ce1a96c0c
parentf6feb39c20cec3b520eaaef2dde436379e48330a (diff)
downloaddpdk-78b04aaf77d2d429b79373a696ff30adedc7c327.zip
dpdk-78b04aaf77d2d429b79373a696ff30adedc7c327.tar.gz
dpdk-78b04aaf77d2d429b79373a696ff30adedc7c327.tar.xz
doc: add guidelines 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. Signed-off-by: Rami Rosen <ramirose@gmail.com> Acked-by: John McNamara <john.mcnamara@intel.com> Acked-by: Thomas Monjalon <thomas@monjalon.net> Last contribution, last commit closing the release. Thank you Rami, you will be missed.
-rw-r--r--doc/guides/contributing/patches.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 5677f13..9e1013b 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -146,6 +146,16 @@ 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.