generate documentation from config.sample.php

admin_manual/configuration_server/config_sample_php_parameters.rst

@@ -72,7 +72,7 @@ necessary security checks.
 Where user files are stored; this defaults to ``data/`` in the ownCloud
 directory. The SQLite database is also stored here, when you use SQLite.
 
-(SQLite is available only in ownCloud Community Edition)
+(SQLite is not available in ownCloud Enterprise Edition)
 
 ::
 
@@ -89,7 +89,7 @@ Identifies the database used with this installation. See also config option
 ``supportedDatabases``
 
 Available:
-	- sqlite (SQLite3 - Community Edition Only)
+	- sqlite (SQLite3 - Not in Enterprise Edition)
 	- mysql (MySQL/MariaDB)
 	- pgsql (PostgreSQL)
 	- oci (Oracle - Enterprise Edition Only)
@@ -926,12 +926,20 @@ Memory caching backend configuration
 ------------------------------------
 
 Available cache backends:
-* \OC\Memcache\APC        Alternative PHP Cache backend
-* \OC\Memcache\APCu       APC user backend
-* \OC\Memcache\ArrayCache In-memory array-based backend (not recommended)
-* \OC\Memcache\Memcached  Memcached backend
-* \OC\Memcache\Redis      Redis backend
-* \OC\Memcache\XCache     XCache backend
+
+* ``\OC\Memcache\APC``        Alternative PHP Cache backend
+* ``\OC\Memcache\APCu``       APC user backend
+* ``\OC\Memcache\ArrayCache`` In-memory array-based backend (not recommended)
+* ``\OC\Memcache\Memcached``  Memcached backend
+* ``\OC\Memcache\Redis``      Redis backend
+* ``\OC\Memcache\XCache``     XCache backend
+
+Advice on choosing between the various backends:
+
+* APCu should be easiest to install. Almost all distributions have packages.
+  Use this for single user environment for all caches.
+* Use Redis or Memcached for distributed environments.
+  For the local cache (you can configure two) take APCu.
 
 
 ::
@@ -939,15 +947,17 @@ Available cache backends:
 	'memcache.local' => '\OC\Memcache\APCu',
 
 Memory caching backend for locally stored data
-Used for host-specific data, e.g. file paths
+
+* Used for host-specific data, e.g. file paths
 
 ::
 
 	'memcache.distributed' => '\OC\Memcache\Memcached',
 
 Memory caching backend for distributed data
-Used for installation-specific data, e.g. database caching
-If unset, defaults to the value of memcache.local
+
+* Used for installation-specific data, e.g. database caching
+* If unset, defaults to the value of memcache.local
 
 ::
 
@@ -1039,7 +1049,7 @@ One way to test is applying for a trystack account at http://trystack.org/
 Database types that are supported for installation.
 
 Available:
-	- sqlite (SQLite3 - Community Edition Only)
+	- sqlite (SQLite3 - Not in Enterprise Edition)
 	- mysql (MySQL)
 	- pgsql (PostgreSQL)
 	- oci (Oracle - Enterprise Edition Only)
@@ -1120,7 +1130,7 @@ using external storages, not recommended for regular use.
 	'asset-pipeline.enabled' => false,
 
 All css and js files will be served by the web server statically in one js
-file and one css file if this is set to ``true``.
+file and one css file if this is set to ``true``. This improves performance.
 
 ::
 
@@ -1175,9 +1185,8 @@ max file size for animating gifs on public-sharing-site.
 
 If the gif is bigger, it'll show a static preview
 
-Value represents the maximum filesize in megabytes
-Default is 10
-Set to -1 for no limit
+Value represents the maximum filesize in megabytes. Default is ``10``. Set to
+``-1`` for no limit.
 
 ::
 
@@ -1200,6 +1209,7 @@ WARNING: BETA quality
 	'memcache.locking' => '\\OC\\Memcache\\Redis',
 
 Memory caching backend for file locking
+
 Because most memcache backends can clean values without warning using redis
 is highly recommended to *avoid data loss*.