r105608 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r105607‎ | r105608 | r105609 >
Date:23:17, 8 December 2011
Author:tstarling
Status:ok
Tags:
Comment:
Fixed some minor issues with comments.
Modified paths:
  • /branches/FileBackend/phase3/includes/filerepo/backend/FSFileBackend.php (modified) (history)
  • /branches/FileBackend/phase3/includes/filerepo/backend/FileBackend.php (modified) (history)
  • /branches/FileBackend/phase3/includes/filerepo/backend/FileBackendMultiWrite.php (modified) (history)
  • /branches/FileBackend/phase3/includes/filerepo/backend/FileOp.php (modified) (history)
  • /branches/FileBackend/phase3/includes/filerepo/backend/LockManager.php (modified) (history)

Diff [purge]

Index: branches/FileBackend/phase3/includes/filerepo/backend/FileBackendMultiWrite.php
@@ -30,7 +30,7 @@
3131 protected $masterIndex = -1; // index of master backend
3232
3333 /**
34 - * Construct a proxy backend that consist of several internal backends.
 34+ * Construct a proxy backend that consists of several internal backends.
3535 * $config contains:
3636 * 'name' : The name of the proxy backend
3737 * 'lockManager' : Registered name of the file lock manager to use
Index: branches/FileBackend/phase3/includes/filerepo/backend/FileOp.php
@@ -8,7 +8,7 @@
99 * Helper class for representing operations with transaction support.
1010 * FileBackend::doOperations() will require these classes for supported operations.
1111 *
12 - * Access use of large fields should be avoided as we want to be able to support
 12+ * Use of large fields should be avoided as we want to be able to support
1313 * potentially many FileOp classes in large arrays in memory.
1414 *
1515 * @ingroup FileBackend
Index: branches/FileBackend/phase3/includes/filerepo/backend/FSFileBackend.php
@@ -7,7 +7,7 @@
88 /**
99 * Class for a file system based file backend.
1010 * Status messages should avoid mentioning the internal FS paths.
11 - * Likewise, error suppression should be used to path disclosure.
 11+ * Likewise, error suppression should be used to avoid path disclosure.
1212 *
1313 * @ingroup FileBackend
1414 */
Index: branches/FileBackend/phase3/includes/filerepo/backend/LockManager.php
@@ -3,7 +3,7 @@
44 * FileBackend helper class for handling file locking.
55 * Locks on resource keys can either be shared or exclusive.
66 *
7 - * Implemenations can keep track of what is locked in the process cache.
 7+ * Implementations can keep track of what is locked in the process cache.
88 * This can reduce hits to external resources for lock()/unlock() calls.
99 *
1010 * Subclasses should avoid throwing exceptions at all costs.
Index: branches/FileBackend/phase3/includes/filerepo/backend/FileBackend.php
@@ -64,7 +64,7 @@
6565 *
6666 * Using $ops:
6767 * $ops is an array of arrays. The first array holds a list of operations.
68 - * The inner array contains the parameters, E.G:
 68+ * The inner array contains the parameters, e.g:
6969 * <code>
7070 * $ops = array(
7171 * array(
@@ -94,7 +94,7 @@
9595
9696 /**
9797 * Prepare a storage path for usage. This will create containers
98 - * that don't yet exists or, on FS backends, create parent directories.
 98+ * that don't yet exist or, on FS backends, create parent directories.
9999 *
100100 * $params include:
101101 * dir : storage directory
@@ -350,7 +350,7 @@
351351 abstract public function delete( array $params );
352352
353353 /**
354 - * Combines files from severals storage paths into a new file in the backend.
 354+ * Combines files from several storage paths into a new file in the backend.
355355 * Do not call this function from places outside FileBackend and FileOp.
356356 * $params include:
357357 * srcs : ordered source storage paths (e.g. chunk1, chunk2, ...)
@@ -388,10 +388,10 @@
389389 }
390390
391391 /**
392 - * Whether this backend implements move() and it applies to a potential
393 - * move from one storage path to another. No backends hits are required.
394 - * For example, moving objects accross containers may not be supported.
395 - * Do not call this function from places outside FileBackend and FileOp.
 392+ * Whether this backend can perform a move from one storage path to another.
 393+ * No backend hits are required. For example, moving objects across
 394+ * containers may not be supported. Do not call this function from places
 395+ * outside FileBackend and FileOp.
396396 * $params include:
397397 * src : source storage path
398398 * dst : destination storage path
@@ -623,7 +623,7 @@
624624
625625 /**
626626 * Validate and normalize a relative storage path.
627 - * Null is returned if the path involves directory traveral.
 627+ * Null is returned if the path involves directory traversal.
628628 * Traversal is insecure for FS backends and likely broken for others.
629629 *
630630 * @param $path string

Status & tagging log