Imported from ../bash-4.0-rc1.tar.gz.

[platform/upstream/bash.git] / builtins / caller.def

diff --git a/builtins/caller.def b/builtins/caller.def
index f5f2c08..7ddbdad 100644 (file)
--- a/builtins/caller.def
+++ b/builtins/caller.def
@@ -1,39 +1,41 @@
 This file is caller.def, from which is created caller.c.  It implements the
 builtin "caller" in Bash.
 
-Copyright (C) 2002-2003 Rocky Bernstein for Free Software Foundation, Inc.
+Copyright (C) 2002-2008 Rocky Bernstein for 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 caller.c
 
 $BUILTIN caller
 $FUNCTION caller_builtin
 $DEPENDS_ON DEBUGGER
-$SHORT_DOC caller [EXPR]
+$SHORT_DOC caller [expr]
+Return the context of the current subroutine call.
 
-Returns the context of the current subroutine call.  
-
-Without EXPR, returns "$line $filename".  With EXPR,
-returns "$line $subroutine $filename"; this extra information
-can be used to provide a stack trace.
+Without EXPR, returns "$line $filename".  With EXPR, returns
+"$line $subroutine $filename"; this extra information can be used to
+provide a stack trace.
 
 The value of EXPR indicates how many call frames to go back before the
 current one; the top frame is frame 0.
+
+Exit Status:
+Returns 0 unless the shell is not executing a shell function or EXPR
+is invalid.
 $END
 
 #include <config.h>
@@ -128,14 +130,14 @@ caller_builtin (list)
 
 #ifdef LOADABLE_BUILTIN
 static char *caller_doc[] = {
-  N_("Returns the context of the current subroutine call."),
-  N_(" "),
-  N_("Without EXPR, returns returns \"$line $filename\".  With EXPR,"),
-  N_("returns \"$line $subroutine $filename\"; this extra information"),
-  N_("can be used used to provide a stack trace."),
-  N_(" "),
-  N_("The value of EXPR indicates how many call frames to go back before the"),
-  N_("current one; the top frame is frame 0."),
+N_("Returns the context of the current subroutine call.\n\
+    \n\
+    Without EXPR, returns "$line $filename".  With EXPR, returns\n\
+    "$line $subroutine $filename"; this extra information can be used to\n\
+    provide a stack trace.\n\
+    \n\
+    The value of EXPR indicates how many call frames to go back before the\n\
+    current one; the top frame is frame 0."),
   (char *)NULL
 };