diff mbox

[dpdk-dev] doc: deprecation notice for EAL runtime path changes

Message ID f6d177f6e3e3c8eda092ceb12aede25088f8cc1a.1527255498.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Anatoly Burakov May 25, 2018, 1:38 p.m. UTC 
  Most of this work was already done, but runtime config path is
considered to be part of public API because of high likelihood of
it being used by various tools in the DPDK ecosystem, and thus
requires a deprecation notice.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Bruce Richardson May 25, 2018, 1:58 p.m. UTC | #1 
On Fri, May 25, 2018 at 02:38:43PM +0100, Anatoly Burakov wrote:
> Most of this work was already done, but runtime config path is
> considered to be part of public API because of high likelihood of
> it being used by various tools in the DPDK ecosystem, and thus
> requires a deprecation notice.
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Van Haaren, Harry May 25, 2018, 3:33 p.m. UTC | #2 
> From: Burakov, Anatoly
> Sent: Friday, May 25, 2018 2:39 PM
> To: dev@dpdk.org
> Cc: Neil Horman <nhorman@tuxdriver.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko <marko.kovacevic@intel.com>;
> thomas@monjalon.net; Richardson, Bruce <bruce.richardson@intel.com>; Van
> Haaren, Harry <harry.van.haaren@intel.com>
> Subject: [PATCH] doc: deprecation notice for EAL runtime path changes
> 
> Most of this work was already done, but runtime config path is
> considered to be part of public API because of high likelihood of
> it being used by various tools in the DPDK ecosystem, and thus
> requires a deprecation notice.
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>

Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
Thomas Monjalon May 28, 2018, 12:28 a.m. UTC | #3 
25/05/2018 15:58, Bruce Richardson:
> On Fri, May 25, 2018 at 02:38:43PM +0100, Anatoly Burakov wrote:
> > Most of this work was already done, but runtime config path is
> > considered to be part of public API because of high likelihood of
> > it being used by various tools in the DPDK ecosystem, and thus
> > requires a deprecation notice.
> > 
> > Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> > ---
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1e2443c..36d2e23 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,6 +8,15 @@  API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* eal: DPDK runtime configuration file (located at
+  ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows:
+  - if DPDK is running as root, path will be set to
+    ``/var/run/dpdk/<prefix>/config``
+  - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set
+    to ``$XDG_RUNTIME_DIR/dpdk/<prefix>/config``
+  - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be
+    set to ``/tmp/dpdk/<prefix>/config``
+
 * eal: both declaring and identifying devices will be streamlined in v18.05.
   New functions will appear to query a specific port from buses, classes of
   device and device drivers. Device declaration will be made coherent with the