r1567 - trunk/varnish-cache/man

[des at projects.linpro.no]

Author: des
Date: 2007-06-25 17:54:22 +0200 (Mon, 25 Jun 2007)
New Revision: 1567

Modified:
   trunk/varnish-cache/man/vcl.7
Log:
Document vcl_discard().


Modified: trunk/varnish-cache/man/vcl.7
===================================================================
--- trunk/varnish-cache/man/vcl.7	2007-06-25 14:24:49 UTC (rev 1566)
+++ trunk/varnish-cache/man/vcl.7	2007-06-25 15:54:22 UTC (rev 1567)
@@ -28,7 +28,7 @@
 .\"
 .\" $Id$
 .\"
-.Dd March 28, 2007
+.Dd June 25, 2007
 .Dt VCL 7
 .Os
 .Sh NAME
@@ -285,8 +285,8 @@
 .El
 .\" vcl_timeout
 .It Cm vcl_timeout
-Called by the reaper thread when a cached document has reached its
-expiry time.
+Called by the reaper thread shortly before a cached document reaches
+its expiry time.
 .Pp
 The
 .Cm vcl_timeout
@@ -297,7 +297,22 @@
 .It Cm discard
 Discard the object.
 .El
+.\" vcl_discard
+.It Cm vcl_discard
+Called by the reaper thread when a cached document is about to be
+discarded, either because it has expired or because space is running
+low.
+.Pp
+The
+.Cm vcl_discard
+subroutine may terminate with one of the following keywords:
+.Bl -tag -width "discard"
+.It Cm discard
+Discard the object.
+.It Cm keep
+Keep the object in cache.
 .El
+.El
 .Pp
 If one of these subroutines is left undefined or terminates without
 reaching a handling decision, control will be handed over to the
@@ -408,6 +423,10 @@
     insert;
 }
 
+sub vcl_discard {
+    discard;
+}
+
 sub vcl_timeout {
     discard;
 }