summaryrefslogtreecommitdiffstats
path: root/doc/guides/prog_guide
diff options
context:
space:
mode:
authorRicardo Salveti <ricardo.salveti@linaro.org>2016-07-25 13:22:22 -0300
committerRicardo Salveti <ricardo.salveti@linaro.org>2016-07-25 13:26:13 -0300
commit5b1ff351aa2d38446487eed6ccd7ace1b654bbe6 (patch)
tree383fc0fb3c0906113cdbdc0268a32479ed8fa038 /doc/guides/prog_guide
parentfe9e0a156b8ec361b633b4d20d2231113f28fa63 (diff)
Imported Upstream version 16.07-rc4
Change-Id: Ic57f6a3726f2dbd1682223648d91310f45705327 Signed-off-by: Ricardo Salveti <ricardo.salveti@linaro.org>
Diffstat (limited to 'doc/guides/prog_guide')
-rw-r--r--doc/guides/prog_guide/dev_kit_build_system.rst14
-rw-r--r--doc/guides/prog_guide/mempool_lib.rst2
-rw-r--r--doc/guides/prog_guide/vhost_lib.rst7
3 files changed, 14 insertions, 9 deletions
diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst
index 18a30104..fa2411f7 100644
--- a/doc/guides/prog_guide/dev_kit_build_system.rst
+++ b/doc/guides/prog_guide/dev_kit_build_system.rst
@@ -309,11 +309,11 @@ Misc
Internally Generated Build Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-``app/pmdinfogen``
+``app/dpdk-pmdinfogen``
-``pmdinfogen`` scans an object (.o) file for various well known symbol names. These
-well known symbol names are defined by various macros and used to export
+``dpdk-pmdinfogen`` scans an object (.o) file for various well known symbol names.
+These well known symbol names are defined by various macros and used to export
important information about hardware support and usage for pmd files. For
instance the macro:
@@ -328,10 +328,10 @@ Creates the following symbol:
static char this_pmd_name0[] __attribute__((used)) = "<name>";
-Which pmdinfogen scans for. Using this information other relevant bits of data
-can be exported from the object file and used to produce a hardware support
-description, that pmdinfogen then encodes into a json formatted string in the
-following format:
+Which ``dpdk-pmdinfogen`` scans for. Using this information other relevant
+bits of data can be exported from the object file and used to produce a
+hardware support description, that ``dpdk-pmdinfogen`` then encodes into a
+json formatted string in the following format:
.. code-block:: c
diff --git a/doc/guides/prog_guide/mempool_lib.rst b/doc/guides/prog_guide/mempool_lib.rst
index 59466752..ffdc1096 100644
--- a/doc/guides/prog_guide/mempool_lib.rst
+++ b/doc/guides/prog_guide/mempool_lib.rst
@@ -141,7 +141,7 @@ management systems and software based memory allocators, to be used with DPDK.
There are two aspects to a mempool handler.
* Adding the code for your new mempool operations (ops). This is achieved by
- adding a new mempool ops code, and using the ``REGISTER_MEMPOOL_OPS`` macro.
+ adding a new mempool ops code, and using the ``MEMPOOL_REGISTER_OPS`` macro.
* Using the new API to call ``rte_mempool_create_empty()`` and
``rte_mempool_set_ops_byname()`` to create a new mempool and specifying which
diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index 14d5e675..6b0c6b26 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -189,7 +189,12 @@ vhost-user implementation has two options:
When the DPDK vhost-user application restarts, DPDK vhost-user will try to
connect to the server again. This is how the "reconnect" feature works.
- Note: the "reconnect" feature requires **QEMU v2.7** (or above).
+ .. Note::
+ * The "reconnect" feature requires **QEMU v2.7** (or above).
+
+ * The vhost supported features must be exactly the same before and
+ after the restart. For example, if TSO is disabled and then enabled,
+ nothing will work and issues undefined might happen.
No matter which mode is used, once a connection is established, DPDK
vhost-user will start receiving and processing vhost messages from QEMU.