From: Philippe Waroquiers Date: Sat, 19 Apr 2014 10:27:28 +0000 (+0000) Subject: Reword/clarify the VG_(parse_enum_set) comment. X-Git-Tag: svn/VALGRIND_3_10_0~537 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c23409d4e8f99bb4167801e1f1b1071c15bd5d33;p=thirdparty%2Fvalgrind.git Reword/clarify the VG_(parse_enum_set) comment. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13899 --- diff --git a/include/pub_tool_libcbase.h b/include/pub_tool_libcbase.h index 951a702dc9..31072239ce 100644 --- a/include/pub_tool_libcbase.h +++ b/include/pub_tool_libcbase.h @@ -112,17 +112,17 @@ extern HChar* VG_(strtok) (HChar* s, const HChar* delim); extern Bool VG_(parse_Addr) ( const HChar** ppc, Addr* result ); /* Parse an "enum set" made of one or more words comma separated. - The allowed word values are given in tokens, separated - by comma. - If a word in tokens is found in input, - the corresponding bit will be set in *enum_set - (words in tokens are numbered starting from 0). - The special token - in tokens can be used to indicate - that the corresponding bit position cannot be set. - The words none and all can be used to indicate an empty - enum_set (0) or an enum_set with all bits corresponding - to tokens set. If none or all is given, no other word - can be given in input. + The allowed word values are given in 'tokens', separated by comma. + If a word in 'tokens' is found in 'input', the corresponding bit + will be set in *enum_set (words in 'tokens' are numbered starting from 0). + Using in 'tokens' the special token "-" (a minus character) indicates that + the corresponding bit position cannot be set. + In addition to the words specified in 'tokens', VG_(parse_enum_set) + automatically accept the words "none" and "all" to indicate respectively + an empty enum_set (0) or an enum_set with all bits corresponding + to the words in tokens set. + If "none" or "all" is present in 'input', no other word can be given + in 'input'. If parsing is successful, returns True and sets *enum_set. If parsing fails, returns False. */ extern Bool VG_(parse_enum_set) ( const HChar *tokens,