summaryrefslogtreecommitdiff
path: root/includes/utils/README
diff options
context:
space:
mode:
Diffstat (limited to 'includes/utils/README')
-rw-r--r--includes/utils/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/includes/utils/README b/includes/utils/README
new file mode 100644
index 00000000..b5b8ec88
--- /dev/null
+++ b/includes/utils/README
@@ -0,0 +1,9 @@
+The classes in this directory are general utilities for use by any part of
+MediaWiki. They do not favour any particular user interface and are not
+constrained to serve any particular feature. This is similar to includes/libs,
+except that some dependency on the MediaWiki framework (such as the use of
+MWException, Status or wfDebug()) disqualifies them from use outside of
+MediaWiki without modification.
+
+Utilities should not use global configuration variables, rather they should rely
+on the caller to configure their behaviour.