From: Hypolite Petovan <hypolite@mrpetovan.com>
Date: Sun, 19 Jan 2020 14:24:46 +0000 (-0500)
Subject: Clarify update.php doc and mention Database\PostUpdate
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=bac5159f6f0cad4126946f77b6cf7c1110de4b79;p=friendica.git

Clarify update.php doc and mention Database\PostUpdate
---

diff --git a/src/Database/PostUpdate.php b/src/Database/PostUpdate.php
index 94d00853ab..7fd28419ea 100644
--- a/src/Database/PostUpdate.php
+++ b/src/Database/PostUpdate.php
@@ -10,11 +10,14 @@ use Friendica\DI;
 use Friendica\Model\Contact;
 use Friendica\Model\Item;
 use Friendica\Model\ItemURI;
-use Friendica\Model\UserItem;
 use Friendica\Model\PermissionSet;
+use Friendica\Model\UserItem;
 
 /**
- * Post update functions
+ * These database-intensive post update routines are meant to be executed in the background by the cronjob.
+ *
+ * If there is a need for a intensive migration after a database structure change, update this file
+ * by adding a new method at the end with the number of the new DB_UPDATE_VERSION.
  */
 class PostUpdate
 {
diff --git a/update.php b/update.php
index 4d12730fab..22ed4ae9e3 100644
--- a/update.php
+++ b/update.php
@@ -15,15 +15,15 @@ use Friendica\Util\DateTimeFormat;
 use Friendica\Worker\Delivery;
 
 /**
+ * update.php - automatic post-databse structure change updates
  *
- * update.php - automatic system update
- *
- * This function is responsible for doing post update changes to the data
- * (not the structure) in the database.
+ * These functions are responsible for doing critical post update changes to the data (not the structure) in the database.
  *
  * Database structure changes are done in static/dbstructure.config.php
  *
- * If there is a need for a post process to a structure change, update this file
+ * For non-critical database migrations, please add a method in the Database\PostUpdate class
+ *
+ * If there is a need for a post update to a structure change, update this file
  * by adding a new function at the end with the number of the new DB_UPDATE_VERSION.
  *
  * The numbered script in this file has to be exactly like the DB_UPDATE_VERSION