Rename "virtio-net" to "vhost" in the API comments and vhost prog guide.
Signed-off-by: Yuanhan Liu <yuanhan....@linux.intel.com>
Reviewed-by: Maxime Coquelin <maxime.coque...@redhat.com>
---
doc/guides/prog_guide/vhost_lib.rst | 6 +++---
lib/librte_vhost/rte_virtio_net.h | 14 +++++++-------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/guides/prog_guide/vhost_lib.rst
b/doc/guides/prog_guide/vhost_lib.rst
index e6e34f3..88f0591 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -130,12 +130,12 @@ The following is an overview of some key Vhost API
functions:
* ``new_device(int vid)``
- This callback is invoked when a virtio net device becomes ready. ``vid``
- is the virtio net device ID.
+ This callback is invoked when a virtio device becomes ready. ``vid``
+ is the vhost device ID.
* ``destroy_device(int vid)``
- This callback is invoked when a virtio net device shuts down (or when the
+ This callback is invoked when a virtio device shuts down (or when the
vhost connection is broken).
* ``vring_state_changed(int vid, uint16_t queue_id, int enable)``
diff --git a/lib/librte_vhost/rte_virtio_net.h
b/lib/librte_vhost/rte_virtio_net.h
index 26ac35f..845d0fd 100644
--- a/lib/librte_vhost/rte_virtio_net.h
+++ b/lib/librte_vhost/rte_virtio_net.h
@@ -222,7 +222,7 @@ int rte_vhost_driver_callback_register(const char *path,
* is allocated.
*
* @param vid
- * virtio-net device ID
+ * vhost device ID
*
* @return
* The numa node, -1 on failure
@@ -234,11 +234,11 @@ int rte_vhost_driver_callback_register(const char *path,
* Get the number of queues the device supports.
*
* Note this function is deprecated, as it returns a queue pair number,
- * which is virtio-net specific. Instead, rte_vhost_get_vring_num should
+ * which is vhost specific. Instead, rte_vhost_get_vring_num should
* be used.
*
* @param vid
- * virtio-net device ID
+ * vhost device ID
*
* @return
* The number of queues, 0 on failure
@@ -262,7 +262,7 @@ int rte_vhost_driver_callback_register(const char *path,
* file path.
*
* @param vid
- * virtio-net device ID
+ * vhost device ID
* @param buf
* The buffer to stored the queried ifname
* @param len
@@ -277,7 +277,7 @@ int rte_vhost_driver_callback_register(const char *path,
* Get how many avail entries are left in the queue
*
* @param vid
- * virtio-net device ID
+ * vhost device ID
* @param queue_id
* virtio queue index
*
@@ -292,7 +292,7 @@ int rte_vhost_driver_callback_register(const char *path,
* count is returned to indicate the number of packets that were succesfully
* added to the RX queue.
* @param vid
- * virtio-net device ID
+ * vhost device ID
* @param queue_id
* virtio queue index in mq case
* @param pkts
@@ -310,7 +310,7 @@ uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
* construct host mbufs, copies guest buffer content to host mbufs and
* store them in pkts to be processed.
* @param vid
- * virtio-net device
+ * vhost device ID
* @param queue_id
* virtio queue index in mq case
* @param mbuf_pool
--
1.9.0
