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

Setup: Document the responsibilities of entry points

Browse source 
Bug: T189966
Change-Id: If282c21a882094a7d8a601a64de8c6fcc18b659f
This commit is contained in:
Timo Tijhof 2020-04-12 21:22:41 +01:00
parent 572e3b5988
commit 4eb1e679d5
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
includes/Setup.php
View file

@ -2,7 +2,19 @@
/**
* The setup for all MediaWiki processes (both web-based and CLI).
*
* This file is included by WebStart.php and doMaintenance.php.
* This file must be included by all entry points (such as WebStart.php and doMaintenance.php).
* - The entry point MUST do these:
* - define the 'MEDIAWIKI' constant.
* - define the $IP global variable.
* - The entry point SHOULD do these:
* - define the 'MW_ENTRY_POINT' constant.
* - display an error if MW_CONFIG_CALLBACK is not defined and the
* the file specified in MW_CONFIG_FILE (or the $IP/LocalSettings.php default)
* does not exist. The error should either be sent before and instead
* of the Setup.php inclusion, or (if it needs classes and dependencies
* from core) the erorr can be displayed via a MW_CONFIG_CALLBACK,
* which must then abort the process to prevent the rest of Setup.php
* from executing.
*
* It does:
* - run-time environment checks,