[4.0] 79f4c29 Document how comments work in VCL.
Lasse Karstensen
lkarsten at varnish-software.com
Thu Jan 15 16:35:39 CET 2015
commit 79f4c2931fdc210de812d9e73a5c1a69d4f973cf
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date: Wed Oct 8 17:21:27 2014 +0200
Document how comments work in VCL.
This was mentioned in the user guide, but not in the man
page itself.
Pointed out by: Brett Fitzgerald
diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index 90ac019..a621e4f 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -166,6 +166,21 @@ Example::
std.log("foo");
}
+Comments
+--------
+
+Single lines of VCL can be commented out using // or #. Multi-line blocks can
+be commented out with \/\* block \/\*.
+
+Example::
+
+ sub vcl_recv {
+ // Single line of out-commented VCL.
+ # Another way of commenting out a single line.
+ /*
+ Multi-line block of commented-out VCL.
+ */
+ }
Backend definition
More information about the varnish-commit
mailing list