[PATCH] doc: virtio lsc hint

[PATCH] doc: virtio lsc hint

[Zhiyong Yang]

Virtio PMD has already the ability to support link status change(lsc),
but qemu 2.7.0 introduce the capability to detect vhost user
disconnection. So, virtio PMD which works with qemu 2.7.0 and above
can receive lsc when vhost user disconnects. The patch updates doc to
let user know that.

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
---
 doc/guides/nics/virtio.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 4d6a83768..c6f4e0ed2 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -291,6 +291,10 @@ interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
 notification of device configuration changes, especially link status (lsc).
 Interrupt mode is translated into Rx interrupts in the context of DPDK.
 
+Note: Virtio PMD which works with qemu 2.7.0 and above can support to receive lsc from qemu
+when vhost user disconnection happens since qemu 2.7.0 introduces the new capability to detect
+vhost user disconnection.
+
 Prerequisites for Rx interrupts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.13.3

Re: [PATCH] doc: virtio lsc hint

[Yuanhan Liu]

On Mon, Oct 09, 2017 at 11:56:16AM +0800, Zhiyong Yang wrote:
> Virtio PMD has already the ability to support link status change(lsc),
> but qemu 2.7.0 introduce the capability to detect vhost user
> disconnection. So, virtio PMD which works with qemu 2.7.0 and above
> can receive lsc when vhost user disconnects. The patch updates doc to
> let user know that.

Thanks for updating the doc.

> 
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> ---
>  doc/guides/nics/virtio.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index 4d6a83768..c6f4e0ed2 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -291,6 +291,10 @@ interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
>  notification of device configuration changes, especially link status (lsc).
>  Interrupt mode is translated into Rx interrupts in the context of DPDK.
>  
> +Note: Virtio PMD which works with qemu 2.7.0 and above can support to receive lsc from qemu
> +when vhost user disconnection happens since qemu 2.7.0 introduces the new capability to detect
> +vhost user disconnection.

I think it needs rewording. Also, use ".. Note::" mark for notes.

	--yliu
> +
>  Prerequisites for Rx interrupts
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -- 
> 2.13.3

[PATCH v2] doc: add virtio lsc note

[Zhiyong Yang]

Virtio PMD has already supported link status change(lsc), but VM which
must be created by qemu 2.7.0 and above can support it when vhost
user disconnects, since the capability to detect vhost user disconnection
is introduced in qemu 2.7.0. The patch updates doc to let user know that.

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
---

Changes in v2:
reword the doc and commit log.

 doc/guides/nics/virtio.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 4d6a83768..abf42dff5 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -291,6 +291,11 @@ interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
 notification of device configuration changes, especially link status (lsc).
 Interrupt mode is translated into Rx interrupts in the context of DPDK.
 
+.. Note:: Virtio PMD has already supported to receive lsc from qemu when link
+status changes, especially when vhost user disconnects, but it fails to do that if VM
+is created by qemu 2.6.2 or below, since the capability to detect vhost user
+disconnection is introduced in qemu 2.7.0.
+
 Prerequisites for Rx interrupts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.13.3

Re: [PATCH v2] doc: add virtio lsc note

[Mcnamara, John]

> -----Original Message-----
> From: Yang, Zhiyong
> Sent: Tuesday, October 10, 2017 5:51 AM
> To: dev@dpdk.org
> Cc: yliu@fridaylinux.org; Mcnamara, John <john.mcnamara@intel.com>; Yigit,
> Ferruh <ferruh.yigit@intel.com>; Yang, Zhiyong <zhiyong.yang@intel.com>
> Subject: [PATCH v2] doc: add virtio lsc note
> 
> Virtio PMD has already supported link status change(lsc), but VM which
> must be created by qemu 2.7.0 and above can support it when vhost user
> disconnects, since the capability to detect vhost user disconnection is
> introduced in qemu 2.7.0. The patch updates doc to let user know that.
> 
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> ---
> 
> Changes in v2:
> reword the doc and commit log.
> 
>  doc/guides/nics/virtio.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst index
> 4d6a83768..abf42dff5 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -291,6 +291,11 @@ interrupt, Rx interrupts, and Tx interrupts. Config
> interrupt is used for  notification of device configuration changes,
> especially link status (lsc).
>  Interrupt mode is translated into Rx interrupts in the context of DPDK.
> 
> +.. Note:: Virtio PMD has already supported to receive lsc from qemu
> +when link status changes, especially when vhost user disconnects, but
> +it fails to do that if VM is created by qemu 2.6.2 or below, since the
> +capability to detect vhost user disconnection is introduced in qemu


Hi,

If you are using the Note: directive the text needs to be separated by a
blank line and also indented. Otherwise it throws a doc build warning.

I'd suggest something like this with some minor changes to the text
included:

.. Note::

   Virtio PMD already has support for receiving lsc from qemu when the link
   status changes, especially when vhost user disconnects. However, it fails
   to do that if the VM is created by qemu 2.6.2 or below, since the
   capability to detect vhost user disconnection is introduced in qemu 2.7.0.

Reviewed-by: John McNamara <john.mcnamara@intel.com>

John

[PATCH v3] doc: add virtio lsc note

[Zhiyong Yang]

Virtio PMD already has supported link status change(lsc), but VM which
must be created by qemu 2.7.0 and above can support it when vhost
user disconnects, since the capability to detect vhost user disconnection
is introduced in qemu 2.7.0. The patch updates doc to let user know that.

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Reviewed-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/nics/virtio.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Changes in v3:
Add a blank line and indent, and text is minor changed according to John's
comments.

Changes in v2:
reword the doc and commit log.

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 4d6a83768..af82f86e4 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -291,6 +291,13 @@ interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
 notification of device configuration changes, especially link status (lsc).
 Interrupt mode is translated into Rx interrupts in the context of DPDK.
 
+.. Note::
+
+   Virtio PMD already has support for receiving lsc from qemu when the link
+   status changes, especially when vhost user disconnects. However, it fails
+   to do that if the VM is created by qemu 2.6.2 or below, since the
+   capability to detect vhost user disconnection is introduced in qemu 2.7.0.
+
 Prerequisites for Rx interrupts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.13.3

Re: [PATCH v3] doc: add virtio lsc note

[Mcnamara, John]

> -----Original Message-----
> From: Yang, Zhiyong
> Sent: Monday, October 16, 2017 6:41 AM
> To: dev@dpdk.org
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; yliu@fridaylinux.org;
> Mcnamara, John <john.mcnamara@intel.com>; Yang, Zhiyong
> <zhiyong.yang@intel.com>
> Subject: [PATCH v3] doc: add virtio lsc note
> 
> Virtio PMD already has supported link status change(lsc), but VM which
> must be created by qemu 2.7.0 and above can support it when vhost user
> disconnects, since the capability to detect vhost user disconnection is
> introduced in qemu 2.7.0. The patch updates doc to let user know that.
> 
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> Reviewed-by: John McNamara <john.mcnamara@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v3] doc: add virtio lsc note

[Yuanhan Liu]

On Mon, Oct 16, 2017 at 07:10:24PM +0000, Mcnamara, John wrote:
> 
> 
> > -----Original Message-----
> > From: Yang, Zhiyong
> > Sent: Monday, October 16, 2017 6:41 AM
> > To: dev@dpdk.org
> > Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; yliu@fridaylinux.org;
> > Mcnamara, John <john.mcnamara@intel.com>; Yang, Zhiyong
> > <zhiyong.yang@intel.com>
> > Subject: [PATCH v3] doc: add virtio lsc note
> > 
> > Virtio PMD already has supported link status change(lsc), but VM which
> > must be created by qemu 2.7.0 and above can support it when vhost user
> > disconnects, since the capability to detect vhost user disconnection is
> > introduced in qemu 2.7.0. The patch updates doc to let user know that.
> > 
> > Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> > Reviewed-by: John McNamara <john.mcnamara@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
> 

Applied to dpdk-next-virtio.

Thanks.

	--yliu