[dpdk-dev] [PATCH v3] doc: add a restriction to multi-process support

[Junjie Chen]

This patch add a restriction to multi-process support: secondary
processes should only run alongside primary process with same DPDK
version, so that secondary processes can use the same hugepage mmap
layout as primary process.

Signed-off-by: Junjie Chen <junjie.j.chen at intel.com>
---
v3 changes:
 Use 'note' marker to make it clearer.

 doc/guides/prog_guide/multi_proc_support.rst | 4 ++++
 doc/guides/tools/proc_info.rst               | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 9a9dca7fe..4ca3f2c22 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -52,6 +52,10 @@ Standalone DPDK processes are primary processes,
 while secondary processes can only run alongside a primary process or
 after a primary process has already configured the hugepage shared memory for them.
 
+.. note::
+
+    Secondary processes should run alongside primary process with same DPDK version.
+
 To support these two process types, and other multi-process setups described later,
 two additional command-line parameters are available to the EAL:
 
diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index fd17e278c..1b81a7891 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -38,6 +38,10 @@ statistics, resetting port statistics and printing DPDK memory information.
 This application extends the original functionality that was supported by
 dump_cfg.
 
+.. note::
+
+    dpdk-procinfo should run alongside primary process with same DPDK version.
+
 Running the Application
 -----------------------
 The application has a number of command line options:
-- 
2.15.0