DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Xiaolong Ye <xiaolong.ye@intel.com>,
	dev@dpdk.org, Maxime Coquelin <maxime.coquelin@redhat.com>,
	Tiwei Bie <tiwei.bie@intel.com>,
	Zhihong Wang <zhihong.wang@intel.com>
Cc: xiao.w.wang@intel.com, Rami Rosen <roszenrami@gmail.com>,
	Wang Haiyue <haiyue.wang@intel.com>
Subject: Re: [dpdk-dev] [PATCH v8 1/2] vhost: introduce API to get vDPA device number
Date: Tue, 2 Oct 2018 14:19:59 +0100	[thread overview]
Message-ID: <07075871-63c3-7773-ba89-00155cc7cba7@intel.com> (raw)
In-Reply-To: <20180928214747.48938-2-xiaolong.ye@intel.com>

On 9/28/2018 10:47 PM, Xiaolong Ye wrote:
> It's used to get number of available registered vDPA devices.
> 
> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
> Acked-by: Xiao Wang <xiao.w.wang@intel.com>
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>  lib/librte_vhost/rte_vdpa.h            | 3 +++
>  lib/librte_vhost/rte_vhost_version.map | 1 +
>  lib/librte_vhost/vdpa.c                | 6 ++++++
>  3 files changed, 10 insertions(+)
> 
> diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h
> index 90465ca26..b8223e337 100644
> --- a/lib/librte_vhost/rte_vdpa.h
> +++ b/lib/librte_vhost/rte_vdpa.h
> @@ -84,4 +84,7 @@ rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);
>  struct rte_vdpa_device * __rte_experimental
>  rte_vdpa_get_device(int did);
>  
> +/* Get current available vdpa device number */
> +int __rte_experimental
> +rte_vdpa_get_device_num(void);

Hi Xiaolong,

Is rte_vdpa_get_device_num() an public API? (It should be since it will be used
in an application in next patch.)

If so, header needs to be part of API documentation:
1- Update doc/api/doxy-api-index.md to include this header.
2- Update all APIs comments to be an doxygen comment.
3- Add doxygen comment to all data structures.

I can see rte_vdpa.h not documented at all, it is not just this API, so it can
be better to send a new patch to address above items.

Thanks,
ferruh

  reply	other threads:[~2018-10-02 13:20 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-20 22:28 [dpdk-dev] [PATCH v3 0/2] introduce vdpa sample Xiaolong Ye
2018-09-20 22:28 ` [dpdk-dev] [PATCH v3 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-09-20 22:28 ` [dpdk-dev] [PATCH v3 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-09-21  5:07   ` Wang, Xiao W
2018-09-22 11:04     ` Ye Xiaolong
2018-09-24  8:42 ` [dpdk-dev] [PATCH v4 0/2] introduce vdpa sample Xiaolong Ye
2018-09-24  8:42   ` [dpdk-dev] [PATCH v4 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-09-24  8:42   ` [dpdk-dev] [PATCH v4 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-09-24  4:12     ` Wang, Xiao W
2018-09-24 21:30       ` Ye Xiaolong
2018-09-25 12:07   ` [dpdk-dev] [PATCH v5 0/2] introduce vdpa sample Xiaolong Ye
2018-09-25 12:07     ` [dpdk-dev] [PATCH v5 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-09-25 12:07     ` [dpdk-dev] [PATCH v5 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-09-25  8:32       ` Wang, Xiao W
2018-09-26  9:06     ` [dpdk-dev] [PATCH v6 0/2] introduce vdpa sample Xiaolong Ye
2018-09-26  3:15       ` Wang, Xiao W
2018-09-26  9:06       ` [dpdk-dev] [PATCH v6 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-09-26  9:06       ` [dpdk-dev] [PATCH v6 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-09-27 16:37         ` Maxime Coquelin
2018-09-28  7:32           ` Ye Xiaolong
2018-09-28 11:23       ` [dpdk-dev] [PATCH v7 0/2] introduce vdpa sample Xiaolong Ye
2018-09-28 11:23         ` [dpdk-dev] [PATCH v7 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-09-28 11:23         ` [dpdk-dev] [PATCH v7 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-09-28  7:31           ` Maxime Coquelin
2018-09-28 14:33             ` Ye Xiaolong
2018-09-28  7:49               ` Maxime Coquelin
2018-09-28 15:17                 ` Ye Xiaolong
2018-09-28  8:31                   ` Maxime Coquelin
2018-09-28 17:37                     ` Ye Xiaolong
2018-09-28 21:47         ` [dpdk-dev] [PATCH v8 0/2] introduce vdpa sample Xiaolong Ye
2018-09-28 21:47           ` [dpdk-dev] [PATCH v8 1/2] vhost: introduce API to get vDPA device number Xiaolong Ye
2018-10-02 13:19             ` Ferruh Yigit [this message]
2018-10-03  5:53               ` Ye Xiaolong
2018-09-28 21:47           ` [dpdk-dev] [PATCH v8 2/2] examples/vdpa: introduce a new sample for vDPA Xiaolong Ye
2018-10-02 14:03             ` Ferruh Yigit
2018-10-03  6:04               ` Ye Xiaolong
2018-10-03  7:48                 ` Ferruh Yigit
2019-01-17 14:37             ` Shahaf Shuler
2019-01-17 15:13               ` Ye Xiaolong
2019-01-17 15:17                 ` Shahaf Shuler
2018-10-02 12:51           ` [dpdk-dev] [PATCH v8 0/2] introduce vdpa sample Maxime Coquelin

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=07075871-63c3-7773-ba89-00155cc7cba7@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=dev@dpdk.org \
    --cc=haiyue.wang@intel.com \
    --cc=maxime.coquelin@redhat.com \
    --cc=roszenrami@gmail.com \
    --cc=tiwei.bie@intel.com \
    --cc=xiao.w.wang@intel.com \
    --cc=xiaolong.ye@intel.com \
    --cc=zhihong.wang@intel.com \
    /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).