From cb0435574381463be22c8f247a99310cdf7615ec Mon Sep 17 00:00:00 2001 From: Yuanhan Liu Date: Sat, 1 Apr 2017 15:22:53 +0800 Subject: [PATCH] vhost: rename virtio-net to vhost Rename "virtio-net" to "vhost" in the API comments and vhost prog guide. Signed-off-by: Yuanhan Liu Reviewed-by: Maxime Coquelin --- 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 e6e34f30db..88f0591bb2 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 58f79a1b60..78828cdd8c 100644 --- a/lib/librte_vhost/rte_virtio_net.h +++ b/lib/librte_vhost/rte_virtio_net.h @@ -228,7 +228,7 @@ int rte_vhost_get_mtu(int vid, uint16_t *mtu); * is allocated. * * @param vid - * virtio-net device ID + * vhost device ID * * @return * The numa node, -1 on failure @@ -240,11 +240,11 @@ int rte_vhost_get_numa_node(int vid); * 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 @@ -268,7 +268,7 @@ uint16_t rte_vhost_get_vring_num(int vid); * file path. * * @param vid - * virtio-net device ID + * vhost device ID * @param buf * The buffer to stored the queried ifname * @param len @@ -283,7 +283,7 @@ int rte_vhost_get_ifname(int vid, char *buf, size_t len); * 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 * @@ -298,7 +298,7 @@ uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id); * 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 @@ -316,7 +316,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 -- 2.20.1