[PATCH v2] doc: add a restriction to multi-process support

[PATCH v2] doc: add a restriction to multi-process support

[junjie.j.chen]

From: Junjie Chen <junjie.j.chen@intel.com>

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@intel.com>
---
 doc/guides/prog_guide/multi_proc_support.rst | 1 +
 doc/guides/tools/proc_info.rst               | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 9a9dca7fe..0cd67ae2d 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -51,6 +51,7 @@ For now, there are two types of process specified:
 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.
+And secondary processes should only 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..57c88f2f0 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -36,7 +36,8 @@ The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application
 that runs as a DPDK secondary process and is capable of retrieving port
 statistics, resetting port statistics and printing DPDK memory information.
 This application extends the original functionality that was supported by
-dump_cfg.
+dump_cfg. Note that dpdk-procinfo can only run alongside primary process with
+same DPDK version.
 
 Running the Application
 -----------------------
-- 
2.15.0

[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@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

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

[Mcnamara, John]

> -----Original Message-----
> From: Chen, Junjie J
> Sent: Wednesday, November 29, 2017 5:17 PM
> To: Gonzalez Monroy, Sergio <sergio.gonzalez.monroy@intel.com>; Mcnamara,
> John <john.mcnamara@intel.com>; Tahhan, Maryam <maryam.tahhan@intel.com>;
> dev@dpdk.org
> Cc: Chen, Junjie J <junjie.j.chen@intel.com>
> Subject: [PATCH v3] doc: add a restriction to multi-process support
> 
> 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@intel.com>

Could you mark the previous version of this patch as "Superseded":

http://dpdk.org/dev/patchwork/project/dpdk/list/?submitter=&state=&q=restriction+to+multi-process+support&archive=&delegate=


Otherwise:

Acked-by: John McNamara <john.mcnamara@intel.com>

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

[Chen, Junjie J]

Done!

Cheers
JJ

> -----Original Message-----
> From: Mcnamara, John
> Sent: Tuesday, December 12, 2017 8:41 PM
> To: Chen, Junjie J <junjie.j.chen@intel.com>; Gonzalez Monroy, Sergio
> <sergio.gonzalez.monroy@intel.com>; Tahhan, Maryam
> <maryam.tahhan@intel.com>; dev@dpdk.org
> Subject: RE: [PATCH v3] doc: add a restriction to multi-process support
> 
> 
> 
> > -----Original Message-----
> > From: Chen, Junjie J
> > Sent: Wednesday, November 29, 2017 5:17 PM
> > To: Gonzalez Monroy, Sergio <sergio.gonzalez.monroy@intel.com>;
> > Mcnamara, John <john.mcnamara@intel.com>; Tahhan, Maryam
> > <maryam.tahhan@intel.com>; dev@dpdk.org
> > Cc: Chen, Junjie J <junjie.j.chen@intel.com>
> > Subject: [PATCH v3] doc: add a restriction to multi-process support
> >
> > 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@intel.com>
> 
> Could you mark the previous version of this patch as "Superseded":
> 
> http://dpdk.org/dev/patchwork/project/dpdk/list/?submitter=&state=&q=restri
> ction+to+multi-process+support&archive=&delegate=
> 
> 
> Otherwise:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
> 

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

[Thomas Monjalon]

> > 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@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks