From: Yuanhan Liu <yuanhan.liu@linux.intel.com>
To: Jianfeng Tan <jianfeng.tan@intel.com>
Cc: dev@dpdk.org, ferruh.yigit@intel.com, cunming.liang@intel.com
Subject: Re: [PATCH v4 8/8] doc: add guide to use virtio_user as exceptional path
Date: Mon, 16 Jan 2017 14:00:13 +0800 [thread overview]
Message-ID: <20170116060013.GI9770@yliu-dev.sh.intel.com> (raw)
In-Reply-To: <1484309921-116526-9-git-send-email-jianfeng.tan@intel.com>
On Fri, Jan 13, 2017 at 12:18:41PM +0000, Jianfeng Tan wrote:
> Signed-off-by: Jianfeng Tan <jianfeng.tan@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
next prev parent reply other threads:[~2017-01-16 5:58 UTC|newest]
Thread overview: 73+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-02 14:31 [PATCH 0/3] virtio_user as an alternative exception path Jianfeng Tan
2016-12-02 14:31 ` [PATCH 1/3] net/virtio_user: add vhost layer Jianfeng Tan
2016-12-08 7:21 ` Yuanhan Liu
2016-12-02 14:31 ` [PATCH 2/3] net/virtio_user: add vhost kernel support Jianfeng Tan
2016-12-02 14:31 ` [PATCH 3/3] net/virtio_user: fix wrongly set features Jianfeng Tan
2016-12-08 8:32 ` Yuanhan Liu
2016-12-02 14:44 ` [PATCH 0/3] virtio_user as an alternative exception path Thomas Monjalon
2016-12-23 7:14 ` [PATCH v2 0/7] " Jianfeng Tan
2016-12-23 7:14 ` [PATCH v2 1/7] net/virtio_user: fix wrongly set features Jianfeng Tan
2016-12-23 7:14 ` [PATCH v2 2/7] net/virtio_user: postpone DRIVER OK notification Jianfeng Tan
2016-12-26 6:27 ` Yuanhan Liu
2016-12-26 6:55 ` Tan, Jianfeng
2016-12-26 8:02 ` Yuanhan Liu
2016-12-26 8:26 ` Tan, Jianfeng
2016-12-23 7:14 ` [PATCH v2 3/7] net/virtio_user: move vhost user specific code Jianfeng Tan
2016-12-26 6:28 ` Yuanhan Liu
2016-12-26 6:58 ` Tan, Jianfeng
2016-12-26 7:57 ` Yuanhan Liu
2016-12-29 9:40 ` Tan, Jianfeng
2016-12-23 7:14 ` [PATCH v2 4/7] net/virtio_user: abstract virtio user backend ops Jianfeng Tan
2016-12-26 6:41 ` Yuanhan Liu
2016-12-23 7:14 ` [PATCH v2 5/7] net/virtio_user: add vhost kernel support Jianfeng Tan
2016-12-26 7:44 ` Yuanhan Liu
2017-01-04 7:22 ` Tan, Jianfeng
2017-01-04 7:46 ` Yuanhan Liu
2017-01-09 4:51 ` Jason Wang
2017-01-09 4:39 ` Jason Wang
2017-01-10 6:11 ` Tan, Jianfeng
2017-01-10 8:46 ` Thomas Monjalon
2017-01-10 9:11 ` Tan, Jianfeng
2017-01-11 2:42 ` Jason Wang
2017-01-11 3:13 ` Tan, Jianfeng
2017-01-11 3:23 ` Jason Wang
2017-01-12 9:40 ` Tan, Jianfeng
2017-01-13 2:27 ` Jason Wang
2017-01-11 2:30 ` Tan, Jianfeng
2017-01-11 2:45 ` Jason Wang
2016-12-23 7:14 ` [PATCH v2 6/7] net/virtio_user: enable offloading Jianfeng Tan
2016-12-26 7:53 ` Yuanhan Liu
2016-12-23 7:14 ` [PATCH v2 7/7] net/virtio_user: enable multiqueue with vhost kernel Jianfeng Tan
2017-01-04 3:59 ` [PATCH v3 0/7] virtio_user as an alternative exception path Jianfeng Tan
2017-01-04 3:59 ` [PATCH v3 1/7] net/virtio_user: fix wrongly set features Jianfeng Tan
2017-01-04 3:59 ` [PATCH v3 2/7] net/virtio_user: fix not properly reset device Jianfeng Tan
2017-01-04 5:46 ` Yuanhan Liu
2017-01-04 3:59 ` [PATCH v3 3/7] net/virtio_user: move vhost user specific code Jianfeng Tan
2017-01-04 6:02 ` Yuanhan Liu
2017-01-04 6:46 ` Tan, Jianfeng
2017-01-04 7:08 ` Yuanhan Liu
2017-01-04 3:59 ` [PATCH v3 4/7] net/virtio_user: abstract virtio user backend ops Jianfeng Tan
2017-01-04 6:11 ` Yuanhan Liu
2017-01-04 3:59 ` [PATCH v3 5/7] net/virtio_user: add vhost kernel support Jianfeng Tan
2017-01-04 6:13 ` Yuanhan Liu
2017-01-04 3:59 ` [PATCH v3 6/7] net/virtio_user: enable offloading Jianfeng Tan
2017-01-04 3:59 ` [PATCH v3 7/7] net/virtio_user: enable multiqueue with vhost kernel Jianfeng Tan
2017-01-09 14:06 ` [PATCH v3 0/7] virtio_user as an alternative exception path Bruce Richardson
2017-01-10 8:46 ` Tan, Jianfeng
2017-01-13 12:18 ` [PATCH v4 0/8] " Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 1/8] net/virtio_user: fix wrongly get/set features Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 2/8] net/virtio_user: fix not properly reset device Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 3/8] net/virtio_user: move vhost user specific code Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 4/8] net/virtio_user: abstract virtio user backend ops Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 5/8] net/virtio_user: add vhost kernel support Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 6/8] net/virtio_user: enable offloading Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 7/8] net/virtio_user: enable multiqueue with vhost kernel Jianfeng Tan
2017-01-13 12:18 ` [PATCH v4 8/8] doc: add guide to use virtio_user as exceptional path Jianfeng Tan
2017-01-16 6:00 ` Yuanhan Liu [this message]
2017-01-16 6:04 ` Yuanhan Liu
2017-01-16 9:44 ` Thomas Monjalon
2017-01-16 9:49 ` Yuanhan Liu
2017-01-16 14:45 ` Thomas Monjalon
2017-01-22 0:46 ` Aws Ismail
2017-01-22 7:16 ` Tan, Jianfeng
2017-01-16 15:05 ` [PATCH v4 0/8] virtio_user as an alternative exception path Yuanhan Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170116060013.GI9770@yliu-dev.sh.intel.com \
--to=yuanhan.liu@linux.intel.com \
--cc=cunming.liang@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=jianfeng.tan@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.