Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of maintenance scripts.

Browse source 
Change-Id: I21b4fb873e88026108754eb7206e62c82648df0e
This commit is contained in:
Alexandre Emsenhuber 2012-08-09 18:06:18 +02:00
parent e31e045931
commit 6015071beb
10 changed files with 66 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
maintenance/reassignEdits.php
View file

@ -17,6 +17,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @author Rob Church <robchur@gmail.com>
* @licence GNU General Public Licence 2.0 or later
@ -24,6 +25,12 @@
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that reassigns edits from a user or IP address
* to another user.
*
* @ingroup Maintenance
*/
class ReassignEdits extends Maintenance {
public function __construct() {
parent::__construct();

8
maintenance/rebuildFileCache.php
View file

@ -17,11 +17,17 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that builds file cache for content pages.
*
* @ingroup Maintenance
*/
class RebuildFileCache extends Maintenance {
public function __construct() {
parent::__construct();
@ -97,7 +103,7 @@ class RebuildFileCache extends Maintenance {
foreach ( $res as $row ) {
$rebuilt = false;
$wgRequestTime = microtime( true ); # bug 22852
$wgTitle = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
if ( null == $wgTitle ) {
$this->output( "Page {$row->page_id} has bad title\n" );

7
maintenance/rebuildImages.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Script to update image metadata records
* Update image metadata records.
*
* Usage: php rebuildImages.php [--missing] [--dry-run]
* Options:
@ -32,6 +32,11 @@
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script to update image metadata records.
*
* @ingroup Maintenance
*/
class ImageBuilder extends Maintenance {
/**

8
maintenance/rebuildLocalisationCache.php
View file

@ -25,18 +25,24 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script to rebuild the localisation cache.
*
* @ingroup Maintenance
*/
class RebuildLocalisationCache extends Maintenance {
public function __construct() {
parent::__construct();
$this->mDescription = "Rebuild the localisation cache";
$this->addOption( 'force', 'Rebuild all files, even ones not out of date' );
$this->addOption( 'threads', 'Fork more than one thread', false, true );
$this->addOption( 'outdir', 'Override the output directory (normally $wgCacheDirectory)',
$this->addOption( 'outdir', 'Override the output directory (normally $wgCacheDirectory)',
false, true );
}

6
maintenance/rebuildall.php
View file

@ -18,11 +18,17 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that rebuilds link tracking tables from scratch.
*
* @ingroup Maintenance
*/
class RebuildAll extends Maintenance {
public function __construct() {
parent::__construct();

8
maintenance/rebuildmessages.php
View file

@ -1,6 +1,6 @@
<?php
/**
* This script purges all language messages from the cache
* Purge all languages from the message cache.
*
* 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,11 +17,17 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that purges all languages from the message cache.
*
* @ingroup Maintenance
*/
class RebuildMessages extends Maintenance {
public function __construct() {
parent::__construct();

10
maintenance/rebuildrecentchanges.php
View file

@ -1,7 +1,7 @@
<?php
/**
* Rebuild link tracking tables from scratch. This takes several
* hours, depending on the database size and server configuration.
* Rebuild recent changes from scratch. This takes several hours,
* depending on the database size and server configuration.
*
* 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
@ -18,12 +18,18 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @todo Document
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that rebuilds recent changes from scratch.
*
* @ingroup Maintenance
*/
class RebuildRecentchanges extends Maintenance {
public function __construct() {
parent::__construct();

6
maintenance/rebuildtextindex.php
View file

@ -20,12 +20,18 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @todo document
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that rebuilds search index table from scratch.
*
* @ingroup Maintenance
*/
class RebuildTextIndex extends Maintenance {
const RTI_CHUNK_SIZE = 500;

7
maintenance/refreshImageMetadata.php
View file

@ -1,6 +1,6 @@
<?php
/**
* Script to refresh image metadata fields. See also rebuildImages.php
* Refresh image metadata fields. See also rebuildImages.php
*
* Usage: php refreshImageMetadata.php
*
@ -29,6 +29,11 @@
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script to refresh image metadata fields.
*
* @ingroup Maintenance
*/
class RefreshImageMetadata extends Maintenance {
/**

6
maintenance/removeUnusedAccounts.php
View file

@ -18,12 +18,18 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @author Rob Church <robchur@gmail.com>
*/
require_once( dirname( __FILE__ ) . '/Maintenance.php' );
/**
* Maintenance script that removes unused user accounts from the database.
*
* @ingroup Maintenance
*/
class RemoveUnusedAccounts extends Maintenance {
public function __construct() {
parent::__construct();