DPDK patches and discussions
 help / color / Atom feed
* [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
@ 2019-04-12 10:26 Rami Rosen
  2019-04-12 10:26 ` Rami Rosen
  2019-05-02 15:59 ` Mcnamara, John
  0 siblings, 2 replies; 8+ messages in thread
From: Rami Rosen @ 2019-04-12 10:26 UTC (permalink / raw)
  To: dev
  Cc: fiona.trahe, akhil.goyal, john.mcnamara, marko.kovacevic, stable,
	Rami Rosen

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.

Cc: stable@dpdk.org  
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
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(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index d8404e623..110cac41e 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -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.
-- 
2.19.2

^ permalink raw reply	[flat|nested] 8+ messages in thread

* [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-04-12 10:26 [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission Rami Rosen
@ 2019-04-12 10:26 ` Rami Rosen
  2019-05-02 15:59 ` Mcnamara, John
  1 sibling, 0 replies; 8+ messages in thread
From: Rami Rosen @ 2019-04-12 10:26 UTC (permalink / raw)
  To: dev
  Cc: fiona.trahe, akhil.goyal, john.mcnamara, marko.kovacevic, stable,
	Rami Rosen

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.

Cc: stable@dpdk.org  
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
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(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index d8404e623..110cac41e 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -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.
-- 
2.19.2


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-04-12 10:26 [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission Rami Rosen
  2019-04-12 10:26 ` Rami Rosen
@ 2019-05-02 15:59 ` Mcnamara, John
  2019-05-02 15:59   ` Mcnamara, John
                     ` (2 more replies)
  1 sibling, 3 replies; 8+ messages in thread
From: Mcnamara, John @ 2019-05-02 15:59 UTC (permalink / raw)
  To: Rami Rosen, dev; +Cc: Trahe, Fiona, akhil.goyal, Kovacevic, Marko, stable



> -----Original Message-----
> From: Rami Rosen [mailto:ramirose@gmail.com]
> Sent: Friday, April 12, 2019 11:27 AM
> To: dev@dpdk.org
> Cc: Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; Mcnamara,
> John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; stable@dpdk.org; Rami Rosen
> <ramirose@gmail.com>
> Subject: [PATCH V3] 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.
> 

Acked-by: John McNamara <john.mcnamara@intel.com>

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-05-02 15:59 ` Mcnamara, John
@ 2019-05-02 15:59   ` Mcnamara, John
  2019-05-13 20:00   ` Thomas Monjalon
  2019-08-11  9:34   ` Thomas Monjalon
  2 siblings, 0 replies; 8+ messages in thread
From: Mcnamara, John @ 2019-05-02 15:59 UTC (permalink / raw)
  To: Rami Rosen, dev; +Cc: Trahe, Fiona, akhil.goyal, Kovacevic, Marko, stable



> -----Original Message-----
> From: Rami Rosen [mailto:ramirose@gmail.com]
> Sent: Friday, April 12, 2019 11:27 AM
> To: dev@dpdk.org
> Cc: Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; Mcnamara,
> John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; stable@dpdk.org; Rami Rosen
> <ramirose@gmail.com>
> Subject: [PATCH V3] 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.
> 

Acked-by: John McNamara <john.mcnamara@intel.com>



^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-05-02 15:59 ` Mcnamara, John
  2019-05-02 15:59   ` Mcnamara, John
@ 2019-05-13 20:00   ` Thomas Monjalon
  2019-05-13 20:00     ` Thomas Monjalon
  2019-07-30 11:34     ` Mcnamara, John
  2019-08-11  9:34   ` Thomas Monjalon
  2 siblings, 2 replies; 8+ messages in thread
From: Thomas Monjalon @ 2019-05-13 20:00 UTC (permalink / raw)
  To: Mcnamara, John, Rami Rosen
  Cc: dev, Trahe, Fiona, akhil.goyal, Kovacevic, Marko, stable

02/05/2019 17:59, Mcnamara, John:
> From: Rami Rosen [mailto:ramirose@gmail.com]
> > 
> > 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.
> > 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

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?

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-05-13 20:00   ` Thomas Monjalon
@ 2019-05-13 20:00     ` Thomas Monjalon
  2019-07-30 11:34     ` Mcnamara, John
  1 sibling, 0 replies; 8+ messages in thread
From: Thomas Monjalon @ 2019-05-13 20:00 UTC (permalink / raw)
  To: Mcnamara, John, Rami Rosen
  Cc: dev, Trahe, Fiona, akhil.goyal, Kovacevic, Marko, stable

02/05/2019 17:59, Mcnamara, John:
> From: Rami Rosen [mailto:ramirose@gmail.com]
> > 
> > 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.
> > 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

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?




^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-05-13 20:00   ` Thomas Monjalon
  2019-05-13 20:00     ` Thomas Monjalon
@ 2019-07-30 11:34     ` Mcnamara, John
  1 sibling, 0 replies; 8+ messages in thread
From: Mcnamara, John @ 2019-07-30 11:34 UTC (permalink / raw)
  To: Thomas Monjalon, Rami Rosen
  Cc: dev, Trahe, Fiona, akhil.goyal, Kovacevic, Marko, stable



> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Monday, May 13, 2019 9:00 PM
> To: Mcnamara, John <john.mcnamara@intel.com>; Rami Rosen
> <ramirose@gmail.com>
> Cc: dev@dpdk.org; Trahe, Fiona <fiona.trahe@intel.com>;
> akhil.goyal@nxp.com; Kovacevic, Marko <marko.kovacevic@intel.com>;
> stable@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD
> submission
> 
> 02/05/2019 17:59, Mcnamara, John:
> > From: Rami Rosen [mailto:ramirose@gmail.com]
> > >
> > > 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.
> > >
> >
> > Acked-by: John McNamara <john.mcnamara@intel.com>
> 
> 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?

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

 


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission
  2019-05-02 15:59 ` Mcnamara, John
  2019-05-02 15:59   ` Mcnamara, John
  2019-05-13 20:00   ` Thomas Monjalon
@ 2019-08-11  9:34   ` Thomas Monjalon
  2 siblings, 0 replies; 8+ messages in thread
From: Thomas Monjalon @ 2019-08-11  9:34 UTC (permalink / raw)
  To: dev; +Cc: Mcnamara, John, Trahe, Fiona, akhil.goyal, Kovacevic, Marko

> From: Rami Rosen [mailto:ramirose@gmail.com]
> 
> > 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.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied

Last contribution, last commit closing the release.
Thank you Rami, you will be missed.



^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, back to index

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-12 10:26 [dpdk-dev] [PATCH V3] doc: add guideines for initial PMD submission Rami Rosen
2019-04-12 10:26 ` Rami Rosen
2019-05-02 15:59 ` Mcnamara, John
2019-05-02 15:59   ` Mcnamara, John
2019-05-13 20:00   ` Thomas Monjalon
2019-05-13 20:00     ` Thomas Monjalon
2019-07-30 11:34     ` Mcnamara, John
2019-08-11  9:34   ` Thomas Monjalon

DPDK patches and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox