mbox series

[v3,0/4] Enhance docs on virtio-user as KNI replacement

Message ID 20220610153535.659076-1-bruce.richardson@intel.com (mailing list archive)
Headers
Series Enhance docs on virtio-user as KNI replacement |

Message

Bruce Richardson June 10, 2022, 3:35 p.m. UTC 
  Since use of KNI is no longer advised (due to known issues and the fact
it's an out-of-tree module), virtio-user is recommended for new
developments. To help encourage this, we improve the doc HOWTO section
on using virtio-user and add a link to that document from the main KNI
section in the programmers guide.

v3:
* Added two extra patches:
  - rename document files to match new section name
  - add note to KNI programmers guide section
* minor updates to patch 2, and added stable on CC for that patch

Bruce Richardson (4):
  doc/howto: rework section on virtio-user as exception path
  doc/howto: rename files to match new content name
  doc/howto: add code example to virtio-user exception path doc
  doc/prog_guide: add reference to virtio-user from KNI doc

 ....svg => virtio_user_as_exception_path.svg} |   0
 doc/guides/howto/index.rst                    |   2 +-
 .../howto/virtio_user_as_exception_path.rst   | 214 ++++++++++++++++++
 .../howto/virtio_user_as_exceptional_path.rst | 118 ----------
 .../prog_guide/kernel_nic_interface.rst       |   6 +
 5 files changed, 221 insertions(+), 119 deletions(-)
 rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg => virtio_user_as_exception_path.svg} (100%)
 create mode 100644 doc/guides/howto/virtio_user_as_exception_path.rst
 delete mode 100644 doc/guides/howto/virtio_user_as_exceptional_path.rst

--
2.34.1

Comments

Morten Brørup June 10, 2022, 3:58 p.m. UTC | #1 
> From: Bruce Richardson [mailto:bruce.richardson@intel.com]
> Sent: Friday, 10 June 2022 17.36
> 
> Since use of KNI is no longer advised (due to known issues and the fact
> it's an out-of-tree module), virtio-user is recommended for new
> developments. To help encourage this, we improve the doc HOWTO section
> on using virtio-user and add a link to that document from the main KNI
> section in the programmers guide.
> 
> v3:
> * Added two extra patches:
>   - rename document files to match new section name
>   - add note to KNI programmers guide section
> * minor updates to patch 2, and added stable on CC for that patch
> 
> Bruce Richardson (4):
>   doc/howto: rework section on virtio-user as exception path
>   doc/howto: rename files to match new content name
>   doc/howto: add code example to virtio-user exception path doc
>   doc/prog_guide: add reference to virtio-user from KNI doc
> 
>  ....svg => virtio_user_as_exception_path.svg} |   0
>  doc/guides/howto/index.rst                    |   2 +-
>  .../howto/virtio_user_as_exception_path.rst   | 214 ++++++++++++++++++
>  .../howto/virtio_user_as_exceptional_path.rst | 118 ----------
>  .../prog_guide/kernel_nic_interface.rst       |   6 +
>  5 files changed, 221 insertions(+), 119 deletions(-)
>  rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg =>
> virtio_user_as_exception_path.svg} (100%)
>  create mode 100644 doc/guides/howto/virtio_user_as_exception_path.rst
>  delete mode 100644
> doc/guides/howto/virtio_user_as_exceptional_path.rst
> 
> --
> 2.34.1
> 

Yes.

Series-Acked-by: Morten Brørup <mb@smartsharesystems.com>
Maxime Coquelin July 8, 2022, 9:12 a.m. UTC | #2 
On 6/10/22 17:35, Bruce Richardson wrote:
> Since use of KNI is no longer advised (due to known issues and the fact
> it's an out-of-tree module), virtio-user is recommended for new
> developments. To help encourage this, we improve the doc HOWTO section
> on using virtio-user and add a link to that document from the main KNI
> section in the programmers guide.
> 
> v3:
> * Added two extra patches:
>    - rename document files to match new section name
>    - add note to KNI programmers guide section
> * minor updates to patch 2, and added stable on CC for that patch
> 
> Bruce Richardson (4):
>    doc/howto: rework section on virtio-user as exception path
>    doc/howto: rename files to match new content name
>    doc/howto: add code example to virtio-user exception path doc
>    doc/prog_guide: add reference to virtio-user from KNI doc
> 
>   ....svg => virtio_user_as_exception_path.svg} |   0
>   doc/guides/howto/index.rst                    |   2 +-
>   .../howto/virtio_user_as_exception_path.rst   | 214 ++++++++++++++++++
>   .../howto/virtio_user_as_exceptional_path.rst | 118 ----------
>   .../prog_guide/kernel_nic_interface.rst       |   6 +
>   5 files changed, 221 insertions(+), 119 deletions(-)
>   rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg => virtio_user_as_exception_path.svg} (100%)
>   create mode 100644 doc/guides/howto/virtio_user_as_exception_path.rst
>   delete mode 100644 doc/guides/howto/virtio_user_as_exceptional_path.rst
> 
> --
> 2.34.1
> 

Applied to dpdk-next-virtio/main.

Thanks,
Maxime