Updating POD documentation for Bugzilla/Error to suggest the use of

'abort' after passing a few minutes looking for it. rs=joel

diff --git a/Bugzilla/Error.pm b/Bugzilla/Error.pm
index be7f87addc951afe467c8da513aa5bd48c5e1aa9..548cbb24c41188cee0b26bf9abb393066962ea62 100644 (file)
--- a/Bugzilla/Error.pm
+++ b/Bugzilla/Error.pm
@@ -136,6 +136,10 @@ Bugzilla::Error - Error handling utilities for Bugzilla
 
   ThrowUserError("error_tag",
                  { foo => 'bar' });
+ 
+  # supplying "abort" to ensure tables are unlocked
+  ThrowUserError("another_error_tag",
+                 { foo => 'bar' }, 'abort');
 
 =head1 DESCRIPTION
 
@@ -154,10 +158,11 @@ of variables as a second argument. These are used by the
 I<global/user-error.html.tmpl> template to format the error, using the passed
 in variables as required.
 
-An optional third argument may be supplied. If present (and defined), then the
-error handling code will unlock the database tables. In the long term, this
-argument will go away, to be replaced by transactional C<rollback> calls. There
-is no timeframe for doing so, however.
+An optional third argument may be supplied. If present, the error
+handling code will unlock the database tables: it is a Bugzilla standard
+to provide the string "abort" as the argument value. In the long term,
+this argument will go away, to be replaced by transactional C<rollback>
+calls. There is no timeframe for doing so, however.
 
 =item C<ThrowCodeError>