summaryrefslogtreecommitdiff
path: root/cmdutils.h
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-08-11 19:45:30 +0200
committerAnton Khirnov <anton@khirnov.net>2012-08-19 19:21:35 +0200
commit7c5012127fb7e18f0616011257bb4248f6a8b608 (patch)
treeb15931979cb46f5fc5f5d5b79680de8664f9a7d5 /cmdutils.h
parentdc4c24a3d35603957aecf2b075ac25902d18a190 (diff)
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.
Diffstat (limited to 'cmdutils.h')
-rw-r--r--cmdutils.h12
1 files changed, 10 insertions, 2 deletions
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