doc: fix description of runtime directories
Checks
Commit Message
The documentation was never updated when the DPDK EAL
was modified to follow standard runtime conventions.
Fixes: 1835a22f342f ("support systemd service convention for runtime directory")
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/prog_guide/multi_proc_support.rst | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
Comments
16/07/2023 20:11, Stephen Hemminger:
> The documentation was never updated when the DPDK EAL
> was modified to follow standard runtime conventions.
>
> Fixes: 1835a22f342f ("support systemd service convention for runtime directory")
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Applied, thanks.
@@ -107,15 +107,18 @@ Running Multiple Independent DPDK Applications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In addition to the above scenarios involving multiple DPDK processes working together,
-it is possible to run multiple DPDK processes side-by-side,
+it is possible to run multiple DPDK processes concurrently,
where those processes are all working independently.
Support for this usage scenario is provided using the ``--file-prefix`` parameter to the EAL.
-By default, the EAL creates hugepage files on each hugetlbfs filesystem using the rtemap_X filename,
+The EAL puts shared runtime files in a directory based on standard conventions.
+If ``$RUNTIME_DIRECTORY'' is defined in the environment it is used (as ``$RUNTIME_DIRECTORY/dpdk'').
+Otherwise, if DPDK is run as root user, it uses /var/run/dpdk
+or if run as non-root user then the /tmp/dpdk (or $XDG_RUNTIME_DIRECTORY/dpdk) is used.
+Hugepage files on each hugetlbfs filesystem using the rtemap_X filename,
where X is in the range 0 to the maximum number of hugepages -1.
-Similarly, it creates shared configuration files, memory mapped in each process, using the /var/run/.rte_config filename,
-when run as root (or $HOME/.rte_config when run as a non-root user;
-if filesystem and device permissions are set up to allow this).
+Similarly, it creates shared configuration files, memory mapped in each process,
+using the .rte_config filename.
The rte part of the filenames of each of the above is configurable using the file-prefix parameter.
In addition to specifying the file-prefix parameter,