Fix indentations, add several comments.

This is a cosmetic modification. Functionally, there is no change.

slapos/recipe/generic_varnish/template/default.vcl.in

@@ -20,17 +20,14 @@ backend default {
             "User-Agent: Varnish";
     }
 }
-#
-#Below is a commented-out copy of the default VCL logic.  If you
-#redefine any of these subroutines, the built-in logic will be
-#appended to your code.
-#
 
+# Called at the beginning of a request, after the complete request has been received and parsed
 sub vcl_recv {
     # Force lookup if the request is a no-cache request from the client
     if (req.http.cache-control ~ "no-cache") {
         ban_url(req.url);
     }
+    # Pass any requests that Varnish does not understand straight to the backend.
     if (req.request != "GET" &&
         req.request != "HEAD" &&
         req.request != "PUT" &&
@@ -42,6 +39,7 @@ sub vcl_recv {
         /* Non-RFC2616 or CONNECT which is weird. */
         return(pipe);
     }
+    # Pass anything other than GET and HEAD and PURGE directly.
     if (req.request != "GET" && req.request != "HEAD" && req.request != "PURGE") {
         /* We only deal with GET and HEAD by default */
         return(pass);
@@ -71,7 +69,9 @@ sub vcl_recv {
             return (pass);
         }
     }
+    # XXX Is it OK to remove this of all the case?
     remove req.http.Set-Cookie;
+
     if (req.http.Accept-Encoding) {
         if (req.http.Accept-Encoding ~ "gzip") {
             set req.http.Accept-Encoding = "gzip";
@@ -84,14 +84,6 @@ sub vcl_recv {
     }
     # We do not care about Accept-Language, this is url controlled
     remove req.http.Accept-Language;
-  #if (req.request == "PURGE") {
-  #  if (!client.ip ~ purge) {
-  #    error 405 "Not allowed.";
-  #  }
-  #  purge_url(req.url);
-  #  error 200 "HASHPURGED";
-  #  unset req.http.x;
-  #}
 
     ## XXX login form can defer based on __ac_name cookie value
     if (req.url ~ "/(login_form|WebSite_viewLoginDialog)($|\?)") {
@@ -106,22 +98,14 @@ sub vcl_recv {
     return(lookup);
 }
 
+# Creates the varnish cache key by the url
 sub vcl_hash {
     hash_data(req.url);
     return(hash);
 }
 
+# Called after a cache lookup if the requested document was found in the cache
 sub vcl_hit {
-   #if (req.request == "PURGE" && client.ip ~ purge) {
-   #  set obj.ttl = 0s;
-   #  error 200 "Purged.";
-   #}
-
-   #if (client.ip ~ purge){
-   #  # Force refresh from localhost
-   #  set obj.ttl = 0s;
-   #  return (restart);
-   #}
     # According Vary Header do not return those headers
     remove req.http.Accept-Language;
     remove req.http.Accept-Encoding;
@@ -129,10 +113,12 @@ sub vcl_hit {
     return(deliver);
 }
 
+# Called after a cache lookup if the requested document was not found in the cache
 sub vcl_miss {
     return(fetch);
 }
 
+# Called after a document has been successfully retrieved from the backend
 sub vcl_fetch {
     # we only cache 200 (OK) and 304 (Not Modified) responses.
     if (beresp.status != 200 && beresp.status != 304) {
@@ -170,7 +156,6 @@ sub vcl_fetch {
     /* Never send request to backend even if client ask refreshed content */
     if (beresp.ttl > 0s) {
         /* Setup grace period for 30days for all cacheable contents */
-      #set req.grace = 30d;
         set beresp.grace = 30d;
         /* Remove Expires from backend, it's not long enough */
         unset beresp.http.expires;
@@ -181,10 +166,11 @@ sub vcl_fetch {
         /* marker for vcl_deliver to reset Age: */
         set beresp.http.magicmarker = "1";
     }
-   return(deliver);
-   }
 
+    return(deliver);
+}
 
+# Called before a cached object is delivered to the client
 sub vcl_deliver {
     if (resp.http.magicmarker) {
         /* Remove the magic marker */
@@ -197,11 +183,5 @@ sub vcl_deliver {
     } else {
         set resp.http.X-Cache = "MISS";
     }
-   #if (obj.hash) {
-   #  set resp.http.X-Hash = obj.hash;
-   #} else {
-   #  set resp.http.X-Hash = "No hash";
-   #}
-
     return(deliver);
 }