[master] 3f9a134 Fix rst warnings (markup)

[Tollef Fog Heen]

commit 3f9a13417658da18db318dce49048513c3f603b3
Author: Tollef Fog Heen <tfheen at varnish-software.com>
Date:   Thu Jan 27 12:29:07 2011 +0100

    Fix rst warnings (markup)
    
    Various markup problems as reported by sphinx.

diff --git a/doc/sphinx/phk/gzip.rst b/doc/sphinx/phk/gzip.rst
index a87034a..53bb1c9 100644
--- a/doc/sphinx/phk/gzip.rst
+++ b/doc/sphinx/phk/gzip.rst
@@ -89,7 +89,7 @@ the backend didn't send us a gzip'ed object.
 
 Remember that a lot of content types cannot sensibly be gziped, most
 notably compressed image formats like jpeg, png and similar, so a
-typical use would be:
+typical use would be::
 
 	sub vcl_fetch {
 		if (req.url ~ "html$") {
@@ -100,7 +100,7 @@ typical use would be:
 GZIP and ESI
 ------------
 
-First, note the new syntax for activating ESI:
+First, note the new syntax for activating ESI::
 
 	sub vcl_fetch {
 		set beresp.do_esi = true;
@@ -147,7 +147,7 @@ gunzip them, but when we encounter gunzip'ed objects which should
 be, we gzip them, but only at compression level zero.
 
 So in order to avoid unnecessary work, and in order to get maximum
-compression efficiency, you should:
+compression efficiency, you should::
 
 	sub vcl_miss {
 		if (object needs ESI processing) {
diff --git a/doc/sphinx/phk/ipv6suckage.rst b/doc/sphinx/phk/ipv6suckage.rst
index 63bdb22..dac68be 100644
--- a/doc/sphinx/phk/ipv6suckage.rst
+++ b/doc/sphinx/phk/ipv6suckage.rst
@@ -53,7 +53,9 @@ way (the same as RFC3986), you need to inspect the version field
 in the sockaddr to see if you should do
 
 	"%s:%s", host, port
+
 or
+
 	"[%s]:%s", host, port
 
 Careless standardization costs code, have I mentioned this before ?
diff --git a/doc/sphinx/reference/vmod.rst b/doc/sphinx/reference/vmod.rst
index 3813bf6..2b515c1 100644
--- a/doc/sphinx/reference/vmod.rst
+++ b/doc/sphinx/reference/vmod.rst
@@ -85,7 +85,7 @@ For the std VMOD, the compiled vcc_if.h file looks like this::
 	const char * vmod_tolower(struct sess *, struct vmod_priv *, const char *, ...);
 	int meta_function(void **, const struct VCL_conf *);
 
-Those are your C prototypes.  Notice the "vmod\_" prefix on the function
+Those are your C prototypes.  Notice the ``vmod_`` prefix on the function
 names and the C-types as return types and arguments.
 
 VCL and C data types
@@ -97,36 +97,36 @@ language representation.  Here is a description of them, from simple
 to nasty.
 
 INT
-	C-type: int
+	C-type: ``int``
 
 	An integer as we know and love them.
 
 REAL
-	C-type: double
+	C-type: ``double``
 
 	A floating point value
 
 DURATION
-	C-type: double
+	C-type: ``double``
 
 	Units: seconds
 
 	A time interval, as in "25 minutes".
 
 TIME
-	C-type: double
+	C-type: ``double``
 
 	Units: seconds since UNIX epoch
 
 	An absolute time, as in "Mon Sep 13 19:06:01 UTC 2010".
 
 STRING
-	C-type: const char *
+	C-type: ``const char *``
 
 	A NUL-terminated text-string.
 
 	Can be NULL to indicate that the nonexistent string, for
-	instance:
+	instance::
 
 		mymod.foo(req.http.foobar);
 
@@ -140,7 +140,7 @@ STRING
 	workspaces.
 
 STRING_LIST
-	C-type: const char *, ...
+	C-type: ``const char *, ...``
 
 	A multi-component text-string.  We try very hard to avoid
 	doing text-processing in Varnish, and this is one way we
@@ -152,15 +152,15 @@ STRING_LIST
 		set bereq.http.foo = std.toupper(req.http.foo + req.http.bar);
 
 	The usual way to do this, would be be to allocate memory for
-	the concatenated string, then pass that to toupper() which in
+	the concatenated string, then pass that to ``toupper()`` which in
 	turn would return another freshly allocated string with the
-	modified result.  Remember: strings in VCL are "const", we
+	modified result.  Remember: strings in VCL are ``const``, we
 	cannot just modify the string in place.
 
-	What we do instead, is declare that toupper() takes a "STRING_LIST"
-	as argument.  This makes the C function implementing toupper()
+	What we do instead, is declare that ``toupper()`` takes a "STRING_LIST"
+	as argument.  This makes the C function implementing ``toupper()``
 	a vararg function (see the prototype above) and responsible for
-	considering all the "const char *" arguments it finds, until the
+	considering all the ``const char *`` arguments it finds, until the
 	magic marker "vrt_magic_string_end" is encountered.
 
 	Bear in mind that the individual strings in a STRING_LIST can be
@@ -180,7 +180,7 @@ PRIV_CALL
 	See below
 
 VOID
-	C-type: void
+	C-type: ``void``
 
 	Can only be used for return-value, which makes the function a VCL
 	procedure.
@@ -208,7 +208,7 @@ last output of some expensive lookup.
 applies to all calls in this VCL, for instance flags that determine
 if regular expressions are case-sensitive in this vmod or similar.
 
-The way it works in the vmod code, is that a "struct vmod_priv *" is
+The way it works in the vmod code, is that a ``struct vmod_priv *`` is
 passed to the functions where argument type PRIV_VCL or PRIV_CALL
 is specified.
 
diff --git a/doc/sphinx/tutorial/advanced_topics.rst b/doc/sphinx/tutorial/advanced_topics.rst
index d140faa..5bdb7b4 100644
--- a/doc/sphinx/tutorial/advanced_topics.rst
+++ b/doc/sphinx/tutorial/advanced_topics.rst
@@ -17,7 +17,7 @@ discussed. For a complete(ish) guide to VCL have a look at the VCL man
 page - ref:`reference-vcl`.
 
 Using In-line C to extend Varnish
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can use *in-line C* to extend Varnish. Please note that you can
 seriously mess up Varnish this way. The C code runs within the Varnish