[master] f8a0a86 Document varnishtest
Guillaume Quintard
guillaume at varnish-software.com
Mon Jun 6 11:01:08 CEST 2016
commit f8a0a866324db8dd8f8ccd80fca65cc7c4e7b8da
Author: Guillaume Quintard <guillaume at varnish-software.com>
Date: Mon May 30 18:01:23 2016 +0200
Document varnishtest
diff --git a/bin/varnishtest/vtc.c b/bin/varnishtest/vtc.c
index d862554..c7bce41 100644
--- a/bin/varnishtest/vtc.c
+++ b/bin/varnishtest/vtc.c
@@ -392,8 +392,15 @@ reset_cmds(const struct cmds *cmd)
cmd->cmd(NULL, NULL, NULL, NULL);
}
-/**********************************************************************
- * Output test description
+/* SECTION: varnishtest varnishtest
+ *
+ * This should be the first command in your vtc as it will identify the test
+ * case with a short yet descriptive sentence. It takes exactly one argument, a
+ * string, eg::
+ *
+ * varnishtest "Check that varnishtest is actually a valid command"
+ *
+ * It will also print that string in the log.
*/
static void
More information about the varnish-commit
mailing list