[mirror_qemu.git] / include / qemu / help_option.h

#ifndef QEMU_HELP_OPTION_H
#define QEMU_HELP_OPTION_H

/**
 * is_help_option:
 * @s: string to test
 *
 * Check whether @s is one of the standard strings which indicate
 * that the user is asking for a list of the valid values for a
 * command option like -cpu or -M. The current accepted strings
 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
 * which makes it annoying to use in a reliable way) but provided
 * for backwards compatibility.
 *
 * Returns: true if @s is a request for a list.
 */
static inline bool is_help_option(const char *s)
{
    return !strcmp(s, "?") || !strcmp(s, "help");
}

#endif
Commit	Line	Data
f348b6d1	1	#ifndef QEMU_HELP_OPTION_H
175de524	2	#define QEMU_HELP_OPTION_H
f348b6d1 VB	3
	4	/**
	5	* is_help_option:
	6	* @s: string to test
	7	*
	8	* Check whether @s is one of the standard strings which indicate
	9	* that the user is asking for a list of the valid values for a
	10	* command option like -cpu or -M. The current accepted strings
	11	* are 'help' and '?'. '?' is deprecated (it is a shell wildcard
	12	* which makes it annoying to use in a reliable way) but provided
	13	* for backwards compatibility.
	14	*
	15	* Returns: true if @s is a request for a list.
	16	*/
	17	static inline bool is_help_option(const char *s)
	18	{
	19	return !strcmp(s, "?") \|\| !strcmp(s, "help");
	20	}
	21
	22	#endif