From ef5c570edfd8afb20e3b04d3711e111a1dea0548 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 3 Sep 2015 18:23:26 +0200
Subject: util: document why parse_uid() returns ENXIO

parse_uid() returns EINVAL for invalid strings, but ENXIO for the
(uid_t) -1 user ids in order to distinguish these two cases. Document
this.
---
 src/basic/util.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src/basic/util.c')

diff --git a/src/basic/util.c b/src/basic/util.c
index beec7cb7dd..86aacad307 100644
--- a/src/basic/util.c
+++ b/src/basic/util.c
@@ -403,7 +403,10 @@ int parse_uid(const char *s, uid_t* ret_uid) {
                 return -ERANGE;
 
         if (!uid_is_valid(uid))
-                return -ENXIO;
+                return -ENXIO; /* we return ENXIO instead of EINVAL
+                                * here, to make it easy to distuingish
+                                * invalid numeric uids invalid
+                                * strings. */
 
         if (ret_uid)
                 *ret_uid = uid;
-- 
cgit v1.2.3-54-g00ecf