Clean up intro to InitialiseSettings.php
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• MZMcBride
	May 15 2013, 2:49 AM

Description

From https://noc.wikimedia.org/conf/InitialiseSettings.php.txt:

<?php
/**

vim: set sw=4 ts=4 noet foldmarker=@{,@} foldmethod=marker:
- recognize folding markers just like DefaultSettings.php
You need to use 'set modeline' to activate this feature.
za to toggle a fold
zA to toggle folds recursively
zR to open them all
zM close all folds

When editing Devanagari text, some editor/terminal combinations (vim +
xterm/kconsole) cause problems. Try an X editor instead if this happens
(gvim works well for me) - river
rev 73224
öäü
WARNING: This file is publically viewable on the web. Do not put private data here. ---

I'm not sure most of this needed, but my main concern is the revision number, as I think it's misleading. It doesn't seem to be used any longer. The line below can also probably go. A general examination of the intro would be good.

Version: wmf-deployment
Severity: trivial

Details

Reference: bz48492

Event Timeline

• bzimport raised the priority of this task from to Low.Nov 22 2014, 1:37 AM

• bzimport added a project: Wikimedia-Site-requests.

• bzimport set Reference to bz48492.

• MZMcBride created this task.May 15 2013, 2:49 AM

You can propose a change. It's in https://gerrit.wikimedia.org/r/gitweb?p=operations/mediawiki-config.git;a=summary .

I think the "öäü" falls under "better safe than sorry" (most editors these days should handle it, but no real reason to take it out).

I agree the "rev" is useless.

Can we get rid of the human instructions on how to use vim? Surely those who use vim will know how to use it. And most of us don't use such things anyway.

It would be nice to put a notice saying what the file actually is. What distinguishes it from CommonSettings.php? What can be put in it (presumably any $wgX config variable known by MW)?

Why is this assigned to me? I don't know what I'm doing.

(In reply to comment #3)

I don't know what I'm doing.

Welcome to the club. :-)

Why is this assigned to me?

Comment 2 was insightful and indicated you have a good idea of how to move forward with this bug.

(In reply to comment #2)

presumably any $wgX config variable known by MW)?

And arbitrary variables who trigger a configuration logic in CommonsSettings.php.

What distinguishes it from CommonSettings.php?

InitialiseSettings.php describes the configuration, CommonsSettings.php includes the needed extensions and configures them when needed, based on the InitialiseSettings.php content.

OK, I give in. It bugs me every time I go in to change a setting...

come on bot... https://gerrit.wikimedia.org/r/#/c/76342/

Change 76342 had a related patch set uploaded by Alex Monk:
Clean up headers in CommonSettings and InitialiseSettings

https://gerrit.wikimedia.org/r/76342

Change 76342 merged by jenkins-bot:
Clean up headers in CommonSettings and InitialiseSettings

https://gerrit.wikimedia.org/r/76342

Is this done, MZM? Any more you want cleaned?

(In reply to comment #10)