r107122 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r107121‎ | r107122 | r107123 >
Date:23:18, 22 December 2011
Author:aaron
Status:ok (Comments)
Tags:
Comment:
Documentation fixes
Modified paths:
  • /trunk/phase3/includes/filerepo/backend/FileBackend.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/filerepo/backend/FileBackend.php
@@ -406,7 +406,7 @@
407407 * Callers should consider using getScopedFileLocks() instead.
408408 *
409409 * @param $paths Array Storage paths
410 - * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
 410+ * @param $type integer LockManager::LOCK_* constant
411411 * @return Status
412412 */
413413 final public function lockFiles( array $paths, $type ) {
@@ -417,7 +417,7 @@
418418 * Unlock the files at the given storage paths in the backend.
419419 *
420420 * @param $paths Array Storage paths
421 - * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
 421+ * @param $type integer LockManager::LOCK_* constant
422422 * @return Status
423423 */
424424 final public function unlockFiles( array $paths, $type ) {
@@ -433,7 +433,7 @@
434434 * the status updated. Unlock fatals will not change the status "OK" value.
435435 *
436436 * @param $paths Array Storage paths
437 - * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
 437+ * @param $type integer LockManager::LOCK_* constant
438438 * @param $status Status Status to update on lock/unlock
439439 * @return ScopedLock|null Returns null on failure
440440 */
@@ -460,7 +460,7 @@
461461 * $params include:
462462 * src : source path on disk
463463 * dst : destination storage path
464 - * overwriteDest : do nothing and pass if an identical file exists at destination
 464+ * overwriteDest : overwrite any file that exists at the destination
465465 *
466466 * @param $params Array
467467 * @return Status
@@ -482,7 +482,7 @@
483483 * $params include:
484484 * src : source storage path
485485 * dst : destination storage path
486 - * overwriteDest : do nothing and pass if an identical file exists at destination
 486+ * overwriteDest : overwrite any file that exists at the destination
487487 *
488488 * @param $params Array
489489 * @return Status
@@ -502,7 +502,8 @@
503503 * Delete a file at the storage path.
504504 * Do not call this function from places outside FileBackend and FileOp.
505505 * $params include:
506 - * src : source storage path
 506+ * src : source storage path
 507+ * ignoreMissingSource : do nothing if the source file does not exist
507508 *
508509 * @param $params Array
509510 * @return Status
@@ -524,7 +525,7 @@
525526 * $params include:
526527 * src : source storage path
527528 * dst : destination storage path
528 - * overwriteDest : do nothing and pass if an identical file exists at destination
 529+ * overwriteDest : overwrite any file that exists at the destination
529530 *
530531 * @param $params Array
531532 * @return Status
@@ -556,7 +557,7 @@
557558 * $params include:
558559 * srcs : ordered source storage paths (e.g. chunk1, chunk2, ...)
559560 * dst : destination storage path
560 - * overwriteDest : do nothing and pass if an identical file exists at destination
 561+ * overwriteDest : overwrite any file that exists at the destination
561562 *
562563 * @param $params Array
563564 * @return Status
@@ -578,7 +579,7 @@
579580 * $params include:
580581 * content : the raw file contents
581582 * dst : destination storage path
582 - * overwriteDest : do nothing and pass if an identical file exists at destination
 583+ * overwriteDest : overwrite any file that exists at the destination
583584 *
584585 * @param $params Array
585586 * @return Status

Comments

#Comment by Nikerabbit (talk | contribs)   13:48, 23 December 2011

Some duplication here?

Status & tagging log