diff mbox

[dpdk-dev] doc: known issue on EAL argv

Message ID 1463116489-31805-1-git-send-email-jingjing.wu@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Thomas Monjalon
Headers

Commit Message

Jingjing Wu May 13, 2016, 5:14 a.m. UTC 
  This patch docs the issue on EAL argument that the last EAL
argument is replaced by program name in argv[].

Reported-by: Ziye Yang <ziye.yang@intel.com>
Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
 doc/guides/rel_notes/known_issues.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Comments

John McNamara May 16, 2016, 1:01 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jingjing Wu
> Sent: Friday, May 13, 2016 6:15 AM
> To: david.marchand@6wind.com
> Cc: dev@dpdk.org; Wu, Jingjing <jingjing.wu@intel.com>; Yang, Ziye
> <ziye.yang@intel.com>; Richardson, Bruce <bruce.richardson@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: known issue on EAL argv
> 
> This patch docs the issue on EAL argument that the last EAL argument is
> replaced by program name in argv[].
> 
> Reported-by: Ziye Yang <ziye.yang@intel.com>
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>


Hi Ziye,


The title would be better as "doc: add known issue with EAL argv"


Also, below are some suggested changes to the docs in the patch:




The last EAL argument is replaced by the program name in argv[]
---------------------------------------------------------------

**Description**:
   The last EAL argument is replaced by the program name in ``argv[]`` after ``eal_parse_args()`` is called.
   This is the intended behavior but it causes the pointer to the last EAL argument to be lost.

**Implication**:
  If the last EAL argument in ``argv[]`` is generated by a malloc function, changing it will cause memory
  issues when freeing the argument.

**Resolution/Workaround**:
   An application should not consider the value in ``argv[]`` as unchanged.

**Affected Environment/Platform**:
   All.

**Driver/Module**:
   Environment Abstraction Layer (EAL).
diff mbox

Patch

diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index 923a202..9f03733 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -618,3 +618,22 @@  DPDK may not build on some Intel CPUs using clang < 3.7.0
 
 **Driver/Module**:
    Environment Abstraction Layer (EAL).
+
+
+The last EAL argument is replaced by program name in argv[]
+-----------------------------------------------------------
+
+**Description**:
+   The last EAL argument will be replaced by program name in argv[] after eal_parse_args, and it causes the pointer to the last EAL argument lost.
+
+**Implication**:
+  If the last EAL argument in argv is generated by malloc function, changing it will cause memory issues when free the argument.
+
+**Resolution/Workaround**:
+   Application should not consider the value in argv[] as unchanged.
+
+**Affected Environment/Platform**:
+   ALL.
+
+**Driver/Module**:
+   Environment Abstraction Layer (EAL).