[PATCH v2 25/25] doc: add the common and vDPA document

[Chaoyong He]

> On 10/24/2023 3:28 AM, Chaoyong He wrote:
> > Add the document for nfp common library and vDPA PMD.
> >
> 
> Can you please distribute this patch to other patches in set, details below.
> 
> > Signed-off-by: Chaoyong He <chaoyong.he at corigine.com>
> > Reviewed-by: Long Wu <long.wu at corigine.com>
> > Reviewed-by: Peng Zhang <peng.zhang at corigine.com>
> > ---
> >  MAINTAINERS                            |  8 ++++
> >  doc/guides/platform/index.rst          |  1 +
> >  doc/guides/platform/nfp.rst            | 30 ++++++++++++++
> >  doc/guides/rel_notes/release_23_11.rst |  5 +++
> >  doc/guides/vdpadevs/features/nfp.ini   |  8 ++++
> >  doc/guides/vdpadevs/index.rst          |  1 +
> >  doc/guides/vdpadevs/nfp.rst            | 54 ++++++++++++++++++++++++++
> >  7 files changed, 107 insertions(+)
> >  create mode 100644 doc/guides/platform/nfp.rst  create mode 100644
> > doc/guides/vdpadevs/features/nfp.ini
> >  create mode 100644 doc/guides/vdpadevs/nfp.rst
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS index 4083658697..b28cdab54c
> > 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -900,9 +900,11 @@ F: doc/guides/nics/features/nfb.ini
> >
> >  Netronome nfp
> >  M: Chaoyong He <chaoyong.he at corigine.com>
> > +F: drivers/common/nfp/
> >
> 
> This part can go into first patch that introduces common/nfp
> 

Okay.

> >  F: drivers/net/nfp/
> >  F: doc/guides/nics/nfp.rst
> >  F: doc/guides/nics/features/nfp*.ini
> > +F: doc/guides/platform/nfp.rst
> >
> 
> Is a platform guide needed for nfp, it has only net and vdpa at this stage and
> both has its own documentation, for a nic (not a SoC or platform), a platform
> guide seems excessive to me, what do you think to distribute this information
> to net and vdpa documentation of driver?
> 

I will drop this file in the next version, thanks.

> 
> >  NXP dpaa
> >  M: Hemant Agrawal <hemant.agrawal at nxp.com> @@ -1306,6 +1308,12
> @@ F:
> > drivers/vdpa/ifc/
> >  F: doc/guides/vdpadevs/ifc.rst
> >  F: doc/guides/vdpadevs/features/ifcvf.ini
> >
> > +Corigine nfp vDPA
> > +M: Chaoyong He <chaoyong.he at corigine.com>
> > +F: drivers/vdpa/nfp/
> > +F: doc/guides/vpdadevs/nfp.rst
> > +F: doc/guides/vdpadevs/features/nfp.ini
> > +
> 
> Above part can go into patch that introduces vdpa/nfp, like 18/25]
> drivers/vdpa: introduce the NFP vDPA library
> 
> including other vdpa related documentation:
> doc/guides/vdpadevs/features/nfp.ini
> doc/guides/vdpadevs/index.rst
> doc/guides/vdpadevs/nfp.rst

Okay, will do as you said in the next version, thanks.