[master] d2e526ce9 man: Add missing sections to the vtc(7) manual

Dridi Boukelmoune dridi.boukelmoune at gmail.com
Wed Sep 1 05:30:10 UTC 2021


commit d2e526ce95d6d8426ec170b4cfc78d41abc07179
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date:   Wed Sep 1 05:52:35 2021 +0200

    man: Add missing sections to the vtc(7) manual

diff --git a/bin/varnishtest/vtc_http2.c b/bin/varnishtest/vtc_http2.c
index 2cdb34a68..406193dbb 100644
--- a/bin/varnishtest/vtc_http2.c
+++ b/bin/varnishtest/vtc_http2.c
@@ -937,6 +937,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 
 	n = 0;
 	/* SECTION: stream.spec.zexpect.ping PING specific
+	 *
 	 * ping.data
 	 *	The 8-bytes string of the PING frame payload.
 	 * ping.ack (PING)
@@ -952,6 +953,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		return (buf);
 	}
 	/* SECTION: stream.spec.zexpect.winup WINDOW_UPDATE specific
+	 *
 	 * winup.size
 	 *	The size of the upgrade given by the WINDOW_UPDATE frame.
 	 */
@@ -960,6 +962,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		RETURN_BUFFED(f->md.winup_size);
 	}
 	/* SECTION: stream.spec.zexpect.prio PRIORITY specific
+	 *
 	 * prio.stream
 	 *	The stream ID announced.
 	 *
@@ -983,6 +986,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		RETURN_BUFFED(f->md.prio.weight);
 	}
 	/* SECTION: stream.spec.zexpect.rst RESET_STREAM specific
+	 *
 	 * rst.err
 	 *	The error code (as integer) of the RESET_STREAM frame.
 	 */
@@ -1037,6 +1041,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		if (!strcmp(spec, "hdrsize"))    { RETURN_SETTINGS(6); }
 	}
 	/* SECTION: stream.spec.zexpect.push PUSH_PROMISE specific
+	 *
 	 * push.id
 	 *	The id of the promised stream.
 	 */
@@ -1045,6 +1050,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		RETURN_BUFFED(f->md.promised);
 	}
 	/* SECTION: stream.spec.zexpect.goaway GOAWAY specific
+	 *
 	 * goaway.err
 	 *	The error code (as integer) of the GOAWAY frame.
 	 *
@@ -1066,6 +1072,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 			return (f->md.goaway.debug);
 	}
 	/* SECTION: stream.spec.zexpect.zframe Generic frame
+	 *
 	 * frame.data
 	 *	Payload of the last frame
 	 *
@@ -1101,6 +1108,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 		}
 	}
 	/* SECTION: stream.spec.zexpect.zstream Stream
+	 *
 	 * stream.window
 	 *	The current window size of the stream, or, if on stream 0,
 	 *	of the connection.
@@ -1131,6 +1139,7 @@ cmd_var_resolve(const struct stream *s, const char *spec, char *buf)
 			return (NULL);
 	}
 	/* SECTION: stream.spec.zexpect.ztable Index tables
+	 *
 	 * tbl.dec.size / tbl.enc.size
 	 *	Size (bytes) of the decoding/encoding table.
 	 *
diff --git a/doc/sphinx/vtc-syntax.py b/doc/sphinx/vtc-syntax.py
index 03451ce51..c168e05a7 100644
--- a/doc/sphinx/vtc-syntax.py
+++ b/doc/sphinx/vtc-syntax.py
@@ -38,7 +38,7 @@ import re
 def parse_file(fn, cl, tl, sl):
     p = False
     section = ""
-    resec = re.compile("[ /]\* SECTION: ")
+    resec = re.compile("\s*/\* SECTION: ")
 
     try:
         # Python3
@@ -57,13 +57,13 @@ def parse_file(fn, cl, tl, sl):
             cl[section] = []
             if len(a) > 3:
                 tl[section] = re.sub(
-                    r"^[\t ]*\/?\* SECTION: [^ ]+ +",
+                    r"^\s*/?\* SECTION: [^ ]+ +",
                     "", l)
             else:
                 tl[section] = ""
             p = 1
         elif p:
-            cl[section].append(re.sub(r"^ \* ?", "", l))
+            cl[section].append(re.sub(r"^\s*\* ?", "", l))
     f.close()
 
 if __name__ == "__main__":


More information about the varnish-commit mailing list