debug log group for DNS blacklist lookup results

[lhc/web/wiklou.git] / includes / SqlDataUpdate.php

diff --git a/includes/SqlDataUpdate.php b/includes/SqlDataUpdate.php
index f0204df..aeb9ba4 100644 (file)
--- a/includes/SqlDataUpdate.php
+++ b/includes/SqlDataUpdate.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * See docs/deferred.txt
+ * Base code for update jobs that put some secondary data extracted
+ * from article content into the database.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,8 +18,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
+ */
+
+/**
  * Abstract base class for update jobs that put some secondary data extracted
  * from article content into the database.
+ *
+ * @note: subclasses should NOT start or commit transactions in their doUpdate() method,
+ *        a transaction will automatically be wrapped around the update. Starting another
+ *        one would break the outer transaction bracket. If need be, subclasses can override
+ *        the beginTransaction() and commitTransaction() methods.
  */
 abstract class SqlDataUpdate extends DataUpdate {