summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorReshma Pattan <reshma.pattan@intel.com>2016-07-13 17:29:10 +0100
committerThomas Monjalon <thomas.monjalon@6wind.com>2016-07-16 11:31:37 +0200
commit446d42b7d75e4dad27b3f55b9589792308bd331a (patch)
tree947e53f625c400759ce1a987bbc1d4b239fedeaf
parenta5f51527b3157c32a7ac10f7f3ce147fa0211b5d (diff)
downloaddpdk-446d42b7d75e4dad27b3f55b9589792308bd331a.zip
dpdk-446d42b7d75e4dad27b3f55b9589792308bd331a.tar.gz
dpdk-446d42b7d75e4dad27b3f55b9589792308bd331a.tar.xz
doc: fix default socket path names in pdump guide
Fixed default socket path name "/var/run" to "/var/run/.dpdk" and "$HOME" to "~/.dpdk". Fixes: 278f945402c5 ("pdump: add new library for packet capture") Signed-off-by: Reshma Pattan <reshma.pattan@intel.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
-rw-r--r--doc/guides/prog_guide/pdump_lib.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/guides/prog_guide/pdump_lib.rst b/doc/guides/prog_guide/pdump_lib.rst
index 580ffcb..0136781 100644
--- a/doc/guides/prog_guide/pdump_lib.rst
+++ b/doc/guides/prog_guide/pdump_lib.rst
@@ -75,13 +75,13 @@ the packet capture.
The packet capture framework, as part of its initialization, creates the pthread and the server socket in
the pthread. The application that calls the framework initialization will have the server socket created,
-either under the path that the application has passed or under the default path i.e. either ``/var/run`` for
-root user or ``$HOME`` for non root user.
+either under the path that the application has passed or under the default path i.e. either ``/var/run/.dpdk`` for
+root user or ``~/.dpdk`` for non root user.
Applications that request enabling or disabling of the packet capture will have the client socket created either under
-the path that the application has passed or under the default path i.e. either ``/var/run/`` for root user or ``$HOME``
-for not root user to send the requests to the server.
-The server socket will listen for client requests for enabling or disabling the packet capture.
+the path that the application has passed or under the default path i.e. either ``/var/run/.dpdk`` for root user or
+``~/.dpdk`` for not root user to send the requests to the server. The server socket will listen for client requests for
+enabling or disabling the packet capture.
Implementation Details
@@ -111,7 +111,7 @@ server socket.
The library API ``rte_pdump_set_socket_dir()``, sets the given path as either server socket path
or client socket path based on the ``type`` argument of the API.
-If the given path is ``NULL``, default path will be selected, i.e. either ``/var/run/`` for root user or ``$HOME``
+If the given path is ``NULL``, default path will be selected, i.e. either ``/var/run/.dpdk`` for root user or ``~/.dpdk``
for non root user. Clients also need to call this API to set their server socket path if the server socket
path is different from default path.