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

INSTALL, UPGRADE: Re-wrap to 80 chars and enforce

Browse source 
Change-Id: Idabcc4db7a0b25448e7ad30641763e2b3e1a3160
This commit is contained in:
James D. Forrester 2018-06-13 12:04:51 -07:00
parent 943c2f0bc1
commit a47aec961e
3 changed files with 158 additions and 156 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
INSTALL
View file

@ -17,8 +17,8 @@ Required software:
MediaWiki is developed and tested mainly on Unix/Linux platforms, but should
work on Windows as well.
Support for rendering mathematical formulas requires installing the Math extension,
see https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:Math
Support for specialised content requires installing the relevant extension. For
formulæ, see https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:Math
Don't forget to check the RELEASE-NOTES file...
@ -67,8 +67,8 @@ available to download from the installer. Download this now, there is not a
way (yet) to get it after you exit the installer. Place it in the main wiki
directory, and the wiki should now be working.
Once the wiki is set up, you should remove the mw-config directory (though it will
refuse to config again if the wiki is set up).
Once the wiki is set up, you should remove the mw-config directory (though it
will refuse to config again if the wiki is set up).
----

259
UPGRADE
View file

@ -1,24 +1,23 @@
This file provides an overview of the MediaWiki upgrade process. For help with
specific problems, check
specific problems, you should check:
* the documentation at https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents
* the docs at https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents ;
* the mediawiki-l mailing list archive at
https://lists.wikimedia.org/pipermail/mediawiki-l/
https://lists.wikimedia.org/pipermail/mediawiki-l/ ; and
* the bug tracker at https://phabricator.wikimedia.org/
for information and workarounds to common issues.
… for information and workarounds to common issues.
== Overview ==
Comprehensive documentation on upgrading to the latest version of the software
is available at https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Upgrading
We provide comprehensive documentation on upgrading to the latest version of the
software at https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Upgrading.
=== Consult the release notes ===
Before doing anything, stop and consult the release notes supplied with the new
version of the software. These detail bug fixes, new features and functionality,
and any particular points that may need to be noted during the upgrade
procedure.
and any particular points that may need to be noted during the upgrade process.
=== Backup first ===
@ -27,19 +26,18 @@ you take a complete backup of your wiki database and files and verify it. While
the upgrade scripts are somewhat robust, there is no guarantee that things will
not fail, leaving the database in an inconsistent state.
https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Backing_up_a_wiki provides an overview of
the backup process. You should also refer to the documentation for your
database management system for information on backing up a database, and to
https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Backing_up_a_wiki is an
overview of the backup process. You should also refer to the documentation for
your database management system for information on backing up a database, and to
your operating system documentation for information on making copies of files.
=== Perform the file upgrade ===
Download the files for the new version of the software. These are available
as a compressed "tar" archive from the Wikimedia Download Service
Download the files for the new version of the software. These are available as a
compressed "tar" archive from the Wikimedia Download Service
(https://releases.wikimedia.org/mediawiki/).
You can also obtain the new files directly from our Git source code
repository.
You can also obtain the new files directly from our Git source code repository.
Replace the existing MediaWiki files with the new. You should preserve the
LocalSettings.php file and the "extensions" and "images" directories.
@ -50,15 +48,15 @@ deleted file archives, and any custom skins.
=== Perform the database upgrade ===
As of 1.21, it is possible to separate schema changes (i.e. adding,
dropping, or changing tables, fields, or indices) from all other
database changes (e.g. populating fields). If you need this
capability, see "From the command line" below.
As of 1.21, it is possible to separate schema changes (i.e. adding, dropping, or
changing tables, fields, or indices) from all other database changes (e.g.
populating fields). If you need this capability, see "From the command line"
below.
==== From the web ====
==== From the Web ====
If you browse to the web-based installation script (usually at
/mw-config/index.php) from your wiki installation you can follow the script and
If you browse to the Web-based installation script (usually at
./mw-config/index.php) from your wiki installation you can follow the script and
upgrade your database in place.
==== From the command line ====
@ -68,19 +66,19 @@ update.php script to check and update the schema. This will insert missing
tables, update existing tables, and move data around as needed. In most cases,
this is successful and nothing further needs to be done.
If you need to separate out the schema changes so they can be run
by someone with more privileges, then you can use the --schema option
to produce a text file with the necessary commands. You can use
--schema, --noschema, $wgAllowSchemaUpdates as well as proper database
permissions to enforce this separation.
If you need to separate out the schema changes so they can be run by someone
with more privileges, then you can use the --schema option to produce a text
file with the necessary commands. You can use --schema, --noschema,
$wgAllowSchemaUpdates as well as proper database permissions to enforce this
separation.
=== Check configuration settings ===
The names of configuration variables, and their default values and purposes,
can change between release branches, e.g. $wgDisableUploads in 1.4 is replaced
with $wgEnableUploads in later versions. When upgrading, consult the release
notes to check for configuration changes which would alter the expected
behavior of MediaWiki.
The names of configuration variables, and their default values and purposes, can
change between release branches, e.g. $wgDisableUploads in 1.4 is replaced with
$wgEnableUploads in later versions. When upgrading, consult the release notes to
check for configuration changes which would alter the expected behavior of
MediaWiki.
=== Check installed extensions ===
@ -94,48 +92,48 @@ LocalSettings.php
It makes sense to test your wiki immediately following any kind of maintenance
procedure, and especially after upgrading; check that page views and edits work
normally and that special pages continue to function, etc. and correct errors
normally, that special pages continue to function, etc., and correct any errors
and quirks which reveal themselves.
You should also test any extensions, and upgrade these if necessary.
== Upgrading from 1.16 or earlier ==
If you have a Chinese or Japanese wiki ($wgLanguageCode is set to one
of "zh", "ja", or "yue") and you are using MySQL fulltext search, you
will probably want to update the search index.
If you have a Chinese or Japanese wiki ($wgLanguageCode is set to one of "zh",
"ja", or "yue") and you are using MySQL fulltext search, you will probably want
to update the search index.
In the "maintenance" directory, run the updateDoubleWidthSearch.php
script. This will update the searchindex table for those pages that
contain double-byte Latin characters.
In the "maintenance" directory, run the updateDoubleWidthSearch.php script. This
will update the searchindex table for those pages that contain double-byte Latin
characters.
== Upgrading from 1.10 or earlier ==
If upgrading from before 1.11, and you are using a wiki as a commons
repository, make sure that it is updated as well. Otherwise, errors may arise
due to database schema changes.
If upgrading from before 1.11, and you are using a wiki as a commons repository,
make sure that it is updated as well. Otherwise, errors may arise due to
database schema changes.
== Upgrading from 1.8 or earlier ==
MediaWiki 1.9 and later no longer keep default localized message text
in the database; 'MediaWiki:'-namespace pages that do not exist in the
database are simply transparently filled-in on demand.
MediaWiki 1.9 and later no longer keep default localized message text in the
database; 'MediaWiki:'-namespace pages that do not exist in the database are
simply transparently filled-in on demand.
The upgrade process will delete any 'MediaWiki:' pages which are left
in the default state (last edited by 'MediaWiki default'). This may
take a few moments, similar to the old initial setup.
The upgrade process will delete any 'MediaWiki:' pages which are left in the
default state (last edited by 'MediaWiki default'). This may take a few moments,
similar to the old initial setup.
Note that the large number of deletions may cause older edits to expire
from the list on Special:Recentchanges, although the deletions themselves
will be hidden by default. (Click "show bot edits" to list them.)
Note that the large number of deletions may cause older edits to expire from the
list on Special:Recentchanges, although the deletions themselves will be hidden
by default. (Click "show bot edits" to list them.)
See RELEASE-NOTES for more details about new and changed options.
== Upgrading from 1.7 or earlier ==
$wgDefaultUserOptions now contains all the defaults, not only overrides.
If you're setting this as a complete array(), you may need to change it
to set only specific items as recommended in DefaultSettings.php.
$wgDefaultUserOptions now contains all the defaults, not only overrides. If you
are setting this as a complete array(), you may need to change it to set only
specific items as recommended in DefaultSettings.php.
== Upgrading from 1.6 or earlier ==
@ -146,58 +144,56 @@ new database fields are filled with data.
== Upgrading from 1.5 or earlier ==
Major changes have been made to the schema from 1.4.x. The updater
has not been fully tested for all conditions, and might well break.
Major changes have been made to the schema from 1.4.x. The updater has not been
fully tested for all conditions, and might well break.
On a large site, the schema update might take a long time. It might
explode, or leave your database half-done or otherwise badly hurting.
On a large site, the schema update might take a long time. It might explode, or
leave your database half-done or otherwise badly hurting.
Among other changes, note that Latin-1 encoding (ISO-8859-1) is
no longer supported. Latin-1 wikis will need to be upgraded to
UTF-8; an experimental command-line upgrade helper script,
'upgrade1_5.php', can do this -- run it prior to 'update.php' or
the web upgrader.
Among other changes, note that Latin-1 encoding (ISO-8859-1) is no longer
supported. Latin-1 wikis will need to be upgraded to UTF-8; an experimental
command-line upgrade helper script, 'upgrade1_5.php', can do this -- run it
prior to 'update.php' or the Web upgrader.
NOTE that upgrade1_5.php does not work properly with recent versions
of MediaWiki. If upgrading a 1.4.x wiki, you should upgrade to 1.5
first. upgrade1_5.php has been removed from MediaWiki 1.21.
NOTE that upgrade1_5.php does not work properly with recent versions of
MediaWiki. If upgrading a 1.4.x wiki, you should upgrade to 1.5 first.
upgrade1_5.php has been removed from MediaWiki 1.21.
If you absolutely cannot make the UTF-8 upgrade work, you can try
doing it by hand: dump your old database, convert the dump file
using iconv as described here:
http://portal.suse.com/sdb/en/2004/05/jbartsh_utf-8.html
and then reimport it. You can also convert filenames using convmv,
but note that the old directory hashes will no longer be valid,
so you will also have to move them to new destinations.
If you absolutely cannot make the UTF-8 upgrade work, you can try doing it by
hand: dump your old database, convert the dump file using iconv as described
here: http://portal.suse.com/sdb/en/2004/05/jbartsh_utf-8.html
and then re-import it. You can also convert filenames using convmv, but note
that the old directory hashes will no longer be valid, so you will also have to
move them to new destinations.
Message changes:
* A number of additional UI messages have been changed from HTML to
wikitext, and will need to be manually fixed if customized.
* A number of additional UI messages have been changed from HTML to wikitext,
and will need to be manually fixed if customized.
=== Configuration changes from 1.4.x: ===
$wgDisableUploads has been replaced with $wgEnableUploads.
$wgWhitelistAccount has been replaced by the 'createaccount' permission
key in $wgGroupPermissions. To emulate the old effect of setting:
$wgWhitelistAccount has been replaced by the 'createaccount' permission key in
$wgGroupPermissions. To emulate the old effect of setting:
$wgWhitelistAccount['user'] = 0;
set:
$wgGroupPermissions['*']['createaccount'] = false;
$wgWhitelistEdit has been replaced by the 'edit' permission key.
To emulate the old effect of setting:
$wgWhitelistEdit has been replaced by the 'edit' permission key. To emulate the
old effect of setting:
$wgWhitelistEdit = true;
set:
$wgGroupPermissions['*']['edit'] = false;
If $wgWhitelistRead is set, you must also disable the 'read' permission
for it to take affect on anonymous users:
If $wgWhitelistRead is set, you must also disable the 'read' permission for it
to take affect on anonymous users:
$wgWhitelistRead = array( "Main Page", "Special:Userlogin" );
$wgGroupPermissions['*']['read'] = false;
Note that you can disable/enable several other permissions by modifying
this configuration array in your LocalSettings.php; see DefaultSettings.php
for the complete default permission set.
Note that you can disable/enable several other permissions by modifying this
configuration array in your LocalSettings.php; see DefaultSettings.php for the
complete default permission set.
If using Memcached, you must enabled it differently now:
$wgUseMemCached = true;
@ -206,35 +202,31 @@ should be replaced with:
== Upgrading from 1.4.2 or earlier ==
1.4.3 has added new fields to the sitestats table. These fields are
optional and help to speed Special:Statistics on large sites. If you
choose not to run the database upgrades, everything will continue to
work in 1.4.3.
1.4.3 has added new fields to the sitestats table. These fields are optional and
help to speed Special:Statistics on large sites. If you choose not to run the
database upgrades, everything will continue to work in 1.4.3.
You can apply the update by running maintenance/update.php, or
manually run the SQL commands from this file:
You can apply the update by running maintenance/update.php, or manually run the
SQL commands from this file:
maintenance/archives/patch-ss_total_articles.sql
== Upgrading from 1.4rc1 or earlier betas ==
The logging table has been altered from 1.4beta4 to 1.4beta5
and again in 1.4.0 final. Copy in the new files and use the web
installer to upgrade, or the command-line maintenance/update.php.
If you cannot use the automated installers/updaters, you may
update the table by manually running the SQL commands in these
files:
maintenance/archives/patch-log_params.sql
maintenance/archives/patch-logging-title.sql
The logging table has been altered from 1.4beta4 to 1.4beta5 and again in 1.4.0
final. Copy in the new files and use the Web installer to upgrade, or the
command-line maintenance/update.php.
If you cannot use the automated installers/updaters, you may update the table by
manually running the SQL commands in these files:
maintenance/archives/patch-log_params.sql
maintenance/archives/patch-logging-title.sql
== Upgrading from 1.3 or earlier ==
This should generally go smoothly.
If you keep your LocalSettings.php, you may need to change the style paths
to match the newly rearranged skin modules. Change these lines:
If you keep your LocalSettings.php, you may need to change the style paths to
match the newly rearranged skin modules. Change these lines:
$wgStylePath = "$wgScriptPath/stylesheets";
$wgStyleDirectory = "$IP/stylesheets";
$wgLogo = "$wgStylePath/images/wiki.png";
@ -244,9 +236,9 @@ to this:
$wgStyleDirectory = "$IP/skins";
$wgLogo = "$wgStylePath/common/images/wiki.png";
As well as new messages, the processing of some messages has changed.
If you have customized them, please compare the new format using
Special:Allmessages or the relevant LanguageXX.php files:
As well as new messages, the processing of some messages has changed. If you
have customized them, please compare the new format using Special:Allmessages or
the relevant LanguageXX.php files:
* copyrightwarning
* dberrortext
@ -262,45 +254,42 @@ Special:Allmessages or the relevant LanguageXX.php files:
* showhideminor
* unprotectedarticle
Note that the 1.3 beta releases included a potential vulnerability if PHP
is configured with register_globals on and the includes directory is
served to the web. For general safety, turn register_globals *off* if you
don't _really_ need it for another package.
If your hosting provider turns it on and you can't turn it off yourself,
send them a kind note explaining that it can expose their servers and their
customers to attacks.
Note that the 1.3 beta releases included a potential vulnerability if PHP is
configured with register_globals on and the includes directory is served to the
Web. For general safety, turn register_globals *off* if you don't _really_ need
it for another package.
If your hosting provider turns it on and you can't turn it off yourself, send
them a kind note explaining that it can expose their servers and their customers
to attacks.
== Upgrading from 1.2 or earlier ==
If you've been using the MediaWiki: namespace for custom page templates,
note that things are a little different. The Template: namespace has been
added which is more powerful -- templates can include parameters for
instance.
If you've been using the MediaWiki: namespace for custom page templates, note
that things are a little different. The Template: namespace has been added which
is more powerful -- templates can include parameters for instance.
If you were using custom MediaWiki: entries for text inclusions, they
will *not* automatically be moved to Template: entries at upgrade time.
Be sure to go through and check that everything is working properly;
you can move them manually or you can try using moveCustomMessages.php
in maintenance/archives to do it automatically, but this might break things.
Also, be sure to pick the correct character encoding -- some languages were
only available in Latin-1 on 1.2.x and are now available for Unicode as well.
If you want to upgrade an existing wiki from Latin-1 to Unicode you'll have
to dump the database to SQL, run it through iconv or another conversion tool,
and restore it. Sorry.
If you were using custom MediaWiki: entries for text inclusions, they will *not*
automatically be moved to Template: entries at upgrade time. Be sure to go
through and check that everything is working properly; you can move them
manually or you can try using moveCustomMessages.php in maintenance/archives to
do it automatically, but this might break things.
Also, be sure to pick the correct character encoding -- some languages were only
available in Latin-1 on 1.2.x and are now available for Unicode as well. If you
want to upgrade an existing wiki from Latin-1 to Unicode you'll have to dump the
database to SQL, run it through iconv or another conversion tool, and restore
it. Sorry.
== Upgrading from 1.1 or earlier ==
This is less thoroughly tested, but should work.
You need to specify the *admin* database username and password to the
installer in order for it to successfully upgrade the database structure.
You may wish to manually change the GRANTs later.
You need to specify the *admin* database username and password to the installer
in order for it to successfully upgrade the database structure. You may wish to
manually change the GRANTs later.
If you have a very old database (earlier than organized MediaWiki releases
in late August 2003) you may need to manually run some of the update SQL
scripts in maintenance/archives before the installer is able to pick up
with remaining updates.
If you have a very old database (earlier than organized MediaWiki releases in
late August 2003) you may need to manually run some of the update SQL scripts in
maintenance/archives before the installer is able to pick up with remaining
updates.

47
tests/phpunit/documentation/ReleaseNotesTest.php
View file

@ -30,25 +30,38 @@ class ReleaseNotesTest extends MediaWikiTestCase {
);
foreach ( $notesFiles as $index => $fileName ) {
$file = file( $fileName, FILE_IGNORE_NEW_LINES );
$this->assertFileLength( "Release Notes", $fileName );
}
$this->assertFalse(
!$file,
"Release Notes file '$fileName' is inaccessible."
// Also test the README and similar files
$otherFiles = [ "$IP/COPYING", "$IP/FAQ", "$IP/INSTALL", "$IP/README", "$IP/SECURITY" ];
foreach ( $otherFiles as $index => $fileName ) {
$this->assertFileLength( "Help", $fileName );
}
}
/**
*/
private function assertFileLength( $type, $fileName ) {
$file = file( $fileName, FILE_IGNORE_NEW_LINES );
$this->assertFalse(
!$file,
"$type file '$fileName' is inaccessible."
);
$lines = count( $file );
for ( $i = 0; $i < $lines; $i++ ) {
$line = $file[$i];
$this->assertLessThanOrEqual(
// FILE_IGNORE_NEW_LINES drops the \n at the EOL, so max length is 80 not 81.
80,
mb_strlen( $line ),
"$type file '$fileName' line $i is longer than 80 chars:\n\t'$line'"
);
$lines = count( $file );
for ( $i = 0; $i < $lines; $i++ ) {
$line = $file[$i];
$this->assertLessThanOrEqual(
// FILE_IGNORE_NEW_LINES drops the \n at the EOL, so max length is 80 not 81.
80,
mb_strlen( $line ),
"Release notes file '$fileName' line $i is longer than 80 chars:\n\t'$line'"
);
}
}
}
}