9
0
Fork 0
barebox/commands/magicvar.c

135 lines
2.5 KiB
C
Raw Normal View History

#include <common.h>
#include <command.h>
#include <getopt.h>
#include <environment.h>
#include <magicvar.h>
#include <malloc.h>
static LIST_HEAD(magicvars);
struct magicvar_dyn {
char *name;
char *description;
struct list_head list;
};
static void magicvar_print_one(struct magicvar_dyn *md, int verbose)
{
printf("%-32s %s\n", md->name, md->description);
if (verbose) {
const char *val = getenv(md->name);
if (val && strlen(val))
printf(" %s\n", val);
}
}
struct magicvar_dyn *magicvar_find(const char *name)
{
struct magicvar_dyn *md;
list_for_each_entry(md, &magicvars, list)
if (!strcmp(md->name, name))
return md;
return NULL;
}
static void magicvar_remove(struct magicvar_dyn *md)
{
free(md->name);
free(md->description);
list_del(&md->list);
free(md);
}
static int compare(struct list_head *a, struct list_head *b)
{
char *na = (char*)list_entry(a, struct magicvar_dyn, list)->name;
char *nb = (char*)list_entry(b, struct magicvar_dyn, list)->name;
return strcmp(na, nb);
}
static int magicvar_add(const char *name, const char *description)
{
struct magicvar_dyn *md;
md = magicvar_find(name);
if (md)
magicvar_remove(md);
md = xzalloc(sizeof(*md));
md->name = xstrdup(name);
md->description = xstrdup(description);
list_add_sort(&md->list, &magicvars, compare);
return 0;
}
static void magicvar_build(void)
{
static int first = 1;
struct magicvar *m;
if (!first)
return;
for (m = &__barebox_magicvar_start;
m != &__barebox_magicvar_end;
m++)
magicvar_add(m->name, m->description);
first = 0;
}
static int do_magicvar(int argc, char *argv[])
{
struct magicvar_dyn *md;
int opt;
int verbose = 0, add = 0;
magicvar_build();
while ((opt = getopt(argc, argv, "va")) > 0) {
switch (opt) {
case 'v':
verbose = 1;
break;
case 'a':
add = 1;
break;
default:
return COMMAND_ERROR_USAGE;
}
}
if (add) {
if (optind + 2 != argc)
return COMMAND_ERROR_USAGE;
return magicvar_add(argv[optind], argv[optind + 1]);
}
list_for_each_entry(md, &magicvars, list)
magicvar_print_one(md, verbose);
return 0;
}
BAREBOX_CMD_HELP_START(magicvar)
BAREBOX_CMD_HELP_TEXT("Options:")
BAREBOX_CMD_HELP_OPT ("-v", "verbose (list all value if there is one)")
BAREBOX_CMD_HELP_OPT ("-a <NAME> <DESC>", "Add a new magicvar")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(magicvar)
.cmd = do_magicvar,
commands: harmonize in-barebox documentation This patch does probably too much, but it's hard (and very cumbersome/time consuming) to break it out. What is does is this: * each command has one short description, e.g. "list MUX configuration" * made sure the short descriptions start lowercase * each command has one usage. That string contains just the options, e.g. "[-npn]". It's not part of the long help text. * that is, it doesn't say "[OPTIONS]" anymore, every usable option is listed by character in this (short) option string (the long description is in the long help text, as before) * help texts have been reworked, to make them - sometimes smaller - sometimes describe the options better - more often present themselves in a nicer format * all long help texts are now created with BUSYBOX_CMD_HELP_ macros, no more 'static const __maybe_unused char cmd_foobar_help[]' * made sure the long help texts starts uppercase * because cmdtp->name and cmdtp->opts together provide the new usage, all "Usage: foobar" texts have been removed from the long help texts * BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this is nicer in the source code * BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself * made sure no line gets longer than 77 characters * delibertely renamed cmdtp->usage, so that we can get compile-time errors (e.g. in out-of-tree modules that use register_command() * the 'help' command can now always emit the usage, even without compiled long help texts * 'help -v' gives a list of commands with their short description, this is similar like the old "help" command before my patchset * 'help -a' gives out help of all commands Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 08:28:42 +00:00
BAREBOX_CMD_DESC("list information about magic variables")
BAREBOX_CMD_OPTS("[-va]")
BAREBOX_CMD_HELP(cmd_magicvar_help)
BAREBOX_CMD_GROUP(CMD_GRP_ENV)
BAREBOX_CMD_END