eal: update comment about --no-huge option

Message ID 20190717085624.30452-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series eal: update comment about --no-huge option |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Thomas Monjalon July 17, 2019, 8:56 a.m. UTC
  The old comment, on top of the function rte_eal_has_hugepages(),
is really outdated and not generic enough.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/librte_eal/common/include/rte_eal.h | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
  

Comments

Anatoly Burakov July 17, 2019, 12:35 p.m. UTC | #1
On 17-Jul-19 9:56 AM, Thomas Monjalon wrote:
> The old comment, on top of the function rte_eal_has_hugepages(),
> is really outdated and not generic enough.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Thomas Monjalon July 17, 2019, 5:58 p.m. UTC | #2
17/07/2019 14:35, Burakov, Anatoly:
> On 17-Jul-19 9:56 AM, Thomas Monjalon wrote:
> > The old comment, on top of the function rte_eal_has_hugepages(),
> > is really outdated and not generic enough.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>

Applied
  

Patch

diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h
index 34245b053..b7cf91214 100644
--- a/lib/librte_eal/common/include/rte_eal.h
+++ b/lib/librte_eal/common/include/rte_eal.h
@@ -448,10 +448,7 @@  rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 
 /**
  * Whether EAL is using huge pages (disabled by --no-huge option).
- * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
- * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
- * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
- * as 6WIND.
+ * The no-huge mode is not compatible with all drivers or features.
  *
  * @return
  *   Nonzero if hugepages are enabled.