From 7c5012127fb7e18f0616011257bb4248f6a8b608 Mon Sep 17 00:00:00 2001 From: Anton Khirnov Date: Sat, 11 Aug 2012 19:45:30 +0200 Subject: cmdutils: change semantics of show_help_options() and document it. Currently it takes a mask and value, such that options for which (flags & mask) == value. Change it to take required flags and forbidden flags instead. This is shorter and simpler to understand. --- cmdutils.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'cmdutils.h') diff --git a/cmdutils.h b/cmdutils.h index 6fb5a35093..eb8a22a003 100644 --- a/cmdutils.h +++ b/cmdutils.h @@ -153,8 +153,16 @@ typedef struct { const char *argname; } OptionDef; -void show_help_options(const OptionDef *options, const char *msg, int mask, - int value); +/** + * Print help for all options matching specified flags. + * + * @param options a list of options + * @param msg title of this group. Only printed if at least one option matches. + * @param req_flags print only options which have all those flags set. + * @param rej_flags don't print options which have any of those flags set. + */ +void show_help_options(const OptionDef *options, const char *msg, int req_flags, + int rej_flags); /** * Show help for all options with given flags in class and all its -- cgit v1.2.3