Mention CLCACHE_SERVER environment variable in README

frerich · Dec 6, 2016 · e9b12a4 · e9b12a4
1 parent 6dd68e3
commit e9b12a4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.asciidoc b/README.asciidoc
@@ -145,6 +145,11 @@ CLCACHE_PROFILE::
     will generate a file with a name similiar to 'clcache-<hashsum>.prof'. You
     can aggregate these files and generate a report by running the
     'showprofilereport.py' script.
+CLCACHE_SERVER::
+    Setting this environment variable will make clcache use (and expect) a
+    running `clcachesrv.py` script which takes care of caching file hashes.
+    This greatly improves performance of cache hits, but only has an effect in
+    direct mode (i.e. when `CLCACHE_NODIRECT` is not set).
 
 Known limitations
 ~~~~~~~~~~~~~~~~~