kconfig: Add option to get the full help text with listnewconfig
[carl9170fw.git] / config / conf.c
index 649ea82772335ebf8e159fc4bede8ef8cf8a39c4..5f1758c73ccf1762114c542ce08bbd5340822550 100644 (file)
@@ -1,10 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0
 /*
  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
  */
 
-#include <locale.h>
 #include <ctype.h>
+#include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <getopt.h>
 #include <sys/stat.h>
 #include <sys/time.h>
+#include <errno.h>
 
 #include "lkc.h"
 
 static void conf(struct menu *menu);
 static void check_conf(struct menu *menu);
-static void xfgets(char *str, int size, FILE *in);
 
 enum input_mode {
        oldaskconfig,
+       syncconfig,
        oldconfig,
        allnoconfig,
        allyesconfig,
@@ -31,13 +32,16 @@ enum input_mode {
        defconfig,
        savedefconfig,
        listnewconfig,
-       oldnoconfig,
-} input_mode = oldaskconfig;
+       helpnewconfig,
+       olddefconfig,
+};
+static enum input_mode input_mode = oldaskconfig;
 
 static int indent = 1;
-static int valid_stdin = 1;
+static int tty_stdio;
+static int sync_kconfig;
 static int conf_cnt;
-static char line[128];
+static char line[PATH_MAX];
 static struct menu *rootEntry;
 
 static void print_help(struct menu *menu)
@@ -67,14 +71,14 @@ static void strip(char *str)
                *p-- = 0;
 }
 
-static void check_stdin(void)
+/* Helper function to facilitate fgets() by Jean Sacren. */
+static void xfgets(char *str, int size, FILE *in)
 {
-       if (!valid_stdin) {
-               printf(_("aborted!\n\n"));
-               printf(_("Console input/output is redirected. "));
-               printf(_("Run 'make config' to update configuration.\n\n"));
-               exit(1);
-       }
+       if (!fgets(str, size, in))
+               fprintf(stderr, "\nError in reading or end of file.\n");
+
+       if (!tty_stdio)
+               printf("%s", str);
 }
 
 static int conf_askvalue(struct symbol *sym, const char *def)
@@ -82,12 +86,12 @@ static int conf_askvalue(struct symbol *sym, const char *def)
        enum symbol_type type = sym_get_type(sym);
 
        if (!sym_has_value(sym))
-               printf(_("(NEW) "));
+               printf("(NEW) ");
 
        line[0] = '\n';
        line[1] = 0;
 
-       if (!sym_is_changable(sym)) {
+       if (!sym_is_changeable(sym)) {
                printf("%s\n", def);
                line[0] = '\n';
                line[1] = 0;
@@ -96,15 +100,15 @@ static int conf_askvalue(struct symbol *sym, const char *def)
 
        switch (input_mode) {
        case oldconfig:
+       case syncconfig:
                if (sym_has_value(sym)) {
                        printf("%s\n", def);
                        return 0;
                }
-               check_stdin();
                /* fall through */
        case oldaskconfig:
                fflush(stdout);
-               xfgets(line, 128, stdin);
+               xfgets(line, sizeof(line), stdin);
                return 1;
        default:
                break;
@@ -129,7 +133,7 @@ static int conf_string(struct menu *menu)
        const char *def;
 
        while (1) {
-               printf("%*s%s ", indent - 1, "", _(menu->prompt->text));
+               printf("%*s%s ", indent - 1, "", menu->prompt->text);
                printf("(%s) ", sym->name);
                def = sym_get_string_value(sym);
                if (sym_get_string_value(sym))
@@ -162,7 +166,7 @@ static int conf_sym(struct menu *menu)
        tristate oldval, newval;
 
        while (1) {
-               printf("%*s%s ", indent - 1, "", _(menu->prompt->text));
+               printf("%*s%s ", indent - 1, "", menu->prompt->text);
                if (sym->name)
                        printf("(%s) ", sym->name);
                putchar('[');
@@ -184,9 +188,7 @@ static int conf_sym(struct menu *menu)
                        printf("/m");
                if (oldval != yes && sym_tristate_within_range(sym, yes))
                        printf("/y");
-               if (menu_has_help(menu))
-                       printf("/?");
-               printf("] ");
+               printf("/?] ");
                if (!conf_askvalue(sym, sym_get_string_value(sym)))
                        return 0;
                strip(line);
@@ -233,7 +235,7 @@ static int conf_choice(struct menu *menu)
 
        sym = menu->sym;
        is_new = !sym_has_value(sym);
-       if (sym_is_changable(sym)) {
+       if (sym_is_changeable(sym)) {
                conf_sym(menu);
                sym_calc_value(sym);
                switch (sym_get_tristate_value(sym)) {
@@ -249,7 +251,7 @@ static int conf_choice(struct menu *menu)
                case no:
                        return 1;
                case mod:
-                       printf("%*s%s\n", indent - 1, "", _(menu_get_prompt(menu)));
+                       printf("%*s%s\n", indent - 1, "", menu_get_prompt(menu));
                        return 0;
                case yes:
                        break;
@@ -259,7 +261,7 @@ static int conf_choice(struct menu *menu)
        while (1) {
                int cnt, def;
 
-               printf("%*s%s\n", indent - 1, "", _(menu_get_prompt(menu)));
+               printf("%*s%s\n", indent - 1, "", menu_get_prompt(menu));
                def_sym = sym_get_choice_value(sym);
                cnt = def = 0;
                line[0] = 0;
@@ -267,7 +269,7 @@ static int conf_choice(struct menu *menu)
                        if (!menu_is_visible(child))
                                continue;
                        if (!child->sym) {
-                               printf("%*c %s\n", indent, '*', _(menu_get_prompt(child)));
+                               printf("%*c %s\n", indent, '*', menu_get_prompt(child));
                                continue;
                        }
                        cnt++;
@@ -276,34 +278,31 @@ static int conf_choice(struct menu *menu)
                                printf("%*c", indent, '>');
                        } else
                                printf("%*c", indent, ' ');
-                       printf(" %d. %s", cnt, _(menu_get_prompt(child)));
+                       printf(" %d. %s", cnt, menu_get_prompt(child));
                        if (child->sym->name)
                                printf(" (%s)", child->sym->name);
                        if (!sym_has_value(child->sym))
-                               printf(_(" (NEW)"));
+                               printf(" (NEW)");
                        printf("\n");
                }
-               printf(_("%*schoice"), indent - 1, "");
+               printf("%*schoice", indent - 1, "");
                if (cnt == 1) {
                        printf("[1]: 1\n");
                        goto conf_childs;
                }
-               printf("[1-%d", cnt);
-               if (menu_has_help(menu))
-                       printf("?");
-               printf("]: ");
+               printf("[1-%d?]: ", cnt);
                switch (input_mode) {
                case oldconfig:
+               case syncconfig:
                        if (!is_new) {
                                cnt = def;
                                printf("%d\n", cnt);
                                break;
                        }
-                       check_stdin();
                        /* fall through */
                case oldaskconfig:
                        fflush(stdout);
-                       xfgets(line, 128, stdin);
+                       xfgets(line, sizeof(line), stdin);
                        strip(line);
                        if (line[0] == '?') {
                                print_help(menu);
@@ -359,9 +358,11 @@ static void conf(struct menu *menu)
 
                switch (prop->type) {
                case P_MENU:
-                       if ((input_mode == listnewconfig ||
-                            input_mode == oldnoconfig) &&
-                           rootEntry != menu) {
+                       /*
+                        * Except in oldaskconfig mode, we show only menus that
+                        * contain new symbols.
+                        */
+                       if (input_mode != oldaskconfig && rootEntry != menu) {
                                check_conf(menu);
                                return;
                        }
@@ -371,7 +372,7 @@ static void conf(struct menu *menu)
                        if (prompt)
                                printf("%*c\n%*c %s\n%*c\n",
                                        indent, '*',
-                                       indent, '*', _(prompt),
+                                       indent, '*', prompt,
                                        indent, '*');
                default:
                        ;
@@ -418,15 +419,30 @@ static void check_conf(struct menu *menu)
 
        sym = menu->sym;
        if (sym && !sym_has_value(sym)) {
-               if (sym_is_changable(sym) ||
+               if (sym_is_changeable(sym) ||
                    (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)) {
                        if (input_mode == listnewconfig) {
-                               if (sym->name && !sym_is_choice_value(sym)) {
-                                       printf("%s%s\n", CONFIG_, sym->name);
+                               if (sym->name) {
+                                       const char *str;
+
+                                       if (sym->type == S_STRING) {
+                                               str = sym_get_string_value(sym);
+                                               str = sym_escape_string_value(str);
+                                               printf("%s%s=%s\n", CONFIG_, sym->name, str);
+                                               free((void *)str);
+                                       } else {
+                                               str = sym_get_string_value(sym);
+                                               printf("%s%s=%s\n", CONFIG_, sym->name, str);
+                                       }
                                }
-                       } else if (input_mode != oldnoconfig) {
+                       } else if (input_mode == helpnewconfig) {
+                               printf("-----\n");
+                               print_help(menu);
+                               printf("-----\n");
+
+                       } else {
                                if (!conf_cnt++)
-                                       printf(_("*\n* Restart config...\n*\n"));
+                                       printf("*\n* Restart config...\n*\n");
                                rootEntry = menu_get_parent_menu(menu);
                                conf(rootEntry);
                        }
@@ -438,9 +454,10 @@ static void check_conf(struct menu *menu)
 }
 
 static struct option long_opts[] = {
-       {"askconfig",       no_argument,       NULL, oldaskconfig},
-       {"config",          no_argument,       NULL, oldconfig},
-       {"defconfig",       optional_argument, NULL, defconfig},
+       {"oldaskconfig",    no_argument,       NULL, oldaskconfig},
+       {"oldconfig",       no_argument,       NULL, oldconfig},
+       {"syncconfig",      no_argument,       NULL, syncconfig},
+       {"defconfig",       required_argument, NULL, defconfig},
        {"savedefconfig",   required_argument, NULL, savedefconfig},
        {"allnoconfig",     no_argument,       NULL, allnoconfig},
        {"allyesconfig",    no_argument,       NULL, allyesconfig},
@@ -448,20 +465,23 @@ static struct option long_opts[] = {
        {"alldefconfig",    no_argument,       NULL, alldefconfig},
        {"randconfig",      no_argument,       NULL, randconfig},
        {"listnewconfig",   no_argument,       NULL, listnewconfig},
-       {"noconfig",        no_argument,       NULL, oldnoconfig},
+       {"helpnewconfig",   no_argument,       NULL, helpnewconfig},
+       {"olddefconfig",    no_argument,       NULL, olddefconfig},
        {NULL, 0, NULL, 0}
 };
 
 static void conf_usage(const char *progname)
 {
 
-       printf("Usage: %s [option] <kconfig-file>\n", progname);
+       printf("Usage: %s [-s] [option] <kconfig-file>\n", progname);
        printf("[option] is _one_ of the following:\n");
        printf("  --listnewconfig         List new options\n");
-       printf("  --askconfig             Start a new configuration using a line-oriented program\n");
-       printf("  --config                Update a configuration using a provided .config as base\n");
-       printf("  --silentconfig          Same as config, but quietly, additionally update deps\n");
-       printf("  --noconfig              Same as silentconfig but set new symbols to no\n");
+       printf("  --helpnewconfig         List new options and help text\n");
+       printf("  --oldaskconfig          Start a new configuration using a line-oriented program\n");
+       printf("  --oldconfig             Update a configuration using a provided .config as base\n");
+       printf("  --syncconfig            Similar to oldconfig but generates configuration in\n"
+              "                          include/{generated/,config/}\n");
+       printf("  --olddefconfig          Same as oldconfig but sets new symbols to their default value\n");
        printf("  --defconfig <file>      New config with default defined in <file>\n");
        printf("  --savedefconfig <file>  Save the minimal current configuration to <file>\n");
        printf("  --allnoconfig           New config where all options are answered with no\n");
@@ -476,15 +496,25 @@ int main(int ac, char **av)
        const char *progname = av[0];
        int opt;
        const char *name, *defconfig_file = NULL /* gcc uninit */;
-       struct stat tmpstat;
+       int no_conf_write = 0;
 
-       setlocale(LC_ALL, "");
-       bindtextdomain(PACKAGE, LOCALEDIR);
-       textdomain(PACKAGE);
+       tty_stdio = isatty(0) && isatty(1);
 
-       while ((opt = getopt_long(ac, av, "", long_opts, NULL)) != -1) {
+       while ((opt = getopt_long(ac, av, "s", long_opts, NULL)) != -1) {
+               if (opt == 's') {
+                       conf_set_message_callback(NULL);
+                       continue;
+               }
                input_mode = (enum input_mode)opt;
                switch (opt) {
+               case syncconfig:
+                       /*
+                        * syncconfig is invoked during the build stage.
+                        * Suppress distracting "configuration written to ..."
+                        */
+                       conf_set_message_callback(NULL);
+                       sync_kconfig = 1;
+                       break;
                case defconfig:
                case savedefconfig:
                        defconfig_file = optarg;
@@ -493,14 +523,24 @@ int main(int ac, char **av)
                {
                        struct timeval now;
                        unsigned int seed;
+                       char *seed_env;
 
                        /*
                         * Use microseconds derived seed,
                         * compensate for systems where it may be zero
                         */
                        gettimeofday(&now, NULL);
-
                        seed = (unsigned int)((now.tv_sec + 1) * (now.tv_usec + 1));
+
+                       seed_env = getenv("KCONFIG_SEED");
+                       if( seed_env && *seed_env ) {
+                               char *endp;
+                               int tmp = (int)strtol(seed_env, &endp, 0);
+                               if (*endp == '\0') {
+                                       seed = tmp;
+                               }
+                       }
+                       fprintf( stderr, "KCONFIG_SEED=0x%X\n", seed );
                        srand(seed);
                        break;
                }
@@ -511,7 +551,8 @@ int main(int ac, char **av)
                case allmodconfig:
                case alldefconfig:
                case listnewconfig:
-               case oldnoconfig:
+               case helpnewconfig:
+               case olddefconfig:
                        break;
                case '?':
                        conf_usage(progname);
@@ -520,7 +561,7 @@ int main(int ac, char **av)
                }
        }
        if (ac == optind) {
-               printf(_("%s: Kconfig file missing\n"), av[0]);
+               fprintf(stderr, "%s: Kconfig file missing\n", av[0]);
                conf_usage(progname);
                exit(1);
        }
@@ -530,20 +571,22 @@ int main(int ac, char **av)
 
        switch (input_mode) {
        case defconfig:
-               if (!defconfig_file)
-                       defconfig_file = conf_get_default_confname();
                if (conf_read(defconfig_file)) {
-                       printf(_("***\n"
-                               "*** Can't find default configuration \"%s\"!\n"
-                               "***\n"), defconfig_file);
+                       fprintf(stderr,
+                               "***\n"
+                                 "*** Can't find default configuration \"%s\"!\n"
+                                 "***\n",
+                               defconfig_file);
                        exit(1);
                }
                break;
        case savedefconfig:
+       case syncconfig:
        case oldaskconfig:
        case oldconfig:
        case listnewconfig:
-       case oldnoconfig:
+       case helpnewconfig:
+       case olddefconfig:
                conf_read(NULL);
                break;
        case allnoconfig:
@@ -557,7 +600,7 @@ int main(int ac, char **av)
                if ((strcmp(name, "") != 0) && (strcmp(name, "1") != 0)) {
                        if (conf_read_simple(name, S_DEF_USER)) {
                                fprintf(stderr,
-                                       _("*** Can't read seed configuration \"%s\"!\n"),
+                                       "*** Can't read seed configuration \"%s\"!\n",
                                        name);
                                exit(1);
                        }
@@ -574,7 +617,7 @@ int main(int ac, char **av)
                if (conf_read_simple(name, S_DEF_USER) &&
                    conf_read_simple("all.config", S_DEF_USER)) {
                        fprintf(stderr,
-                               _("*** KCONFIG_ALLCONFIG set, but no \"%s\" or \"all.config\" file found\n"),
+                               "*** KCONFIG_ALLCONFIG set, but no \"%s\" or \"all.config\" file found\n",
                                name);
                        exit(1);
                }
@@ -583,7 +626,17 @@ int main(int ac, char **av)
                break;
        }
 
-       valid_stdin = isatty(0) && isatty(1) && isatty(2);
+       if (sync_kconfig) {
+               name = getenv("KCONFIG_NOSILENTUPDATE");
+               if (name && *name) {
+                       if (conf_get_changed()) {
+                               fprintf(stderr,
+                                       "\n*** The configuration requires explicit update.\n\n");
+                               return 1;
+                       }
+                       no_conf_write = 1;
+               }
+       }
 
        switch (input_mode) {
        case allnoconfig:
@@ -599,7 +652,8 @@ int main(int ac, char **av)
                conf_set_all_new_symbols(def_default);
                break;
        case randconfig:
-               conf_set_all_new_symbols(def_random);
+               /* Really nothing to do in this loop */
+               while (conf_set_all_new_symbols(def_random)) ;
                break;
        case defconfig:
                conf_set_all_new_symbols(def_default);
@@ -613,44 +667,52 @@ int main(int ac, char **av)
                /* fall through */
        case oldconfig:
        case listnewconfig:
-       case oldnoconfig:
+       case helpnewconfig:
+       case syncconfig:
                /* Update until a loop caused no more changes */
                do {
                        conf_cnt = 0;
                        check_conf(&rootmenu);
-               } while (conf_cnt &&
-                        (input_mode != listnewconfig &&
-                         input_mode != oldnoconfig));
+               } while (conf_cnt);
+               break;
+       case olddefconfig:
+       default:
                break;
        }
 
        if (input_mode == savedefconfig) {
                if (conf_write_defconfig(defconfig_file)) {
-                       fprintf(stderr, _("n*** Error while saving defconfig to: %s\n\n"),
-                               defconfig_file);
+                       fprintf(stderr, "n*** Error while saving defconfig to: %s\n\n",
+                               defconfig_file);
                        return 1;
                }
-       } else if (input_mode != listnewconfig) {
-               /*
-                * build so we shall update autoconf.
-                */
-               if (conf_write(NULL)) {
-                       fprintf(stderr, _("\n*** Error during writing of the configuration.\n\n"));
+       } else if (input_mode != listnewconfig && input_mode != helpnewconfig) {
+               if (!no_conf_write && conf_write(NULL)) {
+                       fprintf(stderr, "\n*** Error during writing of the configuration.\n\n");
                        exit(1);
                }
-               if (conf_write_autoconf()) {
-                       fprintf(stderr, _("\n*** Error during update of the configuration.\n\n"));
+
+               /*
+                * Create auto.conf if it does not exist.
+                * This prevents GNU Make 4.1 or older from emitting
+                * "include/generated/auto.conf: No such file or directory"
+                * in the top-level Makefile
+                *
+                * syncconfig always creates or updates auto.conf because it is
+                * used during the build.
+                */
+
+               /*
+                * In our cmake case, we always want to update the autogenerated
+                * files.
+                */
+               sync_kconfig = 1;
+
+               if (conf_write_autoconf(sync_kconfig) && sync_kconfig) {
+                       fprintf(stderr,
+                               "\n*** Error during sync of the configuration.\n\n");
                        return 1;
                }
        }
        return 0;
 }
-
-/*
- * Helper function to facilitate fgets() by Jean Sacren.
- */
-void xfgets(char *str, int size, FILE *in)
-{
-       if (fgets(str, size, in) == NULL)
-               fprintf(stderr, "\nError in reading or end of file.\n");
-}