Last modified: 2013-05-25 14:19:52 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T50801, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 48801 - Change name of LocalSettings.php to settings.php or WikiSettings.php
Change name of LocalSettings.php to settings.php or WikiSettings.php
Status: RESOLVED WONTFIX
Product: MediaWiki
Classification: Unclassified
General/Unknown (Other open bugs)
1.22.0
All All
: Low enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-05-25 04:44 UTC by jeffwang16
Modified: 2013-05-25 14:19 UTC (History)
3 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description jeffwang16 2013-05-25 04:44:41 UTC
Since AdminSettings.php was removed in MediaWiki 1.16, there has only been one -settings.php suffixed script. (Except for DefaultSettings.php, but that shouldn't even be modified, and it's located in a subfolder.) Therefore, there is no need to put the "Local-" prefix onto the script. For backward compatibility, LocalSettings.php should redirect to settings.php or WikiSettings.php.
The reason why I believe the Local- prefix should be removed is because it's 1. not consistent with other software's settings script names (so it's easier for others who have used WordPress, phpBB, vBulletin, xenForo, etc. to find) 2. doesn't mean anything 3. makes code longer (every time the local- prefix appears, it adds up!) 4. speeds up everything else 5. clears up possible confusion and questioning over why it's even called LocalSettings.php.
Comment 1 MZMcBride 2013-05-25 04:52:53 UTC
Hi. Thanks for taking the time to file this bug.

Renaming LocalSettings.php requires maintaining at least two files indefinitely, which clutters the root directory further. It also requires updating a lot of documentation on MediaWiki.org, which will also likely add to the confusion people have about which file to edit. I'm not really sure what "speeds up everything else" even means. And as you point out yourself, calling the file LocalSettings.php distinguishes it from DefaultSettings.php.

In any case, the real answer here is to largely deprecate the use of LocalSettings.php (like WordPress' wp-config.php, LocalSettings.php should ideally only store database credentials and little else). This is the subject of bug 26992. Perhaps in the process of rewriting the wiki configuration interface, the file that holds the database credentials can be renamed to something other than "LocalSettings.php". However, I'd recommend that this particular bug be marked resolved/wontfix, as I see plenty of disadvantage to renaming this file and no real advantage.
Comment 2 Brion Vibber 2013-05-25 13:24:05 UTC
There's also the 'CommonSettings.php' and 'InitialiseSettings.php' convention for wikifarms used in Wikimedia's installations... so it does make some sense.

But I agree with comment #1 that the main fix is to largely remove the need to edit it manually; few people will care what it's called when they never have to touch it.

Bug 26992... let's plan to put this on the table soon.
Comment 3 jeffwang16 2013-05-25 14:19:04 UTC
Brion and MZMcBride,
MediaWiki is not just for Wikimedia; besides, renaming LocalSettings.php to Settings.php makes it easier for others. Less than 1% of wiki administrators will have InitialiseSettings.php, GlobalSettings.php, or CommonSettings.php. (I was about to put this argument up but I decided not to.) MediaWiki is not all about Wikipedia/Wikimedia, and therefore I still firmly believe that LocalSettings.php should be renamed, either in this lesser iteration or in Bug 26992.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links