malloc: fix documentation of realloc function
authorAnatoly Burakov <anatoly.burakov@intel.com>
Fri, 22 Feb 2019 15:29:29 +0000 (15:29 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 27 Mar 2019 11:15:04 +0000 (12:15 +0100)
commit929a91e99c22c022342382779f3a06ddaabb2ff5
treeb886259b498b3ddf2d4154609007ac248067a542
parent24aa4f0fba9dfc644d92434f89ca9acab0b51188
malloc: fix documentation of realloc function

The documentation for rte_realloc claims that the resized area
will always reside on the same NUMA node. This is not actually
the case - while *resized* area will be on the same NUMA node,
if resizing the area is not possible, then the memory will be
reallocated using rte_malloc(), which can allocate memory on
another NUMA node, depending on which lcore rte_realloc() was
called from and which NUMA nodes have memory available.

Fix the API doc to match the actual code of rte_realloc().

Fixes: af75078fece3 ("first public release")
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
lib/librte_eal/common/include/rte_malloc.h