[1/5] eal: remove comment about old partition option

Message ID 20201022220525.1532249-2-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series cleanup comments and logs about config options |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon Oct. 22, 2020, 10:05 p.m. UTC
  The main initialization function (rte_eal_init) has documentation
about a feature from another era: memory partition.

Curiously, this lost treasure is found only now,
suggesting there may be other interesting things to discover in the doc.
To all aspiring Indiana Jones: the hunt is open!

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

Comments

Burakov, Anatoly Oct. 28, 2020, 12:08 p.m. UTC | #1
On 22-Oct-20 11:05 PM, Thomas Monjalon wrote:
> The main initialization function (rte_eal_init) has documentation
> about a feature from another era: memory partition.
> 
> Curiously, this lost treasure is found only now,
> suggesting there may be other interesting things to discover in the doc.
> To all aspiring Indiana Jones: the hunt is open!
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  

Patch

diff --git a/lib/librte_eal/include/rte_eal.h b/lib/librte_eal/include/rte_eal.h
index 0ae12cf4fb..eaf6469e50 100644
--- a/lib/librte_eal/include/rte_eal.h
+++ b/lib/librte_eal/include/rte_eal.h
@@ -67,16 +67,8 @@  int rte_eal_iopl_init(void);
  *
  * This function is to be executed on the MAIN lcore only, as soon
  * as possible in the application's main() function.
- *
- * The function finishes the initialization process before main() is called.
  * It puts the WORKER lcores in the WAIT state.
  *
- * When the multi-partition feature is supported, depending on the
- * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
- * function waits to ensure that the magic number is set before
- * returning. See also the rte_eal_get_configuration() function. Note:
- * This behavior may change in the future.
- *
  * @param argc
  *   A non-negative value.  If it is greater than 0, the array members
  *   for argv[0] through argv[argc] (non-inclusive) shall contain pointers