DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: add guideines for initial PMD submission
@ 2019-04-09 17:36 Rami Rosen
  2019-04-09 17:36 ` Rami Rosen
  2019-04-10 10:06 ` Trahe, Fiona
  0 siblings, 2 replies; 12+ messages in thread
From: Rami Rosen @ 2019-04-09 17:36 UTC (permalink / raw)
  To: dev
  Cc: ferruh.yigit, pablo.de.lara.guarch, akhil.goyal, john.mcnamara,
	marko.kovacevic, Rami Rosen, stable

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.
+
 * 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] 12+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: add guideines for initial PMD submission
@ 2019-04-10 10:28 Akhil Goyal
  2019-04-10 10:28 ` Akhil Goyal
  2019-04-10 14:40 ` Rami Rosen
  0 siblings, 2 replies; 12+ messages in thread
From: Akhil Goyal @ 2019-04-10 10:28 UTC (permalink / raw)
  To: Trahe, Fiona, Rami Rosen, dev
  Cc: Yigit, Ferruh, De Lara Guarch, Pablo, Mcnamara, John, Kovacevic,
	Marko, stable

Hi Rami,

> >
> > 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.... "

I believe this information is already captured in the MAINTAINERS file about which PMD goes to which tree.
If we need to document it in the documentation as well, then probably all other stuff should also be captured (like event and bbdev)

-Akhil

^ permalink raw reply	[flat|nested] 12+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: add guideines for initial PMD submission
@ 2019-04-10 14:49 Akhil Goyal
  2019-04-10 14:49 ` Akhil Goyal
  0 siblings, 1 reply; 12+ messages in thread
From: Akhil Goyal @ 2019-04-10 14:49 UTC (permalink / raw)
  To: Rami Rosen
  Cc: Trahe, Fiona, dev, Yigit, Ferruh, De Lara Guarch, Pablo,
	Mcnamara, John, Kovacevic, Marko, stable

If that is the case, then probably a reference to MAINTAINERS should be mentioned in the documentation
because there are a lot more other stuff(beyond PMDs) in DPDK where people can contribute and for that people need to
look into MAINTAINERS anyway.


Hi Akhil,
Thanks for your response. It seems to me though that the MAINTAINER file is not really part of the documentation,
it is more of a reference type of file. Not sure that new DPDK developers will know to look in it for this type of information.

I will send V2 of the patch and add event and bbdev.

Regards,
Rami Rosen


^ permalink raw reply	[flat|nested] 12+ messages in thread
end of thread, other threads:[~2019-04-10 14:50 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-09 17:36 [dpdk-dev] [PATCH] doc: add guideines for initial PMD submission Rami Rosen
2019-04-09 17:36 ` Rami Rosen
2019-04-10 10:06 ` Trahe, Fiona
2019-04-10 10:06   ` Trahe, Fiona
2019-04-10 14:36   ` Rami Rosen
2019-04-10 14:36     ` Rami Rosen
2019-04-10 10:28 Akhil Goyal
2019-04-10 10:28 ` Akhil Goyal
2019-04-10 14:40 ` Rami Rosen
2019-04-10 14:40   ` Rami Rosen
2019-04-10 14:49 Akhil Goyal
2019-04-10 14:49 ` Akhil Goyal

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).