btrfs-progs: tests: print shorter test name in the output
[btrfs-progs-unstable/devel.git] / commands.h
blob94229c112bc08eeef375aaa40e2074065ae0f396
1 /*
2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public
4 * License v2 as published by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9 * General Public License for more details.
11 * You should have received a copy of the GNU General Public
12 * License along with this program; if not, write to the
13 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
14 * Boston, MA 021110-1307, USA.
17 #ifndef __BTRFS_COMMANDS_H__
18 #define __BTRFS_COMMANDS_H__
20 enum {
21 CMD_HIDDEN = (1 << 0), /* should not be in help listings */
22 CMD_ALIAS = (1 << 1), /* alias of next command in cmd_group */
25 struct cmd_struct {
26 const char *token;
27 int (*fn)(int, char **);
30 * Usage strings
32 * A NULL-terminated array of the following format:
34 * usagestr[0] - one-line synopsis (required)
35 * usagestr[1] - one-line short description (required)
36 * usagestr[2..m] - a long (possibly multi-line) description
37 * (optional)
38 * usagestr[m + 1] - an empty line separator (required if at least one
39 * option string is given, not needed otherwise)
40 * usagestr[m + 2..n] - option strings, one option per line
41 * (optional)
42 * usagestr[n + 1] - NULL terminator
44 * Options (if present) should always (even if there is no long
45 * description) be prepended with an empty line. Supplied strings are
46 * indented but otherwise printed as-is, no automatic wrapping is done.
48 * Grep for cmd_*_usage[] for examples.
50 const char * const *usagestr;
52 /* should be NULL if token is not a subgroup */
53 const struct cmd_group *next;
55 /* CMD_* flags above */
56 int flags;
59 #define NULL_CMD_STRUCT {NULL, NULL, NULL, NULL, 0}
61 struct cmd_group {
62 const char * const *usagestr;
63 const char *infostr;
65 const struct cmd_struct commands[];
68 /* btrfs.c */
69 int prefixcmp(const char *str, const char *prefix);
71 int handle_command_group(const struct cmd_group *grp, int argc,
72 char **argv);
74 /* help.c */
75 extern const char * const generic_cmd_help_usage[];
77 void usage(const char * const *usagestr) __attribute__((noreturn));
78 void usage_command(const struct cmd_struct *cmd, int full, int err);
79 void usage_command_group(const struct cmd_group *grp, int all, int err);
80 void usage_command_group_short(const struct cmd_group *grp);
82 void help_unknown_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
83 void help_ambiguous_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
85 void help_command_group(const struct cmd_group *grp, int argc, char **argv);
87 extern const struct cmd_group subvolume_cmd_group;
88 extern const struct cmd_group filesystem_cmd_group;
89 extern const struct cmd_group balance_cmd_group;
90 extern const struct cmd_group device_cmd_group;
91 extern const struct cmd_group scrub_cmd_group;
92 extern const struct cmd_group inspect_cmd_group;
93 extern const struct cmd_group property_cmd_group;
94 extern const struct cmd_group quota_cmd_group;
95 extern const struct cmd_group qgroup_cmd_group;
96 extern const struct cmd_group replace_cmd_group;
97 extern const struct cmd_group rescue_cmd_group;
99 extern const char * const cmd_send_usage[];
100 extern const char * const cmd_receive_usage[];
101 extern const char * const cmd_check_usage[];
102 extern const char * const cmd_chunk_recover_usage[];
103 extern const char * const cmd_super_recover_usage[];
104 extern const char * const cmd_restore_usage[];
105 extern const char * const cmd_rescue_usage[];
107 int cmd_subvolume(int argc, char **argv);
108 int cmd_filesystem(int argc, char **argv);
109 int cmd_balance(int argc, char **argv);
110 int cmd_device(int argc, char **argv);
111 int cmd_scrub(int argc, char **argv);
112 int cmd_check(int argc, char **argv);
113 int cmd_chunk_recover(int argc, char **argv);
114 int cmd_super_recover(int argc, char **argv);
115 int cmd_inspect(int argc, char **argv);
116 int cmd_property(int argc, char **argv);
117 int cmd_send(int argc, char **argv);
118 int cmd_receive(int argc, char **argv);
119 int cmd_quota(int argc, char **argv);
120 int cmd_qgroup(int argc, char **argv);
121 int cmd_replace(int argc, char **argv);
122 int cmd_restore(int argc, char **argv);
123 int cmd_select_super(int argc, char **argv);
124 int cmd_dump_super(int argc, char **argv);
125 int cmd_debug_tree(int argc, char **argv);
126 int cmd_rescue(int argc, char **argv);
128 #endif