[master] 787a4e9 Update documentation of VSL_Name2Tag
Martin Blix Grydeland
martin at varnish-cache.org
Tue Oct 1 14:48:18 CEST 2013
commit 787a4e9d83f7c2f9b8ce7999d4c57cf137884cca
Author: Martin Blix Grydeland <martin at varnish-software.com>
Date: Tue Sep 24 12:35:51 2013 +0200
Update documentation of VSL_Name2Tag
diff --git a/include/vapi/vsl.h b/include/vapi/vsl.h
index 8aa9152..7f6f98d 100644
--- a/include/vapi/vsl.h
+++ b/include/vapi/vsl.h
@@ -103,7 +103,13 @@ extern const char *VSL_tags[SLT__MAX];
int VSL_Name2Tag(const char *name, int l);
/*
- * Convert string to tag number (= enum VSL_tag_e)
+ * Convert string to tag number (= enum VSL_tag_e). Name can be a
+ * substring from the beginning of a tag when that substring is
+ * unique. Matching is case insensitive.
+ *
+ * Arguments:
+ * name: A tag name (or substring) to match against
+ * l: The length of name, or -1 to use strlen.
*
* Return values:
* >=0: Tag number
More information about the varnish-commit
mailing list