chiark / gitweb /
man: Drop "internally," which is misleading
authorDavid Strauss <david@davidstrauss.net>
Tue, 3 Nov 2015 01:19:26 +0000 (17:19 -0800)
committerSven Eden <yamakuzure@gmx.net>
Wed, 26 Apr 2017 10:58:55 +0000 (12:58 +0200)
The existing text misleads readers into thinking how the notify socket protocol is "internals" and that they can only use the functions. However, the socket is part of the Interface Stability Promise. So, we should drop "internally" from the description so the man page both indicates both how the functions work and how one would talk to the socket directly.

man/sd_notify.xml

index c52ef533bbe201f47f2f3e4bee38d6c8feedc5c1..05aae604a8347fd0da40c9cc54191a97f210a9cb 100644 (file)
 
     <xi:include href="libelogind-pkgconfig.xml" xpointer="pkgconfig-text"/>
 
 
     <xi:include href="libelogind-pkgconfig.xml" xpointer="pkgconfig-text"/>
 
-    <para>Internally, these functions send a single datagram with the
+    <para>These functions send a single datagram with the
     state string as payload to the <constant>AF_UNIX</constant> socket
     referenced in the <varname>$NOTIFY_SOCKET</varname> environment
     variable. If the first character of
     state string as payload to the <constant>AF_UNIX</constant> socket
     referenced in the <varname>$NOTIFY_SOCKET</varname> environment
     variable. If the first character of