From 39b0393d31a86a8fcfa770ad040207ace95bde0d Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Sun, 11 May 2014 21:31:14 +0100
Subject: cleanup utils header, remove cruft and add documentation

---
 utils/utsname.h | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

(limited to 'utils/utsname.h')

diff --git a/utils/utsname.h b/utils/utsname.h
index cef183670..b4c0a79d9 100644
--- a/utils/utsname.h
+++ b/utils/utsname.h
@@ -27,16 +27,23 @@
 #ifdef HAVE_UTSNAME
 #include <sys/utsname.h>
 #else
-/* from posix spec */
+/** system information filled in by uname derived from posix spec. */
 struct utsname {
-	char sysname[65];    /* Operating system name (e.g., "Linux") */
-	char nodename[65];   /* Name within "some implementation-defined
-			      network" */
-	char release[65];    /* OS release (e.g., "2.6.28") */
-	char version[65];    /* OS version */
-	char machine[65];    /* Hardware identifier */
+	char sysname[65]; /**< Operating system name (e.g., "Linux") */
+	char nodename[65]; /**< Name within "some implementation-defined
+			    * network"
+			    */
+	char release[65]; /**< OS release (e.g., "2.6.28") */
+	char version[65]; /**< OS version */
+	char machine[65]; /**< Hardware identifier */
 };
 
+/**
+ * Get the system information.
+ *
+ * @param buf the buffer to fill with teh information.
+ * @return 0 on sucess or -1 and errno set on faliure.
+ */
 int uname(struct utsname *buf);
 
 #endif
-- 
cgit v1.2.3