* (bug 26023) Corrected deleteBacth.php's documentation

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 3cd04ed..80afa03 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -432,6 +432,7 @@ LocalSettings.php. The specific bugs are listed below in the general notes.
 * (bug 20591) There's now a different message on Special:MovePage when
   $wgFixDoubleRedirects is set to false.
 * Fixed PHP warnings when updating a broken MySQL database.
+* (bug 26023) Corrected deleteBacth.php's documentation
 
 === API changes in 1.17 ===
 * (bug 22738) Allow filtering by action type on query=logevent.

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index 19c6a3c..b43742f 100644 (file)
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -673,11 +673,15 @@ abstract class Maintenance {
 
                // ... and append arguments.
                if ( $this->mArgList ) {
-                       $output .= " <";
+                       $output .= ' ';
                        foreach ( $this->mArgList as $k => $arg ) {
-                               $output .= $arg['name'] . ">";
+                               if ( $arg['require'] ) {
+                                       $output .= '<' . $arg['name'] . '>';
+                               } else {
+                                       $output .= '[' . $arg['name'] . ']';
+                               }
                                if ( $k < count( $this->mArgList ) - 1 )
-                                       $output .= " <";
+                                       $output .= ' ';
                        }
                }
                $this->output( "$output\n\n" );
@@ -692,8 +696,10 @@ abstract class Maintenance {
 
                // Arguments description
                foreach ( $this->mArgList as $info ) {
+                       $openChar = $info['require'] ? '<' : '[';
+                       $closeChar = $info['require'] ? '>' : ']';
                        $this->output(
-                               wordwrap( "$tab<" . $info['name'] . ">: " .
+                               wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
                                        $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
                        );
                }

diff --git a/maintenance/deleteBatch.php b/maintenance/deleteBatch.php
index 120ed7e..9571bde 100644 (file)
--- a/maintenance/deleteBatch.php
+++ b/maintenance/deleteBatch.php
@@ -37,7 +37,8 @@ class DeleteBatch extends Maintenance {
                $this->addOption( 'u', "User to perform deletion", false, true );
                $this->addOption( 'r', "Reason to delete page", false, true );
                $this->addOption( 'i', "Interval to sleep between deletions" );
-               $this->addArg( 'listfile', 'File with titles to delete, separated by newlines', false );
+               $this->addArg( 'listfile', 'File with titles to delete, separated by newlines. ' .
+                       'If not given, stdin will be used.', false );
        }
        
        public function execute() {