Aaron Schulz has uploaded a new change for review.
https://gerrit.wikimedia.org/r/55839
Change subject: Clarified FileBackend::doOperations() docs a bit more.
......................................................................
Clarified FileBackend::doOperations() docs a bit more.
Change-Id: Ie0b131c1a09bc75be39bbb7e9c87b8d3221a0fc5
---
M includes/filebackend/FileBackend.php
1 file changed, 12 insertions(+), 11 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/39/55839/1
diff --git a/includes/filebackend/FileBackend.php
b/includes/filebackend/FileBackend.php
index 2d6d2d7..9a5ab2e 100644
--- a/includes/filebackend/FileBackend.php
+++ b/includes/filebackend/FileBackend.php
@@ -261,18 +261,19 @@
* - ignoreMissingSource : The operation will simply succeed and do
* nothing if the source file does not exist.
* - overwrite : Any destination file will be overwritten.
- * - overwriteSame : If a file already exists at the
destination with the
- * same contents, then do nothing to the
destination file
- * instead of giving an error. This does not
compare headers.
+ * - overwriteSame : The operation will simply succeed and do
nothing if the
+ * destination file already exists with the
same contents.
+ * This does not compare file headers of the
source/destination.
* This option is ignored if 'overwrite' is
already provided.
- * - headers : If supplied, the backend will return these
headers when
- * GETs/HEADs of the destination file are
made. Header values
- * should be smaller than 256 bytes, often
options or numbers.
- * Content-Disposition headers can be longer,
though the system
- * might ignore or truncate ones that are too
long to store.
- * Existing headers will remain, but these
will replace any
- * conflicting previous headers, and headers
will be removed
- * if they are set to an empty string.
+ * - headers : If supplied, the result of merging these
headers with any
+ * existing source file headers (replacing
conflicting ones)
+ * will be set as the destination file
headers. Headers are
+ * deleted if their value is set to the empty
string. When a
+ * file has headers they are included in
responses to GET and
+ * HEAD requests to the backing store for
that file.
+ * Header values should be no larger than 255
bytes, except for
+ * Content-Disposition. The system might
ignore or truncate any
+ * headers that are too long to store (exact
limits will vary).
* Backends that don't support metadata
ignore this. (since 1.21)
*
* $opts is an associative of boolean flags, including:
--
To view, visit https://gerrit.wikimedia.org/r/55839
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie0b131c1a09bc75be39bbb7e9c87b8d3221a0fc5
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Aaron Schulz <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
