From: "Xia, Chenbo" <chenbo.xia@intel.com>
To: "Burakov, Anatoly" <anatoly.burakov@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "stable@dpdk.org" <stable@dpdk.org>
Subject: Re: [dpdk-dev] [dpdk-stable] [PATCH v3 3/4] vfio: fix documentation to match intended behavior
Date: Fri, 5 Nov 2021 02:57:07 +0000 [thread overview]
Message-ID: <SN6PR11MB350465C803BDD453D309C9AE9C8E9@SN6PR11MB3504.namprd11.prod.outlook.com> (raw)
In-Reply-To: <9802c552ddd70f0d9b751ea567804bcaf0b7f0bd.1635430513.git.anatoly.burakov@intel.com>
> -----Original Message-----
> From: stable <stable-bounces@dpdk.org> On Behalf Of Anatoly Burakov
> Sent: Thursday, October 28, 2021 10:15 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: [dpdk-stable] [PATCH v3 3/4] vfio: fix documentation to match
> intended behavior
>
> On FreeBSD, `rte_vfio_is_enabled()` and `rte_vfio_noiommu_is_enabled()`
> API calls will not return error, and will instead return 0. This is
> intentional, because the caller of this API does not care whether VFIO
> is supported at all, and will instead be interested in whether VFIO is
> enabled or not. However, the doxygen comments for these functions state
> that they will return an error on FreeBSD, which is incorrect.
>
> Fix the doxygen comment to call out the fact that these
> functions are only relevant on Linux, but remove the reference to
> returning errors.
>
Fix tag?
With above fixed:
Acked-by: Chenbo Xia <chenbo.xia@intel.com>
> Cc: stable@dpdk.org
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
> lib/eal/include/rte_vfio.h | 6 ++----
> 1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/lib/eal/include/rte_vfio.h b/lib/eal/include/rte_vfio.h
> index 2d90b36480..7bdb8932b2 100644
> --- a/lib/eal/include/rte_vfio.h
> +++ b/lib/eal/include/rte_vfio.h
> @@ -150,8 +150,7 @@ int rte_vfio_enable(const char *modname);
> /**
> * Check whether a VFIO-related kmod is enabled.
> *
> - * This function is only relevant to linux and will return
> - * an error on BSD.
> + * This function is only relevant to Linux.
> *
> * @param modname
> * kernel module name.
> @@ -165,8 +164,7 @@ int rte_vfio_is_enabled(const char *modname);
> /**
> * Whether VFIO NOIOMMU mode is enabled.
> *
> - * This function is only relevant to linux and will return
> - * an error on BSD.
> + * This function is only relevant to Linux.
> *
> * @return
> * 1 if true.
> --
> 2.25.1
next prev parent reply other threads:[~2021-11-05 2:57 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-16 10:36 [dpdk-dev] [PATCH v1 1/2] vfio: make API return values consistent Anatoly Burakov
2021-09-16 10:36 ` [dpdk-dev] [PATCH v1 2/2] vfio: add errno on unsupported platforms Anatoly Burakov
2021-09-16 10:39 ` Bruce Richardson
2021-09-22 3:31 ` Xia, Chenbo
2021-09-22 3:30 ` [dpdk-dev] [PATCH v1 1/2] vfio: make API return values consistent Xia, Chenbo
2021-09-22 9:26 ` Ferruh Yigit
2021-09-22 11:30 ` Xia, Chenbo
2021-10-28 8:21 ` David Marchand
2021-10-28 10:29 ` Burakov, Anatoly
2021-10-28 11:11 ` Xia, Chenbo
2021-10-28 11:32 ` Ferruh Yigit
2021-10-28 13:00 ` Burakov, Anatoly
2021-10-28 14:53 ` Thomas Monjalon
2021-10-28 15:40 ` Burakov, Anatoly
2021-10-28 16:38 ` Stephen Hemminger
2021-10-28 13:49 ` [dpdk-dev] [PATCH v2 1/4] vfio: drop fallback Linux implementation Anatoly Burakov
2021-10-28 13:49 ` [dpdk-dev] [PATCH v2 2/4] vfio: fix wrong return value for FreeBSD Anatoly Burakov
2021-10-28 13:49 ` [dpdk-dev] [PATCH v2 3/4] vfio: fix documentation to match intended behavior Anatoly Burakov
2021-10-28 13:49 ` [dpdk-dev] [PATCH v2 4/4] vfio: add errno on unsupported platforms Anatoly Burakov
2021-10-28 14:13 ` Burakov, Anatoly
2021-10-28 14:15 ` [dpdk-dev] [PATCH v3 1/4] vfio: drop fallback Linux implementation Anatoly Burakov
2021-10-28 14:15 ` [dpdk-dev] [PATCH v3 2/4] vfio: fix wrong return value for FreeBSD Anatoly Burakov
2021-11-05 2:50 ` Xia, Chenbo
2021-10-28 14:15 ` [dpdk-dev] [PATCH v3 3/4] vfio: fix documentation to match intended behavior Anatoly Burakov
2021-11-05 2:57 ` Xia, Chenbo [this message]
2021-10-28 14:15 ` [dpdk-dev] [PATCH v3 4/4] vfio: add errno on unsupported platforms Anatoly Burakov
2021-11-08 15:55 ` [dpdk-dev] [dpdk-stable] " David Marchand
2021-11-01 6:27 ` [dpdk-dev] [PATCH v3 1/4] vfio: drop fallback Linux implementation Xia, Chenbo
2021-11-01 13:57 ` Burakov, Anatoly
2021-11-05 2:48 ` Xia, Chenbo
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=SN6PR11MB350465C803BDD453D309C9AE9C8E9@SN6PR11MB3504.namprd11.prod.outlook.com \
--to=chenbo.xia@intel.com \
--cc=anatoly.burakov@intel.com \
--cc=dev@dpdk.org \
--cc=stable@dpdk.org \
/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).