doc: add guideines for initial PMD submission
Checks
Commit Message
This patch for DPDK Contributor's Guidelines indicates the repos
against which a new PMD should be prepared; for new network ethernet
PMDs it should be dpdk-next-net, and for new crypto PMDs
it should be dpdk-next-crypto. Though this may seem obvious, it
is not mentioned in DPDK documentation.
Cc: stable@dpdk.org
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
doc/guides/contributing/patches.rst | 4 ++++
1 file changed, 4 insertions(+)
Comments
Hi Rami,
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Rami Rosen
> Sent: Tuesday, April 9, 2019 6:37 PM
> To: dev@dpdk.org
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> akhil.goyal@nxp.com; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; Rami Rosen <ramirose@gmail.com>; stable@dpdk.org
> Subject: [dpdk-dev] [PATCH] 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 new network ethernet
> PMDs it should be dpdk-next-net, and for new crypto PMDs
> it should be dpdk-next-crypto. Though this may seem obvious, it
> is not mentioned in DPDK documentation.
>
> Cc: stable@dpdk.org
> Signed-off-by: Rami Rosen <ramirose@gmail.com>
> ---
> doc/guides/contributing/patches.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index d8404e623..4dde8e724 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -148,6 +148,10 @@ 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.
>
> +* If you add a new network PMD you should prepare the initial submission against dpdk-next-net repo.
> +
> +* If you add a new crypto PMD you should prepare the initial submission against dpdk-next-crypto repo.
[Fiona] Good idea to add this patch. However despite the name crypto is actual broader.... so maybe
"If you add a new crypto or compression PMD.... "
Hi Fiona,
>[Fiona] Good idea to add this patch. However despite the name crypto is
actual broader.... so maybe
>"If you add a new crypto or compression PMD.... "
Thanks for this feedback, I will fix it in V2 of the patch.
Regards,
Rami Rosen
@@ -148,6 +148,10 @@ 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.
+* If you add a new network PMD you should prepare the initial submission against dpdk-next-net repo.
+
+* If you add a new crypto PMD you should prepare the initial submission against dpdk-next-crypto repo.
+
* 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.