From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <yuanhan.liu@linux.intel.com>
Received: from mga06.intel.com (mga06.intel.com [134.134.136.31])
 by dpdk.org (Postfix) with ESMTP id F2F5EFB0F
 for <dev@dpdk.org>; Mon, 16 Jan 2017 06:58:02 +0100 (CET)
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
 by orsmga104.jf.intel.com with ESMTP; 15 Jan 2017 21:58:01 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.33,237,1477983600"; d="scan'208";a="213780601"
Received: from yliu-dev.sh.intel.com (HELO yliu-dev) ([10.239.67.162])
 by fmsmga004.fm.intel.com with ESMTP; 15 Jan 2017 21:58:00 -0800
Date: Mon, 16 Jan 2017 14:00:13 +0800
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
Message-ID: <20170116060013.GI9770@yliu-dev.sh.intel.com>
References: <1484309921-116526-1-git-send-email-jianfeng.tan@intel.com>
 <1484309921-116526-9-git-send-email-jianfeng.tan@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1484309921-116526-9-git-send-email-jianfeng.tan@intel.com>
User-Agent: Mutt/1.5.23 (2014-03-12)
Subject: Re: [dpdk-dev] [PATCH v4 8/8] doc: add guide to use virtio_user as
 exceptional path
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 16 Jan 2017 05:58:03 -0000

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