[dpdk-dev] mem: fix incorrect doxygen doc regarding memzones
Commit Message
We can free memzones now, so remove incorrect doxygen documentation
stating otherwise.
Fixes: ff909fe21f0a ("mem: introduce memzone freeing")
Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
---
lib/librte_eal/common/include/rte_memzone.h | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Sergio Gonzalez
> Monroy
> Sent: Wednesday, November 18, 2015 3:58 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] mem: fix incorrect doxygen doc regarding
> memzones
>
> We can free memzones now, so remove incorrect doxygen documentation
> stating otherwise.
>
> Fixes: ff909fe21f0a ("mem: introduce memzone freeing")
>
> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
> > We can free memzones now, so remove incorrect doxygen documentation
> > stating otherwise.
> >
> > Fixes: ff909fe21f0a ("mem: introduce memzone freeing")
> >
> > Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
>
> Acked-by: John McNamara <john.mcnamara@intel.com>
Applied, thanks
@@ -100,7 +100,7 @@ struct rte_memzone {
*
* This function reserves some memory and returns a pointer to a
* correctly filled memzone descriptor. If the allocation cannot be
- * done, return NULL. Note: A reserved zone cannot be freed.
+ * done, return NULL.
*
* @param name
* The name of the memzone. If it already exists, the function will
@@ -151,7 +151,6 @@ const struct rte_memzone *rte_memzone_reserve(const char *name,
* boundary, and returns a pointer to a correctly filled memzone
* descriptor. If the allocation cannot be done or if the alignment
* is not a power of 2, returns NULL.
- * Note: A reserved zone cannot be freed.
*
* @param name
* The name of the memzone. If it already exists, the function will
@@ -207,7 +206,6 @@ const struct rte_memzone *rte_memzone_reserve_aligned(const char *name,
* Memory buffer is reserved in a way, that it wouldn't cross specified
* boundary. That implies that requested length should be less or equal
* then boundary.
- * Note: A reserved zone cannot be freed.
*
* @param name
* The name of the memzone. If it already exists, the function will