diff mbox series

[v18,2/2] Documentation: add debugfs description for vfio

Message ID	20231028075447.41939-3-liulongfang@huawei.com
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) client-ip=23.128.96.34; From: Longfang Liu <liulongfang@huawei.com> To: <alex.williamson@redhat.com>, <jgg@nvidia.com>, <shameerali.kolothum.thodi@huawei.com>, <jonathan.cameron@huawei.com> CC: <bcreeley@amd.com>, <kvm@vger.kernel.org>, <linux-kernel@vger.kernel.org>, <linuxarm@openeuler.org>, <liulongfang@huawei.com> Subject: [PATCH v18 2/2] Documentation: add debugfs description for vfio Date: Sat, 28 Oct 2023 15:54:47 +0800 Message-ID: <20231028075447.41939-3-liulongfang@huawei.com> In-Reply-To: <20231028075447.41939-1-liulongfang@huawei.com> References: <20231028075447.41939-1-liulongfang@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7BIT Content-Type: text/plain; charset=US-ASCII Precedence: bulk
Series	[v18,1/2] vfio/migration: Add debugfs to live migration driver \| [v18,1/2] vfio/migration: Add debugfs to live migration driver [v18,2/2] Documentation: add debugfs description for vfio

Commit Message

liulongfang Oct. 28, 2023, 7:54 a.m. UTC

  1.Add an debugfs document description file to help users understand
how to use the accelerator live migration driver's debugfs.
2.Update the file paths that need to be maintained in MAINTAINERS

Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
 Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++
 MAINTAINERS                            |  1 +
 2 files changed, 26 insertions(+)
 create mode 100644 Documentation/ABI/testing/debugfs-vfio

Comments

Cédric Le Goater Oct. 30, 2023, 6:51 a.m. UTC | #1

On 10/28/23 09:54, Longfang Liu wrote:
> 1.Add an debugfs document description file to help users understand
> how to use the accelerator live migration driver's debugfs.
> 2.Update the file paths that need to be maintained in MAINTAINERS

Should we have 2 patches instead ?

Anyhow,

Reviewed-by: Cédric Le Goater <clg@redhat.com>

Thanks,

C.


> 
> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
> ---
>   Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++
>   MAINTAINERS                            |  1 +
>   2 files changed, 26 insertions(+)
>   create mode 100644 Documentation/ABI/testing/debugfs-vfio
> 
> diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
> new file mode 100644
> index 000000000000..445e9f58f924
> --- /dev/null
> +++ b/Documentation/ABI/testing/debugfs-vfio
> @@ -0,0 +1,25 @@
> +What:		/sys/kernel/debug/vfio
> +Date:		Oct 2023
> +KernelVersion:  6.7
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	This debugfs file directory is used for debugging
> +		of vfio devices, it's a common directory for all vfio devices.
> +		Vfio core will create a device subdirectory under this
> +		directory.
> +
> +What:		/sys/kernel/debug/vfio/<device>/migration
> +Date:		Oct 2023
> +KernelVersion:  6.7
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	This debugfs file directory is used for debugging
> +		of vfio devices that support live migration.
> +		The debugfs of each vfio device that supports live migration
> +		could be created under this directory.
> +
> +What:		/sys/kernel/debug/vfio/<device>/migration/state
> +Date:		Oct 2023
> +KernelVersion:  6.7
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	Read the live migration status of the vfio device.
> +		The contents of the state file reflects the migration state
> +		relative to those defined in the vfio_device_mig_state enum
> diff --git a/MAINTAINERS b/MAINTAINERS
> index b19995690904..a6be3b4219c7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -22591,6 +22591,7 @@ L:	kvm@vger.kernel.org
>   S:	Maintained
>   T:	git https://github.com/awilliam/linux-vfio.git
>   F:	Documentation/ABI/testing/sysfs-devices-vfio-dev
> +F:	Documentation/ABI/testing/debugfs-vfio
>   F:	Documentation/driver-api/vfio.rst
>   F:	drivers/vfio/
>   F:	include/linux/vfio.h

Cédric Le Goater Oct. 30, 2023, 6:18 p.m. UTC | #2

On 10/28/23 09:54, Longfang Liu wrote:
> 1.Add an debugfs document description file to help users understand
> how to use the accelerator live migration driver's debugfs.
> 2.Update the file paths that need to be maintained in MAINTAINERS
> 
> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
> ---
>   Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++
>   MAINTAINERS                            |  1 +
>   2 files changed, 26 insertions(+)
>   create mode 100644 Documentation/ABI/testing/debugfs-vfio
> 
> diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
> new file mode 100644
> index 000000000000..445e9f58f924
> --- /dev/null
> +++ b/Documentation/ABI/testing/debugfs-vfio
> @@ -0,0 +1,25 @@
> +What:		/sys/kernel/debug/vfio
> +Date:		Oct 2023
> +KernelVersion:  6.7

I think the KernelVersion lines should be using tabs and not white spaces.

Thanks,

C.





> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	This debugfs file directory is used for debugging
> +		of vfio devices, it's a common directory for all vfio devices.
> +		Vfio core will create a device subdirectory under this
> +		directory.
> +
> +What:		/sys/kernel/debug/vfio/<device>/migration
> +Date:		Oct 2023
> +KernelVersion:  6.7
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	This debugfs file directory is used for debugging
> +		of vfio devices that support live migration.
> +		The debugfs of each vfio device that supports live migration
> +		could be created under this directory.
> +
> +What:		/sys/kernel/debug/vfio/<device>/migration/state
> +Date:		Oct 2023
> +KernelVersion:  6.7
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	Read the live migration status of the vfio device.
> +		The contents of the state file reflects the migration state
> +		relative to those defined in the vfio_device_mig_state enum
> diff --git a/MAINTAINERS b/MAINTAINERS
> index b19995690904..a6be3b4219c7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -22591,6 +22591,7 @@ L:	kvm@vger.kernel.org
>   S:	Maintained
>   T:	git https://github.com/awilliam/linux-vfio.git
>   F:	Documentation/ABI/testing/sysfs-devices-vfio-dev
> +F:	Documentation/ABI/testing/debugfs-vfio
>   F:	Documentation/driver-api/vfio.rst
>   F:	drivers/vfio/
>   F:	include/linux/vfio.h

liulongfang Nov. 6, 2023, 6:28 a.m. UTC | #3

On 2023/10/30 14:51, Cédric Le Goater write:
> On 10/28/23 09:54, Longfang Liu wrote:
>> 1.Add an debugfs document description file to help users understand
>> how to use the accelerator live migration driver's debugfs.
>> 2.Update the file paths that need to be maintained in MAINTAINERS
> 
> Should we have 2 patches instead ?
>

It is also good to add a separate patch.

Thanks,
Longfang.

> Anyhow,
> 
> Reviewed-by: Cédric Le Goater <clg@redhat.com>
> 
> Thanks,
> 
> C.
> 
> 
>>
>> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
>> ---
>>   Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++
>>   MAINTAINERS                            |  1 +
>>   2 files changed, 26 insertions(+)
>>   create mode 100644 Documentation/ABI/testing/debugfs-vfio
>>
>> diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
>> new file mode 100644
>> index 000000000000..445e9f58f924
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/debugfs-vfio
>> @@ -0,0 +1,25 @@
>> +What:        /sys/kernel/debug/vfio
>> +Date:        Oct 2023
>> +KernelVersion:  6.7
>> +Contact:    Longfang Liu <liulongfang@huawei.com>
>> +Description:    This debugfs file directory is used for debugging
>> +        of vfio devices, it's a common directory for all vfio devices.
>> +        Vfio core will create a device subdirectory under this
>> +        directory.
>> +
>> +What:        /sys/kernel/debug/vfio/<device>/migration
>> +Date:        Oct 2023
>> +KernelVersion:  6.7
>> +Contact:    Longfang Liu <liulongfang@huawei.com>
>> +Description:    This debugfs file directory is used for debugging
>> +        of vfio devices that support live migration.
>> +        The debugfs of each vfio device that supports live migration
>> +        could be created under this directory.
>> +
>> +What:        /sys/kernel/debug/vfio/<device>/migration/state
>> +Date:        Oct 2023
>> +KernelVersion:  6.7
>> +Contact:    Longfang Liu <liulongfang@huawei.com>
>> +Description:    Read the live migration status of the vfio device.
>> +        The contents of the state file reflects the migration state
>> +        relative to those defined in the vfio_device_mig_state enum
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index b19995690904..a6be3b4219c7 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -22591,6 +22591,7 @@ L:    kvm@vger.kernel.org
>>   S:    Maintained
>>   T:    git https://github.com/awilliam/linux-vfio.git
>>   F:    Documentation/ABI/testing/sysfs-devices-vfio-dev
>> +F:    Documentation/ABI/testing/debugfs-vfio
>>   F:    Documentation/driver-api/vfio.rst
>>   F:    drivers/vfio/
>>   F:    include/linux/vfio.h
> 
> .
>

diff mbox series

Patch

diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
new file mode 100644
index 000000000000..445e9f58f924
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-vfio
@@ -0,0 +1,25 @@ 
+What:		/sys/kernel/debug/vfio
+Date:		Oct 2023
+KernelVersion:  6.7
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	This debugfs file directory is used for debugging
+		of vfio devices, it's a common directory for all vfio devices.
+		Vfio core will create a device subdirectory under this
+		directory.
+
+What:		/sys/kernel/debug/vfio/<device>/migration
+Date:		Oct 2023
+KernelVersion:  6.7
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	This debugfs file directory is used for debugging
+		of vfio devices that support live migration.
+		The debugfs of each vfio device that supports live migration
+		could be created under this directory.
+
+What:		/sys/kernel/debug/vfio/<device>/migration/state
+Date:		Oct 2023
+KernelVersion:  6.7
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	Read the live migration status of the vfio device.
+		The contents of the state file reflects the migration state
+		relative to those defined in the vfio_device_mig_state enum
diff --git a/MAINTAINERS b/MAINTAINERS
index b19995690904..a6be3b4219c7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -22591,6 +22591,7 @@  L:	kvm@vger.kernel.org
 S:	Maintained
 T:	git https://github.com/awilliam/linux-vfio.git
 F:	Documentation/ABI/testing/sysfs-devices-vfio-dev
+F:	Documentation/ABI/testing/debugfs-vfio
 F:	Documentation/driver-api/vfio.rst
 F:	drivers/vfio/
 F:	include/linux/vfio.h