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

installer: Rename Doxygen group from "Deployment" to "Installer"

Browse source 
Also improve the description a bit and explain at a high level
how this code is used, and which classes back those entry points.

Change-Id: Ia69531858e714d0b43a29a7d5b6dcc5c7edd8240
This commit is contained in:
Timo Tijhof 2019-11-25 23:24:49 +00:00
parent 70bc2a5527
commit b118bddc15
31 changed files with 53 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
includes/installer/CliInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\Installer\InstallException;
@ -27,7 +27,7 @@ use MediaWiki\MediaWikiServices;
/**
* Class for the core installer command line interface.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class CliInstaller extends Installer {

4
includes/installer/DatabaseInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\MediaWikiServices;
@ -31,7 +31,7 @@ use Wikimedia\Rdbms\DBConnectionError;
/**
* Base class for DBMS-specific installation helper classes.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
abstract class DatabaseInstaller {

4
includes/installer/DatabaseUpdater.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IMaintainableDatabase;
@ -30,7 +30,7 @@ require_once __DIR__ . '/../../maintenance/Maintenance.php';
* Class for handling database updates. Roughly based off of updaters.inc, with
* a few improvements :)
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
abstract class DatabaseUpdater {

14
includes/installer/Installer.php
View file

@ -21,7 +21,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\Interwiki\NullInterwikiLookup;
@ -29,9 +29,15 @@ use MediaWiki\MediaWikiServices;
use MediaWiki\Shell\Shell;
/**
* This documentation group collects source code files with deployment functionality.
* The Installer helps admins create or upgrade their wiki.
*
* @defgroup Deployment Deployment
* The installer classes are exposed through these human interfaces:
*
* - The `maintenance/install.php` script, backed by CliInstaller.
* - The `maintenance/update.php` script, backed by DatabaseUpdater.
* - The `mw-config/index.php` web entry point, backed by WebInstaller.
*
* @defgroup Installer installer
*/
/**
@ -40,7 +46,7 @@ use MediaWiki\Shell\Shell;
* This class provides the base for installation and update functionality
* for both MediaWiki core and extensions.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
abstract class Installer {

2
includes/installer/InstallerSessionProvider.php
View file

@ -20,7 +20,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\Session\SessionProvider;

4
includes/installer/LocalSettingsGenerator.php
View file

@ -18,13 +18,13 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
/**
* Class for generating LocalSettings.php file.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class LocalSettingsGenerator {

4
includes/installer/MysqlInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\Database;
@ -28,7 +28,7 @@ use Wikimedia\Rdbms\DBConnectionError;
/**
* Class for setting up the MediaWiki database using MySQL.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class MysqlInstaller extends DatabaseInstaller {

4
includes/installer/MysqlUpdater.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\MySQLField;
use Wikimedia\Rdbms\IDatabase;
@ -27,7 +27,7 @@ use MediaWiki\MediaWikiServices;
/**
* Mysql update list and mysql-specific update functions.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
* @property Wikimedia\Rdbms\DatabaseMysqlBase $db
*/

4
includes/installer/PostgresInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\Database;
@ -29,7 +29,7 @@ use Wikimedia\Rdbms\DBConnectionError;
/**
* Class for setting up the MediaWiki database using Postgres.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class PostgresInstaller extends DatabaseInstaller {

4
includes/installer/PostgresUpdater.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\DatabasePostgres;
@ -26,7 +26,7 @@ use Wikimedia\Rdbms\DatabasePostgres;
/**
* Class for handling updates to Postgres databases.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class PostgresUpdater extends DatabaseUpdater {

4
includes/installer/SqliteInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\Database;
@ -28,7 +28,7 @@ use Wikimedia\Rdbms\DBConnectionError;
/**
* Class for setting up the MediaWiki database using SQLLite.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class SqliteInstaller extends DatabaseInstaller {

4
includes/installer/SqliteUpdater.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use Wikimedia\Rdbms\DatabaseSqlite;
@ -26,7 +26,7 @@ use Wikimedia\Rdbms\DatabaseSqlite;
/**
* Class for handling updates to Sqlite databases.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class SqliteUpdater extends DatabaseUpdater {

4
includes/installer/WebInstaller.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\MediaWikiServices;
@ -26,7 +26,7 @@ use MediaWiki\MediaWikiServices;
/**
* Class for the core installer web interface.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
class WebInstaller extends Installer {

2
includes/installer/WebInstallerComplete.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerComplete extends WebInstallerPage {

2
includes/installer/WebInstallerCopying.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerCopying extends WebInstallerDocument {

2
includes/installer/WebInstallerDBConnect.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerDBConnect extends WebInstallerPage {

2
includes/installer/WebInstallerDBSettings.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerDBSettings extends WebInstallerPage {

2
includes/installer/WebInstallerDocument.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
abstract class WebInstallerDocument extends WebInstallerPage {

2
includes/installer/WebInstallerExistingWiki.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerExistingWiki extends WebInstallerPage {

2
includes/installer/WebInstallerInstall.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerInstall extends WebInstallerPage {

2
includes/installer/WebInstallerLanguage.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerLanguage extends WebInstallerPage {

2
includes/installer/WebInstallerName.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\MediaWikiServices;

2
includes/installer/WebInstallerOptions.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerOptions extends WebInstallerPage {

4
includes/installer/WebInstallerOutput.php
View file

@ -18,7 +18,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
use MediaWiki\MediaWikiServices;
@ -31,7 +31,7 @@ use MediaWiki\MediaWikiServices;
* quite a lot of things you could do in OutputPage that would break the installer,
* that wouldn't be immediately obvious.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
* @private
*/

4
includes/installer/WebInstallerPage.php
View file

@ -18,13 +18,13 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
/**
* Abstract class to define pages for the web installer.
*
* @ingroup Deployment
* @ingroup Installer
* @since 1.17
*/
abstract class WebInstallerPage {

2
includes/installer/WebInstallerReadme.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerReadme extends WebInstallerDocument {

2
includes/installer/WebInstallerReleaseNotes.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerReleaseNotes extends WebInstallerDocument {

2
includes/installer/WebInstallerRestart.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerRestart extends WebInstallerPage {

2
includes/installer/WebInstallerUpgrade.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerUpgrade extends WebInstallerPage {

2
includes/installer/WebInstallerUpgradeDoc.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerUpgradeDoc extends WebInstallerDocument {

2
includes/installer/WebInstallerWelcome.php
View file

@ -16,7 +16,7 @@
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Deployment
* @ingroup Installer
*/
class WebInstallerWelcome extends WebInstallerPage {