]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
sleep: improve doc
authorPaul Eggert <eggert@cs.ucla.edu>
Fri, 25 Jan 2019 19:15:31 +0000 (11:15 -0800)
committerPaul Eggert <eggert@cs.ucla.edu>
Fri, 25 Jan 2019 19:17:18 +0000 (11:17 -0800)
Problem reported by Robert Elz.
* doc/coreutils.texi (sleep invocation):
Say that arguments must be non-negative, which means they cannot
be arbitrary floating-point numbers.  Mention POSIX, not
“historical implementations” that are no longer of practical
interest.  List the extensions to POSIX.
* src/sleep.c (usage): Omit needless words, removing dubious
commentary about “most implementations” and incorrect commentary
about “arbitrary”.  Details about exactly which numbers are
allowed can be found in the documentation.

doc/coreutils.texi
src/sleep.c

index 419417efa6dd3bc8756f669f98c656ac00a0490d..e9af80b7af703a46e5f2eb6105ecc19b878a3b92 100644 (file)
@@ -18121,7 +18121,7 @@ sleep @var{number}[smhd]@dots{}
 @end example
 
 @cindex time units
-Each argument is a number followed by an optional unit; the default
+Each argument is a non-negative number followed by an optional unit; the default
 is seconds.  The units are:
 
 @table @samp
@@ -18135,10 +18135,10 @@ hours
 days
 @end table
 
-Historical implementations of @command{sleep} have required that
-@var{number} be an integer, and only accepted a single argument
-without a suffix.  However, GNU @command{sleep} accepts
-arbitrary floating point numbers.  @xref{Floating point}.
+Although portable POSIX scripts must give @command{sleep} a single
+non-negative integer argument without a suffix, GNU @command{sleep}
+also accepts two or more arguments, unit suffixes, and floating-point
+numbers.  @xref{Floating point}.
 
 The only options are @option{--help} and @option{--version}.  @xref{Common
 options}.
index 1fc398a51ffbfda59d5be8dc56c7750eb38b86f6..23a941636b04e343198d02e71946d9830bbdf918 100644 (file)
@@ -51,9 +51,8 @@ usage (int status)
 Usage: %s NUMBER[SUFFIX]...\n\
   or:  %s OPTION\n\
 Pause for NUMBER seconds.  SUFFIX may be 's' for seconds (the default),\n\
-'m' for minutes, 'h' for hours or 'd' for days.  Unlike most implementations\n\
-that require NUMBER be an integer, here NUMBER may be an arbitrary floating\n\
-point number.  Given two or more arguments, pause for the amount of time\n\
+'m' for minutes, 'h' for hours or 'd' for days.  NUMBER need not be an\n\
+integer.  Given two or more arguments, pause for the amount of time\n\
 specified by the sum of their values.\n\
 \n\
 "),