From: Jingjing Wu <jingjing.wu@intel.com>
Date: Mon, 23 May 2016 14:24:54 +0000 (+0800)
Subject: doc: add known issue in EAL argument parsing
X-Git-Tag: spdx-start~6761
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=15a66c01d8f09a837cd67e74f1c8b4b2a11ea87d;p=dpdk.git

doc: add known issue in EAL argument parsing

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

diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index 923a202df5..e464eca9ac 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -618,3 +618,24 @@ 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 the program name in argv[]
+---------------------------------------------------------------
+
+**Description**:
+   The last EAL argument is replaced by 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).