X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Freference%2Fcmdreference%2Fvhost%2Fvhostuser.rst;h=8b34ec6e8fb42ce5639f57d0afa58ffd3f19f1b3;hb=70f28fc4b83fee72a1e2a17f5f898af83b4fb39c;hp=a21c314404c6151ec3eb8a7a000b8d7385168a47;hpb=8a6928938c468639232350bccb0e6c4364fff4c4;p=vpp.git diff --git a/docs/reference/cmdreference/vhost/vhostuser.rst b/docs/reference/cmdreference/vhost/vhostuser.rst index a21c314404c..8b34ec6e8fb 100644 --- a/docs/reference/cmdreference/vhost/vhostuser.rst +++ b/docs/reference/cmdreference/vhost/vhostuser.rst @@ -1,7 +1,9 @@ -.. _vhostusercommands: +.. vhost: .. toctree:: +.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ . + .. _createvhostuser: Create Vhost-User @@ -13,7 +15,7 @@ next free index. There are several parameters associated with a vHost interface: -- **socket ** - Name of the linux socket used by +- **socket <*socket-filename*>** - Name of the linux socket used by hypervisor and VPP to manage the vHost interface. If in '*server*' mode, VPP will create the socket if it does not already exist. If in '*client*' mode, hypervisor will create the socket if it does not @@ -227,10 +229,10 @@ previous example but will include the descriptor table for each queue. The outpu Virtqueue 1 (RX) qsz 256 last_avail_idx 0 last_used_idx 0 - + Debug Vhost-User ================ -Turn on/off debug for vhost +Turn on/off debug for vhost. Summary/Usage @@ -238,8 +240,8 @@ Summary/Usage .. code-block:: shell - debug vhost-user . - + debug vhost-user + Delete Vhost-User ======================== Delete a vHost User interface using the interface name or the software @@ -252,7 +254,7 @@ Summary/Usage .. code-block:: shell - delete vhost-user { | sw_if_index }. + delete vhost-user { | sw_if_index } Examples --------