diff mbox series

docs: Update sockinstctrl paths

Message ID 82533E8F-2645-4296-8DC4-4F6BCA4C5850@siemens.com
State Accepted
Headers show
Series docs: Update sockinstctrl paths | expand

Commit Message

Storm, Christian May 24, 2024, 3:14 p.m. UTC 
Signed-off-by: Christian Storm <christian.storm@siemens.com>
---
 doc/source/swupdate-ipc-interface.rst | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/source/swupdate-ipc-interface.rst b/doc/source/swupdate-ipc-interface.rst
index cf62d2af..3a1d353c 100644
--- a/doc/source/swupdate-ipc-interface.rst
+++ b/doc/source/swupdate-ipc-interface.rst
@@ -26,8 +26,15 @@  easy be extended in the future if new use cases will arise.
 API Description
 ===============
 
-The communication runs via UDS (Unix Domain Socket). The socket is created
-at startup by SWUpdate in /tmp/sockinstctrl as per default configuration.
+The communication runs via Unix Domain Socket (UDS). The socket path
+is determined by
+
+- the ``CONFIG_SOCKET_CTRL_PATH`` compile-time configuration,
+- ``$RUNTIME_DIRECTORY/sockinstctrl`` if ``$RUNTIME_DIRECTORY`` is set,
+- ``$TMPDIR/sockinstctrl`` if ``$TMPDIR`` is set, or
+- ``/tmp/sockinstctrl``,
+
+in this order, and taken over from systemd or created by SWUpdate.
 This socket should, however, not be used directly but instead by the Client
 Library explained below.