(bug 18432) Updated documentation for dumpBackup.php (patch contributed by Jidanni)

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 2f80f48..b2f2c1b 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -130,6 +130,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
 * (bug 18389) Localise numbers in EXIF data
 * (bug 18522) Wrap MediaWiki:Protect-cascadeon in a div for identification
 * (bug 18438) Tweak HTML for preview bar for consistency and accessibility
+* (bug 18432) Updated documentation for dumpBackup.php
 
 == API changes in 1.16 ==
 

diff --git a/maintenance/dumpBackup.php b/maintenance/dumpBackup.php
index 0e28734..40d9b56 100644 (file)
--- a/maintenance/dumpBackup.php
+++ b/maintenance/dumpBackup.php
@@ -69,30 +69,30 @@ if( isset( $options['full'] ) ) {
        $dumper->dump( WikiExporter::LOGS );
 } else {
        $dumper->progress( <<<ENDS
-This script dumps the wiki page database into an XML interchange wrapper
-format for export or backup.
+This script dumps the wiki page or logging database into an
+XML interchange wrapper format for export or backup.
 
 XML output is sent to stdout; progress reports are sent to stderr.
 
 Usage: php dumpBackup.php <action> [<options>]
 Actions:
-  --full      Dump complete history of every page.
-  --current   Includes only the latest revision of each page.
-  --logs      Dump action logs for every page.
+  --full      Dump all revisions of every page.
+  --current   Dump only the latest revision of every page.
+  --logs      Dump all log events.
 
 Options:
   --quiet     Don't dump status reports to stderr.
   --report=n  Report position and speed after every n pages processed.
               (Default: 100)
   --server=h  Force reading from MySQL server h
-  --start=n   Start from page_id n
-  --end=n     Stop before page_id n (exclusive)
+  --start=n   Start from page_id or log_id n
+  --end=n     Stop before page_id or log_id n (exclusive)
   --skip-header Don't output the <mediawiki> header
   --skip-footer Don't output the </mediawiki> footer
   --stub      Don't perform old_text lookups; for 2-pass dump
   --uploads   Include upload records (experimental)
 
-Fancy stuff:
+Fancy stuff: (Works? Add examples please.)
   --plugin=<class>[:<file>]   Load a dump plugin class
   --output=<type>:<file>      Begin a filtered output stream;
                               <type>s: file, gzip, bzip2, 7zip
@@ -101,5 +101,3 @@ Fancy stuff:
 ENDS
 );
 }
-
-