diff mbox

VFIO: Fix Documentation

Message ID 36f5940b-cac5-9a4a-86cb-7ad9766d5d62@huawei.com (mailing list archive)
State New, archived
Headers show

Commit Message

Dong Bo April 20, 2018, 10:07 a.m. UTC
From: Dong Bo <dongbo4@huawei.com>

Signed-off-by: Dong Bo <dongbo4@huawei.com>
---
 Documentation/vfio.txt | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Alex Williamson April 30, 2018, 6:38 p.m. UTC | #1
On Fri, 20 Apr 2018 18:07:27 +0800
"dongbo (E)" <dongbo4@huawei.com> wrote:

> From: Dong Bo <dongbo4@huawei.com>
> 
> Signed-off-by: Dong Bo <dongbo4@huawei.com>
> ---

Hi Dong Bo,

The patch is corrupted, please resend and also include a commit log,
something as simple as "Update vfio_add_group_dev description to match
the current API" would be fine.  Thanks,

Alex

>  Documentation/vfio.txt | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/vfio.txt b/Documentation/vfio.txt
> index ef6a511..f1a4d3c 100644
> --- a/Documentation/vfio.txt
> +++ b/Documentation/vfio.txt
> @@ -252,15 +252,14 @@ into VFIO core.  When devices are bound and unbound to the driver,
>  the driver should call vfio_add_group_dev() and vfio_del_group_dev()
>  respectively::
>  -	extern int vfio_add_group_dev(struct iommu_group *iommu_group,
> -	                              struct device *dev,
> +	extern int vfio_add_group_dev(struct device *dev,
>  				      const struct vfio_device_ops *ops,
>  				      void *device_data);
>   	extern void *vfio_del_group_dev(struct device *dev);
>   vfio_add_group_dev() indicates to the core to begin tracking the
> -specified iommu_group and register the specified dev as owned by
> +iommu_group of the specified dev and register the dev as owned by
>  a VFIO bus driver.  The driver provides an ops structure for callbacks
>  similar to a file operations structure::
>  -- 1.9.1
> 
> 
> .
> 
>
Dong Bo May 7, 2018, 3:09 a.m. UTC | #2
Hi, Alex.

On 2018/5/1 2:38, Alex Williamson wrote:
> On Fri, 20 Apr 2018 18:07:27 +0800
> "dongbo (E)" <dongbo4@huawei.com> wrote:
> 
>> From: Dong Bo <dongbo4@huawei.com>
>>
>> Signed-off-by: Dong Bo <dongbo4@huawei.com>
>> ---
> 
> Hi Dong Bo,
> 
> The patch is corrupted, please resend and also include a commit log,
> something as simple as "Update vfio_add_group_dev description to match
> the current API" would be fine.  Thanks,
> 
> Alex
> 
Sorry for the corrupted patch. I've resent one and added the commit log
you suggested. Hope it would apply. Thanks.

Best Regards,
Dong Bo

>>  Documentation/vfio.txt | 5 ++---
>>  1 file changed, 2 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/vfio.txt b/Documentation/vfio.txt
>> index ef6a511..f1a4d3c 100644
>> --- a/Documentation/vfio.txt
>> +++ b/Documentation/vfio.txt
>> @@ -252,15 +252,14 @@ into VFIO core.  When devices are bound and unbound to the driver,
>>  the driver should call vfio_add_group_dev() and vfio_del_group_dev()
>>  respectively::
>>  -	extern int vfio_add_group_dev(struct iommu_group *iommu_group,
>> -	                              struct device *dev,
>> +	extern int vfio_add_group_dev(struct device *dev,
>>  				      const struct vfio_device_ops *ops,
>>  				      void *device_data);
>>   	extern void *vfio_del_group_dev(struct device *dev);
>>   vfio_add_group_dev() indicates to the core to begin tracking the
>> -specified iommu_group and register the specified dev as owned by
>> +iommu_group of the specified dev and register the dev as owned by
>>  a VFIO bus driver.  The driver provides an ops structure for callbacks
>>  similar to a file operations structure::
>>  -- 1.9.1
>>
>>
>> .
>>
>>
> 
> 
> .
>
diff mbox

Patch

diff --git a/Documentation/vfio.txt b/Documentation/vfio.txt
index ef6a511..f1a4d3c 100644
--- a/Documentation/vfio.txt
+++ b/Documentation/vfio.txt
@@ -252,15 +252,14 @@  into VFIO core.  When devices are bound and unbound to the driver,
 the driver should call vfio_add_group_dev() and vfio_del_group_dev()
 respectively::
 -	extern int vfio_add_group_dev(struct iommu_group *iommu_group,
-	                              struct device *dev,
+	extern int vfio_add_group_dev(struct device *dev,
 				      const struct vfio_device_ops *ops,
 				      void *device_data);
  	extern void *vfio_del_group_dev(struct device *dev);
  vfio_add_group_dev() indicates to the core to begin tracking the
-specified iommu_group and register the specified dev as owned by
+iommu_group of the specified dev and register the dev as owned by
 a VFIO bus driver.  The driver provides an ops structure for callbacks
 similar to a file operations structure::
 -- 1.9.1


.