r5167 - trunk/varnish-cache/doc/sphinx/reference

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-09-06 14:03:43 +0200 (Mon, 06 Sep 2010)
New Revision: 5167

Modified:
   trunk/varnish-cache/doc/sphinx/reference/varnishd.rst
   trunk/varnish-cache/doc/sphinx/reference/varnishtest.rst
   trunk/varnish-cache/doc/sphinx/reference/vcl.rst
Log:
rewrite beresp/obj.cacheable (thanks DocWilco) and fixed some formatting errors

Modified: trunk/varnish-cache/doc/sphinx/reference/varnishd.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/varnishd.rst	2010-08-31 11:56:08 UTC (rev 5166)
+++ trunk/varnish-cache/doc/sphinx/reference/varnishd.rst	2010-09-06 12:03:43 UTC (rev 5167)
@@ -33,7 +33,7 @@
 =======
 
 -a address[:port][,address[:port][...]
-            Listen for client requests on the specified address and port.  The address can be a host
+	    Listen for client requests on the specified address and port.  The address can be a host
             name (“localhost”), an IPv4 dotted-quad (“127.0.0.1”), or an IPv6 address enclosed in
             square brackets (“[::1]”).  If address is not specified, varnishd will listen on all
             available IPv4 and IPv6 interfaces.  If port is not specified, the default HTTP port as
@@ -93,24 +93,30 @@
             Offer a management interface on the specified address and port.  See Management
             Interface for a list of management commands.
 
--t ttl      Specifies a hard minimum time to live for cached documents.  This is a shortcut for
+-t ttl      
+   	    Specifies a hard minimum time to live for cached documents.  This is a shortcut for
             specifying the default_ttl run-time parameter.
 
--u user     Specifies the name of an unprivileged user to which the child process should switch
-            before it starts accepting connections.  This is a shortcut for specifying the user run-
-            time parameter.
+-u user     Specifies the name of an unprivileged user to which the child
+            process should switch before it starts accepting
+            connections.  This is a shortcut for specifying the user
+            run- time parameter.
 	    
-            If specifying both a user and a group, the user should be specified first.
+            If specifying both a user and a group, the user should be
+            specified first.
 
 -V          Display the version number and exit.
 
 -w min[,max[,timeout]]
-            Start at least min but no more than max worker threads with the specified idle timeout.
-            This is a shortcut for specifying the thread_pool_min, thread_pool_max and
+
+            Start at least min but no more than max worker threads
+            with the specified idle timeout.  This is a shortcut for
+            specifying the thread_pool_min, thread_pool_max and
             thread_pool_timeout run-time parameters.
 
-            If only one number is specified, thread_pool_min and thread_pool_max are both set to
-            this number, and thread_pool_timeout has no effect.
+            If only one number is specified, thread_pool_min and
+            thread_pool_max are both set to this number, and
+            thread_pool_timeout has no effect.
 
 
 

Modified: trunk/varnish-cache/doc/sphinx/reference/varnishtest.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/varnishtest.rst	2010-08-31 11:56:08 UTC (rev 5166)
+++ trunk/varnish-cache/doc/sphinx/reference/varnishtest.rst	2010-09-06 12:03:43 UTC (rev 5167)
@@ -23,7 +23,7 @@
 varnish HTTP accelerator.
 
 The varnishtest program, when started and given one or more script
-files, can create a number of threads repre senting backends, some
+files, can create a number of threads representing backends, some
 threads representing clients, and a varnishd process.
 
 The following options are available:

Modified: trunk/varnish-cache/doc/sphinx/reference/vcl.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-08-31 11:56:08 UTC (rev 5166)
+++ trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-06 12:03:43 UTC (rev 5167)
@@ -543,19 +543,20 @@
   The HTTP status code returned by the server.
 
 beresp.response
-The HTTP status message returned by the server.
+  The HTTP status message returned by the server.
 
 beresp.cacheable
   True if the request resulted in a cacheable response.  A response is
-  considered cacheable if it is valid (see above), and the HTTP status
-  code is 200, 203, 300, 301, 302, 404 or 410.
+  considered cacheable if it has no Set-Cookies or Authentication, 
+  and the HTTP status code is 200, 203, 300, 301, 302, 404 or 410.
+  beresp.cacheable is writable.
 
 beresp.ttl
-  The object's remaining time to live, in seconds.
+  The object's remaining time to live, in seconds. beresp.ttl is writable.
 
-After the object is entered into the cache, the following (mostyl
+After the object is entered into the cache, the following (mostly
 read-only) variables are available when the object has been located in
-cache:
+cache, typically in vcl_hit and vcl_deliver.
 
 obj.proto
   The HTTP protocol version used when the object was retrieved.
@@ -564,15 +565,14 @@
   The HTTP status code returned by the server.
 
 obj.response
-The HTTP status message returned by the server.
+  The HTTP status message returned by the server.
 
 obj.cacheable
-  True if the request resulted in a cacheable response.  A response is
-  considered cacheable if it is valid (see above), and the HTTP status
-  code is 200, 203, 300, 301, 302, 404 or 410.
+  True if the object had beresp.cacheable. Unless you've forced delivery
+  in your VCL obj.cacheable will always be true.
 
 obj.ttl
-  The object's remaining time to live, in seconds.
+  The object's remaining time to live, in seconds. obj.ttl is writable.
 
 obj.lastuse
   The approximate time elapsed since the object was last requests, in