doc: add guideines for initial PMD submission
PATCH v3 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.
---
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(+)
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, 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.
Signature · 1 line
2.19.2
Quoted 12 lines
-----Original Message-----
From: Rami Rosen [mailto:[email protected]]
Sent: Friday, April 12, 2019 11:27 AM
To: [email protected]
Cc: Trahe, Fiona <[email protected]>; [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; [email protected]; Rami Rosen <[email protected]>
Subject: [PATCH V3] doc: add guideines for initial PMD submission
Quoted 7 lines
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
MAINTAINERSfile. Though this may seem obvious, it is not mentioned in DPDK documentation.
02/05/2019 17:59, Mcnamara, John:
Quoted 11 lines
From: Rami Rosen [mailto:[email protected]]
Quoted 8 lines
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
MAINTAINERSfile. Though this may seem obvious, it is not mentioned in DPDK documentation.Acked-by John McNamara <[email protected]>
The MAINTAINERS file is already part of the documentation:
http://doc.dpdk.org/guides/contributing/patches.html#dpdk-maintainers
Should we add a reference to this chapter?
Quoted 24 lines
-----Original Message-----
From: Thomas Monjalon [mailto:[email protected]]
Sent: Monday, May 13, 2019 9:00 PM
To: Mcnamara, John <[email protected]>; Rami Rosen <[email protected]>
Cc: [email protected]; Trahe, Fiona <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission02/05/2019 17:59, Mcnamara, John:
Quoted 10 lines
From: Rami Rosen [mailto:[email protected]]
Quoted 8 lines
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
MAINTAINERSfile. Though this may seem obvious, it is not mentioned in DPDK documentation.
Quoted 6 lines
Quoted 1 line
Acked-by John McNamara <[email protected]>The
MAINTAINERSfile is already part of the documentation:
http://doc.dpdk.org/guides/contributing/patches.html#dpdk-
maintainers
Should we add a reference to this chapter?
I don't think there is any need to include a link. There are lots of similar references to the MAINTAINERS file in the same doc section.
I think the patch is fine as it is.
John
Quoted 10 lines
From: Rami Rosen [mailto:[email protected]]
Quoted 6 lines
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
MAINTAINERSfile. Though this may seem obvious, it is not mentioned in DPDK documentation.Acked-by John McNamara <[email protected]>
Applied
Last contribution, last commit closing the release. Thank you Rami, you will be missed.