DPDK patches and discussions
 help / color / mirror / Atom feed
From: Shreyansh Jain <shreyansh.jain@nxp.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: "john.mcnamara@intel.com" <john.mcnamara@intel.com>,
	"marko.kovacevic@intel.com" <marko.kovacevic@intel.com>,
	Hemant Agrawal <hemant.agrawal@nxp.com>,
	Thomas Monjalon <thomas@monjalon.net>,
	"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for 18.08
Date: Tue, 5 Jun 2018 12:36:00 +0000	[thread overview]
Message-ID: <HE1PR0402MB2780917344FCB3108ADF435890660@HE1PR0402MB2780.eurprd04.prod.outlook.com> (raw)
In-Reply-To: <8b95d8a2-ed37-a9cc-344a-9d769c22ebc1@intel.com>

Hello Ferruh,

> -----Original Message-----
> From: Ferruh Yigit [mailto:ferruh.yigit@intel.com]
> Sent: Tuesday, June 5, 2018 2:34 PM
> To: Thomas Monjalon <thomas@monjalon.net>; dev@dpdk.org
> Cc: john.mcnamara@intel.com; marko.kovacevic@intel.com; Hemant Agrawal
> <hemant.agrawal@nxp.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: add template release notes for
> 18.08
> 
> On 5/31/2018 10:11 PM, Thomas Monjalon wrote:
> > Add template release notes for DPDK 18.08 with inline
> > comments and explanations of the various sections.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> <...>
> 
> > +Shared Library Versions
> > +-----------------------
> > +
> > +.. Update any library version updated in this release
> > +   and prepend with a ``+`` sign, like this:
> > +
> > +     librte_acl.so.2
> > +   + librte_cfgfile.so.2
> > +     librte_cmdline.so.2
> > +
> > +   This section is a comment. Do not overwrite or remove it.
> > +   =========================================================
> > +
> > +The libraries prepended with a plus sign were incremented in this
> version.
> > +
> > +.. code-block:: diff
> > +
> <..>
> > +     librte_bus_dpaa.so.1
> > +     librte_bus_fslmc.so.1
> > +     librte_bus_pci.so.1
> > +     librte_bus_vdev.so.1
> <..>
> > +     librte_common_octeontx.so.1
> <..>
> > +     librte_pmd_dpaa2_cmdif.so.1

cmdif doesn't expose any APIs for the user. It works through the librawdev APIs.

drivers/raw/dpaa2_cmdif/± cat rte_pmd_dpaa2_cmdif_version.map
DPDK_18.05 {

	local: *;
};

> > +     librte_pmd_dpaa2_qdma.so.1

QDMA driver indeed exposes various APIs for the user/application.

> 
> Is above libraries provide any API for user application?
> 
> It looks like they are for other internal libraries, if so should we
> document
> them here in release notes?

You are suggesting that we add a note stating a particular library has no exposed APIs? I can't guess what use that information would be for a release note reader.
That might be a note for the relevant documentation rst file, though.

> 
> Thanks,
> ferruh

  reply	other threads:[~2018-06-05 12:36 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-31 21:11 Thomas Monjalon
2018-06-01  7:40 ` Mcnamara, John
2018-06-01  8:41   ` Thomas Monjalon
2018-06-05  9:04 ` Ferruh Yigit
2018-06-05 12:36   ` Shreyansh Jain [this message]
2018-06-05 13:28     ` Ferruh Yigit
2018-06-06  6:19       ` Shreyansh Jain
2018-06-06 13:28         ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=HE1PR0402MB2780917344FCB3108ADF435890660@HE1PR0402MB2780.eurprd04.prod.outlook.com \
    --to=shreyansh.jain@nxp.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=hemant.agrawal@nxp.com \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).