Changeset 927 for trunk/xcache.ini

Timestamp:

2012-06-26T06:21:04+02:00 (11 months ago)

Author:

moo

Message:

improve notes in ini

File:

• trunk/xcache.ini (modified) (4 diffs)

trunk/xcache.ini

@@ +1 @@
+;; this is an example, it won't work unless properly configured into php.ini
 [xcache-common]
-;; install as zend extension (recommended), normally "$extension_dir/xcache.so"
+;; WARNING: zend_extension* = *xcache* MUST be the first(above) of all zend_extension*=*
+;; using extension=xcache.so is not recommended
+
+;; non-windows example
+;; update xxx accordingly
 zend_extension = /usr/local/lib/php/extensions/non-debug-non-zts-xxx/xcache.so
-; zend_extension_ts = /usr/local/lib/php/extensions/non-debug-zts-xxx/xcache.so
-;; For windows users, replace xcache.so with php_xcache.dll
+;; windows example:
 zend_extension_ts = c:/php/extensions/php_xcache.dll
-;; or install as extension, make sure your extension_dir setting is correct
-; extension = xcache.so
-;; or win32:
-; extension = php_xcache.dll
+;; for newer PHP, _ts is removed, use the following line instead
+zend_extension = c:/php/extensions/php_xcache.dll
 
 [xcache.admin]
 xcache.admin.enable_auth = On
 xcache.admin.user = "mOo"
-; xcache.admin.pass = md5($your_password)
+; set xcache.admin.pass = md5($your_password)
+; login use $your_password
 xcache.admin.pass = ""
 
@@ -37 +40 @@
 xcache.var_count =             1
 xcache.var_slots =            8K
-; default ttl
+; default value for $ttl parameter of xcache_*() functions
 xcache.var_ttl   =             0
+; hard limit ttl that cannot be exceed by xcache_*() functions. 0=unlimited
 xcache.var_maxttl   =          0
 xcache.var_gc_interval =     300
@@ -44 +48 @@
 ; N/A for /dev/zero
 xcache.readonly_protection = Off
-; for *nix, xcache.mmap_path is a file path, not directory.
-; Use something like "/tmp/xcache" if you want to turn on ReadonlyProtection
-; 2 group of php won't share the same /tmp/xcache
+; for *nix, xcache.mmap_path is a file path, not directory. (auto create/overwrite)
+; Use something like "/tmp/xcache" instead of "/dev/*" if you want to turn on ReadonlyProtection
+; different process group of php won't share the same /tmp/xcache
 ; for win32, xcache.mmap_path=anonymous map name, not file path
 xcache.mmap_path =    "/dev/zero"
@@ -55 +59 @@
 xcache.coredump_directory =   ""
 
-; per request settings
+; enable experimental documented features for each release if available
+xcache.experimental =        Off
+
+; per request settings. can ini_set, .htaccess etc
 xcache.cacher =               On
 xcache.stat   =               On
 xcache.optimizer =           Off
 
-xcache.test =                Off
-xcache.experimental =        Off
+[xcache.coverager]
+; enabling this feature will impact performance
+; enable only if xcache.coverager == On && xcache.coveragedump_directory == "non-empty-value"
 
-[xcache.coverager]
-; per request settings
-; enable coverage data collecting for xcache.coveragedump_directory and xcache_coverager_start/stop/get/clean() functions (will hurt executing performance)
+; per request settings. can ini_set, .htaccess etc
+; enable coverage data collecting and xcache_coverager_start/stop/get/clean() functions
 xcache.coverager =          Off
 
-; ini only settings
+; set in php ini file only
 ; make sure it's readable (open_basedir is checked) by coverage viewer script
-; requires xcache.coverager=On
 xcache.coveragedump_directory = ""