timeout: use system-independent exit values

Change exit values from ETIMEDOUT and ECANCELED,
the values of which are system dependent, to
124 and 125 respectively.
* src/timeout.c (EXIT_TIMEDOUT, EXIT_CANCELED): Define.
(usage, main): Adjust.
* coreutils.texi (timeout invocation): Update.
* tests/misc/timeout: Adjust.

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index fa7959d01a2c657f67994a2ab2f0941ce4bcdc99..a626b4563325b3ea388572337f7ff50d39e3c8e0 100644 (file)
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -14106,7 +14106,7 @@ or a number. Also see @xref{Signal specifications}.
 Exit status:
 
 @display
-110 if @var{command} times out
+124 if @var{command} times out
 125 if @command{timeout} itself fails
 126 if @var{command} is found but cannot be invoked
 127 if @var{command} cannot be found

diff --git a/src/timeout.c b/src/timeout.c
index f7f9af01216c81a6aaa9fbc585136c0163e0d2bb..53ebf3c05b363deaa8d57cd05ba5b84c0d33ec36 100644 (file)
--- a/src/timeout.c
+++ b/src/timeout.c
@@ -20,14 +20,14 @@
    We try to behave like a shell starting a single (foreground) job,
    and will kill the job if we receive the alarm signal we setup.
    The exit status of the job is returned, or one of these errors:
-     ETIMEDOUT          110      job timed out
-     ECANCELED          125      internal error
+     EXIT_TIMEDOUT      124      job timed out
+     EXIT_CANCELED      125      internal error
      EXIT_CANNOT_INVOKE 126      error executing job
      EXIT_ENOENT        127      couldn't find job to exec
 
    Caveats:
      If user specifies the KILL (9) signal is to be sent on timeout,
-     the monitor is killed and so exits with 128+9 rather than ETIMEDOUT.
+     the monitor is killed and so exits with 128+9 rather than 124.
 
      If you start a command in the background, which reads from the tty
      and so is immediately sent SIGTTIN to stop, then the timeout
@@ -73,10 +73,11 @@
 
 #define AUTHORS proper_name_utf8 ("Padraig Brady", "P\303\241draig Brady")
 
+/* Note ETIMEDOUT is 110 on linux but this is non standard */
+#define EXIT_TIMEDOUT 124
+
 /* Internal failure.  */
-#ifndef ECANCELED
-# define ECANCELED 125
-#endif
+#define EXIT_CANCELED 125
 
 static int timed_out;
 static int term_signal = SIGTERM;  /* same default as kill command.  */
@@ -151,7 +152,7 @@ Mandatory arguments to long options are mandatory for short options too.\n\
       fputs (HELP_OPTION_DESCRIPTION, stdout);
       fputs (VERSION_OPTION_DESCRIPTION, stdout);
       fputs (_("\n\
-If the command times out, then we exit with status ETIMEDOUT,\n\
+If the command times out, then we exit with status 124,\n\
 otherwise the normal exit status of the command is returned.\n\
 If no signal is specified, the TERM signal is sent. The TERM signal\n\
 will kill processes which do not catch this signal. For other processes,\n\
@@ -227,7 +228,7 @@ main (int argc, char **argv)
   bindtextdomain (PACKAGE, LOCALEDIR);
   textdomain (PACKAGE);
 
-  initialize_exit_failure (ECANCELED);
+  initialize_exit_failure (EXIT_CANCELED);
   atexit (close_stdout);
 
   parse_long_options (argc, argv, PROGRAM_NAME, PACKAGE_NAME, VERSION,
@@ -240,16 +241,16 @@ main (int argc, char **argv)
         case 's':
           term_signal = operand2sig (optarg, signame);
           if (term_signal == -1)
-            usage (ECANCELED);
+            usage (EXIT_CANCELED);
           break;
         default:
-          usage (ECANCELED);
+          usage (EXIT_CANCELED);
           break;
         }
     }
 
   if (argc - optind < 2)
-    usage (ECANCELED);
+    usage (EXIT_CANCELED);
 
   if (xstrtoul (argv[optind], &ep, 10, &timeout, NULL)
       /* Invalid interval. Note 0 disables timeout  */
@@ -260,7 +261,7 @@ main (int argc, char **argv)
       || !apply_time_suffix ((unsigned int *) &timeout, *ep))
     {
       error (0, 0, _("invalid time interval %s"), quote (argv[optind]));
-      usage (ECANCELED);
+      usage (EXIT_CANCELED);
     }
   optind++;
 
@@ -321,7 +322,7 @@ main (int argc, char **argv)
         status = WTERMSIG (status) + 128;     /* what sh does at least.  */
 
       if (timed_out)
-        return ETIMEDOUT;
+        return EXIT_TIMEDOUT;
       else
         return status;
     }

diff --git a/tests/misc/timeout b/tests/misc/timeout
index 7f52f6e27f31d23faa89667b5b48975f9c24800b..8996fbce39820d10b5ac8cd9e51aeee3f0eab848 100755 (executable)
--- a/tests/misc/timeout
+++ b/tests/misc/timeout
@@ -39,6 +39,6 @@ timeout 1 false && fail=1
 
 # timeout
 timeout 1 sleep 2
-test $? = 110 || fail=1
+test $? = 124 || fail=1
 
 (exit $fail); exit $fail