From: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: Fri, 25 Mar 2022 10:39:14 +0000 (+0400)
Subject: spec: try to improve comment about AF_UNIX path
X-Git-Tag: dbus-1.15.0~26^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e6f2eed6f868fbb0db3bbbc76191bf32c404934e;p=thirdparty%2Fdbus.git

spec: try to improve comment about AF_UNIX path

The comment refers to the nul-padding of sockaddr_un member sun_path and
using an addrlen of sizeof(sockaddr_un). There is not much need to
document an old now "broken" behaviour.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---

diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml
index a43b92560..7ebf13ff4 100644
--- a/doc/dbus-specification.xml
+++ b/doc/dbus-specification.xml
@@ -3655,12 +3655,10 @@
       </para>
 
       <para>
-        When a socket is opened by the D-Bus library it truncates the path
-        name right before the first trailing Nul byte.  This is true for both
-        normal paths and abstract paths.  Note that this is a departure from
-        previous versions of D-Bus that would create sockets with a fixed
-        length path name.  Names which were shorter than the fixed length
-        would be padded by Nul bytes.
+        When a Unix socket is opened by the D-Bus library, the socket address
+        length does not include the whole <literal>struct sockaddr_un</literal>,
+        but only the length of the pathname or abstract string (beside other
+        fields).
       </para>
       <para>
         Unix domain sockets are not available on Windows.