man: recommend strerror_r() over strerror()

Let's nudge people towards the use of an anonymous buffer like we
do internally.

"errno" → "errnum", to match the man page for strerror, and also to avoid
confusion with the global variable. In general, I think that errno is a
terrible interface and we shouldn't encourage people to use it. Those functions
use errno-style error numbers, which are a different thing.

diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml
index a69efe03f01f1bcdafa18058be391400cfb6965f..4b9c2370520a3d9050e706ec748d428887707cf8 100644 (file)
--- a/man/sd-bus-errors.xml
+++ b/man/sd-bus-errors.xml
@@ -268,7 +268,7 @@
       <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry project='die-net'><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry project='die-net'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>
 

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 31388b9c3da762e6076cdb69c599aa66dfd25d60..de402950bbb73ad87c9b40d1e33fb547b0c2d26a 100644 (file)
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -424,8 +424,8 @@
 
       <programlisting>sd_notifyf(0, "STATUS=Failed to start up: %s\n"
         "ERRNO=%i",
-        strerror(errno),
-        errno);</programlisting>
+        strerror_r(errnum, (char[1024]){}, 1024),
+        errnum);</programlisting>
     </example>
 
     <example>

diff --git a/src/systemd/sd-daemon.h b/src/systemd/sd-daemon.h
index 442b0ac604e41e5948df7a28f969613169be3e3b..53a1d7ccfe9c0f825457d47e718af75e70fdbccf 100644 (file)
--- a/src/systemd/sd-daemon.h
+++ b/src/systemd/sd-daemon.h
@@ -260,8 +260,8 @@ int sd_notify(int unset_environment, const char *state);
 
      sd_notifyf(0, "STATUS=Failed to start up: %s\n"
                    "ERRNO=%i",
-                   strerror(errno),
-                   errno);
+                   strerror_r(errnum, (char[1024]){}, 1024),
+                   errnum);
 
   See sd_notifyf(3) for more information.
 */