From: Rami Rosen Date: Fri, 12 Apr 2019 10:26:51 +0000 (+0300) Subject: doc: add guidelines for initial PMD submission X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=78b04aaf77d2d429b79373a696ff30adedc7c327;p=dpdk.git 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 Acked-by: John McNamara Acked-by: Thomas Monjalon Last contribution, last commit closing the release. Thank you Rami, you will be missed. --- diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 5677f13931..9e1013b70a 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 `. New external functions should also be added in alphabetical order.