summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCraig Small <csmall@enc.com.au>2016-05-01 16:50:25 +1000
committerCraig Small <csmall@enc.com.au>2016-05-01 16:50:25 +1000
commit6b5cb345c5be6beeec74409657c8ebf9e8869d92 (patch)
treee81c7e821c6afa02b417ca6a3d10cbcfdbdbb503 /doc
parent6151b794c6a4f1958dee81fb17bad83b65166c8f (diff)
downloadprocps-ng-6b5cb345c5be6beeec74409657c8ebf9e8869d92.tar.gz
library: procps_uptime() return value is a status
procps_uptime, previously just plain uptime() used to put the uptime (as a double) in the first argument and return uptime (as an int). It meant if you ran myuptime2 = procps_uptime(&myuptime1, NULL); You might get different results for myuptime1 and myuptime2 because they are different types. Most library calls use the return value to return the status, procps_uptime was in the middle. Until now. This function will return 0 on success. If you want (for whatever reason) uptime as an int then cast it. All of the procps binaries didn't use the return value for uptime except ps which set a variable to it but never used it anywhere.
Diffstat (limited to 'doc')
-rw-r--r--doc/procps_uptime.34
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/procps_uptime.3 b/doc/procps_uptime.3
index 912aa3c..61e70fb 100644
--- a/doc/procps_uptime.3
+++ b/doc/procps_uptime.3
@@ -16,7 +16,7 @@
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\" %%%LICENSE_END
.\"
-.TH PROCPS_UPTIME 3 2016-04-16 "libproc-2"
+.TH PROCPS_UPTIME 3 2016-05-01 "libproc-2"
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
@@ -35,7 +35,7 @@ fills the location of the two double points with the current sytem uptime
and idle time.
.SH RETURN VALUE
.BR procps_uptime ()
-returns a positive integer which is the uptime on success. On failure, it
+returns 0 on success. On failure, it
returns a negative integer to one of the values defined below.
.TP
.B -ERANGE