[v2,8/9] doc: add deprecation notice for EAL command line options

Message ID a8dfad87e3d755488cfa4e17781d7c565d06c61c.1531477505.git.anatoly.burakov@intel.com (mailing list archive)
State Superseded, archived
Headers
Series Support running DPDK without hugetlbfs mountpoint |

Checks

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

Commit Message

Burakov, Anatoly July 13, 2018, 10:27 a.m. UTC
  Options --no-shconf and --huge-unlink will be removed, and
replaced with --in-memory option, which will be a superset
of these two, and an offially support method to run DPDK
entirely in memory.

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

Notes:
    RFC->v1:
    - Add this patch

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

Comments

Thomas Monjalon July 13, 2018, 12:13 p.m. UTC | #1
13/07/2018 12:27, Anatoly Burakov:
> Options --no-shconf and --huge-unlink will be removed, and
> replaced with --in-memory option, which will be a superset
> of these two, and an offially support method to run DPDK
> entirely in memory.
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>

The deprecation notice should be sent separately in order to wait
for enough agreement.
  
Burakov, Anatoly July 13, 2018, 12:29 p.m. UTC | #2
On 13-Jul-18 1:13 PM, Thomas Monjalon wrote:
> 13/07/2018 12:27, Anatoly Burakov:
>> Options --no-shconf and --huge-unlink will be removed, and
>> replaced with --in-memory option, which will be a superset
>> of these two, and an offially support method to run DPDK
>> entirely in memory.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> 
> The deprecation notice should be sent separately in order to wait
> for enough agreement.
> 

Really, we don't have to deprecate old options. It would be nice to 
remove them as half-measures and replace them with a proper 
implementation, but it's not strictly necessary, so i'll make it a 
separate patch.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5de59833d..dd1b5c5d8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,6 +8,11 @@  API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* eal: command-line options ``--no-shconf`` and ``--huge-unlink`` will be
+    removed, and replaced with a single option ``--in-memory``, which will
+    enable DPDK to operate entirely in memory, without creating any files on any
+    filesystems.
+
 * eal: DPDK runtime configuration file (located at
   ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows: