summaryrefslogtreecommitdiff
path: root/maintenance
diff options
context:
space:
mode:
Diffstat (limited to 'maintenance')
-rw-r--r--maintenance/Doxyfile4
-rw-r--r--maintenance/language/messages.inc10
-rw-r--r--maintenance/mwdocgen.php47
3 files changed, 17 insertions, 44 deletions
diff --git a/maintenance/Doxyfile b/maintenance/Doxyfile
index b60a1962..e3ba4e5a 100644
--- a/maintenance/Doxyfile
+++ b/maintenance/Doxyfile
@@ -5,7 +5,6 @@
# {{OUTPUT_DIRECTORY}}
# {{CURRENT_VERSION}}
# {{STRIP_FROM_PATH}}
-# {{SVNSTAT}}
# {{INPUT}}
#
# To generate documentation run: php mwdocgen.php --no-extensions
@@ -114,7 +113,7 @@ SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = NO
-FILE_VERSION_FILTER = {{SVNSTAT}}
+FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
#---------------------------------------------------------------------------
@@ -174,7 +173,6 @@ FILE_PATTERNS = *.c \
*.MM \
*.PY
RECURSIVE = YES
-EXCLUDE = {{EXCLUDE}}
EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
EXCLUDE_SYMBOLS =
diff --git a/maintenance/language/messages.inc b/maintenance/language/messages.inc
index 29269175..baa0c96e 100644
--- a/maintenance/language/messages.inc
+++ b/maintenance/language/messages.inc
@@ -3821,7 +3821,7 @@ XHTML id names.",
'errors' => 'General errors',
'virus' => 'Virus scanner',
'login' => 'Login and logout pages',
- 'mail' => 'E-mail sending',
+ 'mail' => 'Email sending',
'passwordstrength' => 'JavaScript password checks',
'resetpass' => 'Change password dialog',
'passwordreset' => 'Special:PasswordReset',
@@ -3842,7 +3842,7 @@ XHTML id names.",
'opensearch' => 'OpenSearch description',
'quickbar' => 'Quickbar',
'preferences' => 'Preferences page',
- 'preferences-email' => 'User preference: e-mail validation using jQuery',
+ 'preferences-email' => 'User preference: email validation using jQuery',
'userrights' => 'User rights',
'group' => 'Groups',
'group-member' => '',
@@ -3891,7 +3891,7 @@ XHTML id names.",
'activeusers' => 'Special:ActiveUsers',
'newuserlog' => 'Special:Log/newusers',
'listgrouprights' => 'Special:ListGroupRights',
- 'emailuser' => 'E-mail user',
+ 'emailuser' => 'Email user',
'usermessage' => 'User Messenger',
'watchlist' => 'Watchlist',
'watching' => 'Displayed when you click the "watch" button and it is in the process of watching',
@@ -3933,8 +3933,6 @@ XHTML id names.",
'video-info' => 'Video information, used by Language::formatTimePeriod() to format lengths in the above messages',
'badimagelist' => 'Bad image list',
'variantname-zh' => "Short names for language variants used for language conversion links.
-To disable showing a particular link, set it to 'disable', e.g.
-'variantname-zh-sg' => 'disable',
Variants for Chinese language",
'variantname-gan' => 'Variants for Gan language',
'variantname-sr' => 'Variants for Serbian language',
@@ -3993,7 +3991,7 @@ Variants for Chinese language",
'exif-urgency' => '',
'edit-externally' => 'External editor support',
'all' => "'all' in various places, this might be different for inflected languages",
- 'confirmemail' => 'E-mail address confirmation',
+ 'confirmemail' => 'Email address confirmation',
'scarytransclusion' => 'Scary transclusion',
'deleteconflict' => 'Delete conflict',
'unit-pixel' => '',
diff --git a/maintenance/mwdocgen.php b/maintenance/mwdocgen.php
index 583249a5..37e626ba 100644
--- a/maintenance/mwdocgen.php
+++ b/maintenance/mwdocgen.php
@@ -60,12 +60,11 @@ $doxygenTemplate = $mwPath . 'maintenance/Doxyfile';
/** doxygen input filter to tweak source file before they are parsed */
$doxygenInputFilter = "php {$mwPath}maintenance/mwdoc-filter.php";
-/** svnstat command, used to get the version of each file */
-$svnstat = $mwPath . 'bin/svnstat';
-
/** where Phpdoc should output documentation */
$doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ;
+$doxyVersion = 'master';
+
/** MediaWiki subpaths */
$mwPathI = $mwPath . 'includes/';
$mwPathL = $mwPath . 'languages/';
@@ -105,30 +104,11 @@ function readaline( $prompt = '' ) {
}
/**
- * Copied from SpecialVersion::getSvnRevision()
- * @param $dir String
- * @return Mixed: string or false
- */
-function getSvnRevision( $dir ) {
- // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
- $entries = $dir . '/.svn/entries';
-
- if ( !file_exists( $entries ) ) {
- return false;
- }
-
- $content = file( $entries );
-
- return intval( $content[3] );
-}
-
-/**
* Generate a configuration file given user parameters and return the temporary filename.
* @param $doxygenTemplate String: full path for the template.
* @param $outputDirectory String: directory where the stuff will be output.
* @param $stripFromPath String: path that should be stripped out (usually mediawiki base path).
* @param $currentVersion String: Version number of the software
- * @param $svnstat String: path to the svnstat file
* @param $input String: Path to analyze.
* @param $exclude String: Additionals path regex to exclude
* @param $excludePatterns String: Additionals path regex to exclude
@@ -136,7 +116,7 @@ function getSvnRevision( $dir ) {
* @param $doxyGenerateMan Boolean
* @return string
*/
-function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input, $exclude, $excludePatterns, $doxyGenerateMan ) {
+function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $input, $exclude, $excludePatterns, $doxyGenerateMan ) {
global $doxygenInputFilter;
$template = file_get_contents( $doxygenTemplate );
@@ -145,7 +125,6 @@ function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath,
'{{OUTPUT_DIRECTORY}}' => $outputDirectory,
'{{STRIP_FROM_PATH}}' => $stripFromPath,
'{{CURRENT_VERSION}}' => $currentVersion,
- '{{SVNSTAT}}' => $svnstat,
'{{INPUT}}' => $input,
'{{EXCLUDE}}' => $exclude,
'{{EXCLUDE_PATTERNS}}' => $excludePatterns,
@@ -188,6 +167,12 @@ if ( is_array( $argv ) ) {
$doxyOutput = realpath( $argv[$i] );
}
break;
+ case '--version':
+ $i++;
+ if ( isset( $argv[$i] ) ) {
+ $doxyVersion = $argv[$i];
+ }
+ break;
case '--generate-man':
$doxyGenerateMan = true;
break;
@@ -207,8 +192,9 @@ Commands:
If no command is given, you will be prompted.
Other options:
- --output <dir> Set output directory (default $doxyOutput)
+ --output <dir> Set output directory (default: $doxyOutput)
--generate-man Generates man page documentation
+ --version Project version to display in the outut (default: $doxyVersion)
--help Show this help and exit.
@@ -258,20 +244,11 @@ case 6:
$excludePatterns = 'extensions';
}
-$versionNumber = getSvnRevision( $input );
-if ( $versionNumber === false ) { # Not using subversion ?
- $svnstat = ''; # Not really useful if subversion not available
- # @todo FIXME
- $version = 'trunk';
-} else {
- $version = "trunk (r$versionNumber)";
-}
-
// Generate path exclusions
$excludedPaths = $mwPath . join( " $mwPath", $mwExcludePaths );
print "EXCLUDE: $excludedPaths\n\n";
-$generatedConf = generateConfigFile( $doxygenTemplate, $doxyOutput, $mwPath, $version, $svnstat, $input, $excludedPaths, $excludePatterns, $doxyGenerateMan );
+$generatedConf = generateConfigFile( $doxygenTemplate, $doxyOutput, $mwPath, $doxyVersion, $input, $excludedPaths, $excludePatterns, $doxyGenerateMan );
$command = $doxygenBin . ' ' . $generatedConf;
echo <<<TEXT