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

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Jingjing Wu
> Sent: Friday, May 13, 2016 6:15 AM
> To: david.marchand at 6wind.com
> Cc: dev at dpdk.org; Wu, Jingjing <jingjing.wu at intel.com>; Yang, Ziye
> <ziye.yang at intel.com>; Richardson, Bruce <bruce.richardson at 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 at intel.com>
> Signed-off-by: Jingjing Wu <jingjing.wu at 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).