[dpdk-dev] doc: add deprecation notice for physmem layout function

Message ID c23b5df92836eff343ea6af532fabb8529914b6f.1516208579.git.anatoly.burakov@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Burakov, Anatoly Jan. 17, 2018, 5:17 p.m. UTC
  Due to coming changes outlined in memory hotplug RFC, that
function will no longer serve any meaningful purpose.

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

Notes:
    Patch outlining future changes:
    http://dpdk.org/dev/patchwork/patch/32467/

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Burakov, Anatoly Jan. 18, 2018, 9:55 a.m. UTC | #1
On 17-Jan-18 5:17 PM, Anatoly Burakov wrote:
> Due to coming changes outlined in memory hotplug RFC, that
> function will no longer serve any meaningful purpose.
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
> 
> Notes:
>      Patch outlining future changes:
>      http://dpdk.org/dev/patchwork/patch/32467/

That patch also changes rte_mem_config, which may or may not be part of 
public API, but people may rely on it anyway. Will add in v2, and also 
cover other structures' changes.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 13e8543..28f217d 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,6 +8,10 @@  API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* eal: due to internal data layoyut reorganization, function
+  ``rte_eal_get_physmem_layout`` will be deprecated in v18.05 and removed in
+  subsequent releases.
+
 * eal: several API and ABI changes are planned for ``rte_devargs`` in v18.02.
   The format of device command line parameters will change. The bus will need
   to be explicitly stated in the device declaration. The enum ``rte_devtype``