On Fri, Jan 13, 2017 at 12:18:41PM +0000, Jianfeng Tan wrote:
> Signed-off-by: Jianfeng Tan <jianfeng....@intel.com>
> ---
> .../img/virtio_user_as_excpetional_path.png | Bin 0 -> 38600 bytes
> doc/guides/prog_guide/index.rst | 1 +
> .../prog_guide/virtio_user_as_exceptional_path.rst | 104
> +++++++++++++++++++++
> 3 files changed, 105 insertions(+)
> create mode 100644
> doc/guides/prog_guide/img/virtio_user_as_excpetional_path.png
> create mode 100644 doc/guides/prog_guide/virtio_user_as_exceptional_path.rst
Doc build fails:
$ make doc-guides-html
sphinx processing guides-html...
/home/yliu/dpdk/doc/guides/prog_guide/index.rst:34: WARNING: toctree
contains reference to nonexisting document
u'prog_guide/virtio_user_as_exception_path'
/home/yliu/dpdk/doc/guides/prog_guide/virtio_user_as_exceptional_path.rst::
WARNING: document isn't included in any toctree
> +Virtio_user as Exceptional Path
> +===============================
> +
> +The virtual device, virtio_user, was originally introduced with vhost-user
> backend, as a high performance solution for IPC (Inter-Process Communication)
> and user space container networking.
Doc should also be well-wrapped, say not execeed 80 chars.
> +Sample Usage
> +------------
> +
> +As a prerequisite, the vhost/vhost-net kernel CONFIG should be chosen before
> compiling the kernel and those kernel modules should be inserted.
> +
> +#. Compile the DPDK and bind a physical NIC (for communicating with
> outside) to igb_uio/uio_pci_generic/vfio-pci.
> +
> +#. Run testpmd:
> +
> + .. code-block:: console
> +
> + examples/kni/build/app/kni -c -0xf0 -n 4 -- -p 0x3 -P
> --config="(0,4,6),(1,5,7)"
^^^
KNI?
Besides, it's more like a howto doc instead of prog guide to me, that
it's better to put it to doc/guides/howto?
--yliu
