doc: add guideines for initial PMD submission
PATCH v2 1/1 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.
Signed-off-by Rami Rosen <[email protected]>
---
V2 changes:
* Fix according to feedback from Fiona Trahe and Akhil Goyal.
doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
doc/guides/contributing/patches.rst +8 -0
@@ -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, intial 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.
Signature · 1 line
2.19.2