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 at intel.com>
Signed-off-by: Jingjing Wu <jingjing.wu at intel.com>
---
doc/guides/rel_notes/known_issues.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/doc/guides/rel_notes/known_issues.rst
b/doc/guides/rel_notes/known_issues.rst
index 923a202..8ca2a86 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).
--
2.4.0
