docs update

diff --git a/docs/deferred.txt b/docs/deferred.txt
index 06155c5..fb9b848 100644 (file)
--- a/docs/deferred.txt
+++ b/docs/deferred.txt
@@ -1,4 +1,3 @@
-
 deferred.txt
 
 A few of the database updates required by various functions here
@@ -25,3 +24,20 @@ may be extended in the future to more general background tasks.
 Job queue items are fetched out of the queue and run either
 at a random rate during regular page views (by default) or by
 a batch process which can be run via maintenance/runJobs.php.
+
+Currently there is some differents types of Jobs:
+
+  refreshLinks
+    Used to refresh the database tables that stores the links
+    beetween pages. When a page is cleared, all pages using these
+    page are also cleared by inseting a new job for all that pages.
+    Each job refresh only one page.
+
+  htmlCacheUpdate
+    clear caches when a template is changed to ensure that changes
+    can be see. Each job clear $wgUpdateRowsPerJob pages (500 by 
+    default).
+
+  enotifNotify
+    used when $wgEnotifUseJobQ is true to send mails using the job 
+    queue.
\ No newline at end of file

diff --git a/docs/linkcache.txt b/docs/linkcache.txt
index 3e9799c..22b40d5 100644 (file)
--- a/docs/linkcache.txt
+++ b/docs/linkcache.txt
@@ -1,18 +1,28 @@
 linkcache.txt
 
-The LinkCache class maintains a list of article titles and
-the information about whether or not the article exists in
-the database. This is used to mark up links when displaying
-a page. If the same link appears more than once on any page,
-then it only has to be looked up once. In most cases, link
-lookups are done in batches with the LinkBatch class, or the
-equivalent in Parser::replaceLinkHolders(), so the link
-cache is mostly useful for short snippets of parsed text
-(such as the site notice), and for links in the navigation
-areas of the skin. 
+The LinkCache class maintains a list of article titles and the information about
+whether or not the article exists in the database. This is used to mark up links
+when displaying a page. If the same link appears more than once on any page,
+then it only has to be looked up once. In most cases, link lookups are done in
+batches with the LinkBatch class, or the equivalent in Parser::replaceLinkHolders(),
+so the link cache is mostly useful for short snippets of parsed text (such as
+the site notice), and for links in the navigation areas of the skin.
 
-The link cache was formerly used to track links used in a
-document for the purposes of updating the link tables. This
-application is now deprecated.
+The content of the LinkCache can be stored in memcached if $wgLinkCacheMemcached
+is set to true. This can reduce the load of the database server as link cache
+will be persistent between requests.
 
+The link cache was formerly used to track links used in a document for the
+purposes of updating the link tables. This application is now deprecated.
 
+To create a batch, you can use the following code:
+
+$pages = array( 'Main Page', 'Project:Help', /* ... */ );
+$titles = array();
+
+foreach( $pages as $page ){
+       $titles[] = Title::newFromText( $page );
+}
+
+$batch = new LinkBatch( $titles );
+$batch->execute();
\ No newline at end of file

diff --git a/docs/skin.txt b/docs/skin.txt
index ce2d0b7..f58805e 100644 (file)
--- a/docs/skin.txt
+++ b/docs/skin.txt
@@ -1,4 +1,3 @@
-
 skin.txt
 
 This document describes the overall architecture of MediaWiki's HTML rendering

diff --git a/maintenance/README b/maintenance/README
index 7ef358b..e4c01b5 100644 (file)
--- a/maintenance/README
+++ b/maintenance/README
@@ -48,8 +48,11 @@ installations.
        dumpBackup.php
        Backup dump script
 
-       dumpHTML.php
-       Produce an HTML dump of a wiki
+       edit.php
+       Edit a page to change its content
+
+       findhooks.php
+       Find hooks that aren't documented in docs/hooks.txt
 
        importDump.php
        XML dump importer
@@ -60,6 +63,12 @@ installations.
        importTextFile.php
        Import the contents of a text file into a wiki page
 
+       moveBatch.php
+       Move a batch of pages 
+
+       namespaceDupes.php
+       Check articles name to see if they conflict with new/existing namespaces
+
        nukePage.php
        Wipe a page and all revisions from the database
 
@@ -84,5 +93,17 @@ installations.
        runJobs.php
        Immediately complete all jobs in the job queue
 
+       stats.php
+       Show all statistics stored in memcached
+
+       undelete.php
+       Undelete all revisions of a page
+
        update.php
        Check and upgrade the database schema to the current version
+
+       updateRestrictions.php
+       Update pages restriction to the new schema
+
+       userOptions.php
+       Change user options
\ No newline at end of file