From e1b2dccb2b8a336d8e0d4def899fdc54735d76be Mon Sep 17 00:00:00 2001 From: "kiko%async.com.br" <> Date: Fri, 23 Jul 2004 03:15:38 +0000 Subject: Updating POD documentation for Bugzilla/Error to suggest the use of 'abort' after passing a few minutes looking for it. rs=joel --- Bugzilla/Error.pm | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'Bugzilla/Error.pm') diff --git a/Bugzilla/Error.pm b/Bugzilla/Error.pm index be7f87add..548cbb24c 100644 --- 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 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 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 +calls. There is no timeframe for doing so, however. =item C -- cgit v1.2.3-24-g4f1b