bash-5.0 distribution sources and documentation

[thirdparty/bash.git] / builtins / break.def

diff --git a/builtins/break.def b/builtins/break.def
index e90a32b5b9372c60c5a940f48defa8e3075956cc..876d0635d5112f03879f9a9670b630b07c17b279 100644 (file)
--- a/builtins/break.def
+++ b/builtins/break.def
@@ -1,31 +1,35 @@
 This file is break.def, from which is created break.c.
 It implements the builtins "break" and "continue" in Bash.
 
-Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
+Copyright (C) 1987-2009 Free Software Foundation, Inc.
 
 This file is part of GNU Bash, the Bourne Again SHell.
 
-Bash is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2, or (at your option) any later
-version.
+Bash is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-for more details.
+Bash is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
-with Bash; see the file COPYING.  If not, write to the Free Software
-Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
+You should have received a copy of the GNU General Public License
+along with Bash.  If not, see <http://www.gnu.org/licenses/>.
 
 $PRODUCES break.c
 
 $BUILTIN break
 $FUNCTION break_builtin
 $SHORT_DOC break [n]
-Exit from within a FOR, WHILE or UNTIL loop.  If N is specified,
-break N levels.
+Exit for, while, or until loops.
+
+Exit a FOR, WHILE or UNTIL loop.  If N is specified, break N enclosing
+loops.
+
+Exit Status:
+The exit status is 0 unless N is not greater than or equal to 1.
 $END
 #include <config.h>
 
@@ -36,12 +40,12 @@ $END
 #  include <unistd.h>
 #endif
 
+#include "../bashintl.h"
+
 #include "../shell.h"
+#include "../execute_cmd.h"
 #include "common.h"
 
-extern char *this_command_name;
-extern int posixly_correct;
-
 static int check_loop_level __P((void));
 
 /* The depth of while's and until's. */
@@ -59,16 +63,18 @@ int
 break_builtin (list)
      WORD_LIST *list;
 {
-  long newbreak;
+  intmax_t newbreak;
+
+  CHECK_HELPOPT (list);
 
   if (check_loop_level () == 0)
     return (EXECUTION_SUCCESS);
 
-  newbreak = get_numeric_arg (list, 1);
+  (void)get_numeric_arg (list, 1, &newbreak);
 
   if (newbreak <= 0)
     {
-      builtin_error ("loop count must be > 0");
+      sh_erange (list->word->word, _("loop count"));
       breaking = loop_level;
       return (EXECUTION_FAILURE);
     }
@@ -84,8 +90,13 @@ break_builtin (list)
 $BUILTIN continue
 $FUNCTION continue_builtin
 $SHORT_DOC continue [n]
-Resume the next iteration of the enclosing FOR, WHILE or UNTIL loop.
-If N is specified, resume at the N-th enclosing loop.
+Resume for, while, or until loops.
+
+Resumes the next iteration of the enclosing FOR, WHILE or UNTIL loop.
+If N is specified, resumes the Nth enclosing loop.
+
+Exit Status:
+The exit status is 0 unless N is not greater than or equal to 1.
 $END
 
 /* Set up to continue x levels, where x defaults to 1, but can be specified
@@ -94,16 +105,18 @@ int
 continue_builtin (list)
      WORD_LIST *list;
 {
-  long newcont;
+  intmax_t newcont;
+
+  CHECK_HELPOPT (list);
 
   if (check_loop_level () == 0)
     return (EXECUTION_SUCCESS);
 
-  newcont = get_numeric_arg (list, 1);
+  (void)get_numeric_arg (list, 1, &newcont);
 
   if (newcont <= 0)
     {
-      builtin_error ("loop count must be > 0");
+      sh_erange (list->word->word, _("loop count"));
       breaking = loop_level;
       return (EXECUTION_FAILURE);
     }
@@ -123,7 +136,7 @@ check_loop_level ()
 {
 #if defined (BREAK_COMPLAINS)
   if (loop_level == 0 && posixly_correct == 0)
-    builtin_error ("only meaningful in a `for', `while', or `until' loop");
+    builtin_error (_("only meaningful in a `for', `while', or `until' loop"));
 #endif /* BREAK_COMPLAINS */
 
   return (loop_level);