Kconfig: Added compare capabilities for mconf
cover Kconfig: Added compare capabilities for mconf
Hello,
There are circumstances where the Python script "scripts/diffconfig" is not helpful:
$ scripts/diffconfig /boot/config-6.12.43+deb13-amd64 ../linux-source-6.1/.config | wc -l 7375
where the first argument is the .config file of the new LTS kernel version (6.12.y) provided by the distribution and the second argument is the .config file customized of the old LTS kernel version (6.1.y).
As you can see there are too many differences are reported, to deal with them.
The solution I propose is to provide comparison capability for scripts/kconfig/mconf.c (make menuconfig). Adding a:
"*" indicating that the symbol is built-in =y "_" indicating that the symbol is disabled =n "M" indicating that the symbol is a module =M "#" indicating that the symbol is a new feature
just before symbol's description in "menuconfig" window. If the symbol's tristate value is the same in the .config edited and in the .config compared then those symbols item will be left untouched.
Franco Martelli (1):
Kconfig: Added compare capabilities for mconf
scripts/kconfig/confdata.c | 189 ++++++++++++++++++++++- scripts/kconfig/expr.h | 9 ++ scripts/kconfig/lkc.h | 11 ++ scripts/kconfig/lkc_proto.h | 4 + scripts/kconfig/lxdialog/menubox.c | 29 +++- scripts/kconfig/mconf.c | 240 ++++++++++++++++++++++++++--- 6 files changed, 452 insertions(+), 30 deletions(-)
base-commit: e53642b87a4f4b03a8d7e5f8507fc3cd0c595ea6
Signature · 1 line
2.47.3
PATCH 1/1 Kconfig: Added compare capabilities for mconf
This patch allows to compare the tristate value of two .config files inline, symbol by symbol, in mconf (make menuconfig) only. It can be really useful when customizing the .config file.
When a new stable release of a distribution is available, in the Linux kernel many things has changed, this patch comes in help in this situations, it allows to easily compare the customized .config file built for the previous version of the distribution, with the one provided by the new software distribution, used as reference. Generally it can be helpful when the differences between .config files are huge, because you can navigate across them in the menu window.
The patch has a limitation, it only show the tristate value (Y/N/M) not differences for symbol with a value (string), but it also marks with a "#" the symbol missing in the loaded .config, meaning therefore the symbol as a new feature.
o I've also added support for the more canonical <F1> key to show inline help window, in addition to <?> and <h> keys.
o By pressing the <F2> or <D> key you will get a view with all the symbol differences listed.
o By pressing the <F4> or <F> key you'll save to a file the differences.
o Added help text that it describes the new features.
This software is under GPL-2.0 license.
Changelog:
----------
scripts/kconfig/confdata.c:
---------------------------
Silenced a warning emitted when parsing the .config file to compare.
Skipping empty sym when parsing the .config file to compare.
Added sym_get_comp_tristate_char() to return the tristate's chars for the .config file to compare, possible values: Y/N/M/#
Added sym_name_comp() that return an int, it is used by qsort() function to provide comparison between the two members "name" of the "Symbol" structure.
Added comp_get_list_diff() that return a char pointer to the allocated list of differences between the current .config file and the one to compare. The list is sorted alphabetically.
Added conf_write_comp() that return boolean value whether saving to file the list of differences succeed or not.
scripts/kconfig/expr.h:
-----------------------
Added the item "S_DEF_COMP" to the "enum" values used as index to the symbol.def[] array defined in the symbol "struct".
Added boolean "comp_is_avail" member to the symbol "struct" that is "true" when the symbol is present in the compared .config, "false" if it's missing in the compared .config, meaning therefore a new feature.
Defined macro SYMBOL_DEF_COMP. Unused but necessary for the logical structure of the program.
scripts/kconfig/lkc.h:
----------------------
Added <stdbool.h> header to make available boolean type for files that include the lkc.h header: confdata.c mconf.c etc.
Added "static inline" functions to retrieve value from the symbol structure, so the compiler can optimize the code.
scripts/kconfig/lkc_proto.h:
----------------------------
Added some functions prototype.
scripts/kconfig/lxdialog/menubox.c:
-----------------------------------
Added "Compare" button to the menu bar, and adjusted the code to get selected when arrow keys are used.
Added support for the key F1 to display the online help window.
Added support for the key F2 to display a view with the differences between .config files listed.
Added support for the key F4 to save to a file differences between .config files.
Adjust the locations of the menuconfig commands so that the new "Compare" command fits inside an 80-column-wide terminal. (Code written by Randy Dunlap <[email protected]>)
Added shortcuts for the new F2 (add 'D') and F4 (add 'F') keys in case function keys are intercepted by some other software layer. (Code written by Randy Dunlap <[email protected]>)
scripts/kconfig/mconf.c:
------------------------
Added/Edited various char array storing help messages at the beginning of the file used in many dialog window.
Added boolean variable "has_comp_file" to keep track whether a .config file for comparison purpose is loaded.
Edited set_config_filename(...) and added comp_set_backtitle() to notify when "Comparison Mode" is active, changing the back-title accordingly.
Edited build_conf(...) that de facto builds the interface of the main window of mconf. The changes concern item_make(...) added variable that has the "tristate" value of the compared .config file.
Added comp_show_list_diff() that return void to display a view that contains differences between the current .config file and the one to compare.
Added conf_load_comp() that return void useful to load the .config file to compare by displaying an input dialog window.
Added conf_save_comp() that return void useful to save to file the differences between the current .config file and the one to compare.
Edited conf(...), added "Comparison Mode" string to the title of the dialog menu window when comparison mode is active. Added to the "switch" construct the "case" items to handle events to: display differences, load .config file to compare and save differences to a file.
---
v4:
- Rewritten comp_get_list_diff(void) to obtain a lexicographically
sorted array. Simplified the dynamic reallocation code.
- Dropped masked_xrealloc() function.
v3:
- In comparison mode, menu items without differences left untouched.
- Added commit description to the patch body.
- Link to v3: https://lore.kernel.org/all/[email protected]/
v2:
- Fixed typos per Randy Dunlap's suggestion and added changelog
per Miguel Ojeda's suggestion.
- Link to v2: https://lore.kernel.org/all/[email protected]/
v1: https://lore.kernel.org/all/[email protected]/
scripts/kconfig/confdata.c | 189 ++++++++++++++++++++++- scripts/kconfig/expr.h | 9 ++ scripts/kconfig/lkc.h | 11 ++ scripts/kconfig/lkc_proto.h | 4 + scripts/kconfig/lxdialog/menubox.c | 29 +++- scripts/kconfig/mconf.c | 240 ++++++++++++++++++++++++++--- 6 files changed, 452 insertions(+), 30 deletions(-)
scripts/kconfig/confdata.c +188 -1
@@ -257,7 +257,7 @@ static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p) sym->flags |= def_flags;break ; } -if (def !=S_DEF_AUTO ) +if (def !=S_DEF_AUTO && def !=S_DEF_COMP )conf_warning ("symbol value '%s' invalid for %s" , p, sym->name);return 1 ;
@@ -386,6 +386,7 @@ int conf_read_simple(const char *name, int def) def_flags =SYMBOL_DEF << def;for_all_symbols (sym) { sym->flags &= ~def_flags; + sym->comp_is_avail = false;switch (sym->type) {case S_INT :case S_HEX :
@@ -445,6 +446,8 @@ int conf_read_simple(const char *name, int def) sym =sym_find (sym_name);if (!sym) { +if (def ==S_DEF_COMP ) +continue ;if (def ==S_DEF_AUTO ) {/* * Reading from include/config/auto.conf.
@@ -462,6 +465,9 @@ int conf_read_simple(const char *name, int def)continue ; } +if (def ==S_DEF_COMP ) + sym->comp_is_avail = true; +if (sym->flags & def_flags)conf_warning ("override: reassigning to symbol %s" , sym->name);
@@ -529,6 +535,113 @@ int conf_read(const char *name)return 0 ; } +const char sym_get_comp_tristate_char (struct symbol *sym) +{ +char ch ='#' ; + +if (sym_get_comp_is_avail (sym)) +switch (sym_get_comp_tristate_value (sym)) { +case yes: + ch ='*' ; +break ; +case mod: + ch ='M' ; +break ; +case no: + ch ='_' ; +break ; + } + +return ch; +} + +static int sym_name_comp (const void *p1,const void *p2) +{ +const struct symbol *const *s1 = p1, *const *s2 = p2; + +return strcmp ((*s1)->name, (*s2)->name); +} + +#define LINE_LENGTH (SYMBOL_MAXLENGTH + 32) + +char *comp_get_list_diff (void ) +{ +char *line, *l_rst, *list =NULL , ch_comp; +size_t idx, size, cnt_sym; +struct symbol *sym, **sym_arr =NULL ; +tristate tri_val, tri_comp_val; + + idx = size =0 ; + +for_all_symbols (sym) { +if (!sym->name) +continue ; +if (idx == size) { + size +=32 ; + sym_arr =xrealloc (sym_arr, size *sizeof (*sym_arr)); + } + tri_val =sym_get_tristate_value (sym); + tri_comp_val =sym_get_comp_tristate_value (sym); + +if (tri_val != tri_comp_val) + sym_arr[idx++] = sym; + } + cnt_sym = idx; +if (cnt_sym >1 ) +qsort (sym_arr, cnt_sym,sizeof (*sym_arr), sym_name_comp); + + l_rst = line =xmalloc (LINE_LENGTH ); + idx = size =0 ; + +for (size_t i =0 ; i < cnt_sym; ++i) { + tri_val =sym_get_tristate_value (sym_arr[i]); + ch_comp =sym_get_comp_tristate_char (sym_arr[i]); + +switch (tri_val) { +case yes: +snprintf (line,LINE_LENGTH ,"%s%s=y --- %c\n" , +CONFIG_ , (sym_arr[i])->name, ch_comp); +break ; +case mod: +snprintf (line,LINE_LENGTH ,"%s%s=m --- %c\n" , +CONFIG_ , (sym_arr[i])->name, ch_comp); +break ; +case no: +snprintf (line,LINE_LENGTH ,"# %s%s is not set --- %c\n" , +CONFIG_ , (sym_arr[i])->name, ch_comp); +break ; + } + +for (; *line; ++idx) { +if (idx == size) { + size +=LINE_LENGTH ; + list =xrealloc (list, size *sizeof (*list)); + } + list[idx] = *line++; + } + line = l_rst; + } +free (line); +free (sym_arr); + +if (list) + list[idx] ='\0' ; +else { + list =xmalloc (32 ); +snprintf (list,32 ,"No differences found." ); + } + +return list; +} + +bool conf_read_comp (const char *name) +{ +if (conf_read_simple (name,S_DEF_COMP )) +return true; + +return false; +} +struct comment_style {const char *decoration;const char *prefix;
@@ -801,6 +914,80 @@ int conf_write_defconfig(const char *filename)return 0 ; } +bool conf_write_comp (const char *name) +{ +FILE *fptemp, *fplist; +char *list =NULL , f_old[PATH_MAX ], tmpfile[] ="file_XXXXXX" ; +int ch; + +if (!name) +return false; + +if (is_present (name)) { +if (is_dir (name)) +return false; +snprintf (f_old,sizeof (f_old),"%s.old" , name); +if (rename (name, f_old)) { +fprintf (stderr,"Failed to rename file: %s to %s\n" , name, f_old); +return false; + } + } + + list =comp_get_list_diff (); +int tmpfd =mkstemp (tmpfile); + +if (tmpfd <0 ) { +fprintf (stderr,"Failed to create temporary file.\n" ); +return false; + } + + fptemp =fdopen (tmpfd,"w" ); +if (!fptemp) { +remove (tmpfile); +fprintf (stderr,"Failed to open a stream for the temporary file: %s\n" , tmpfile); +return false; + } + + fplist =fmemopen (list,strlen (list),"r" ); +if (!fplist) { +fclose (fptemp); +remove (tmpfile); +fprintf (stderr,"Failed to open a stream for fplist.\n" ); +if (list) +free (list); +return false; + } + +while ((ch =fgetc (fplist)) !=EOF ) +fputc (ch, fptemp); + +if (ferror (fptemp)) {/* checks whether fputc has encountered errors */ +fclose (fptemp);/* while writing the file */ +fclose (fplist); +if (list) +free (list); +fprintf (stderr,"An error occurred when writing the file: %s" , tmpfile); +return false; + } + +if (rename (tmpfile, name)) { +fprintf (stderr,"Failed to rename file: %s to %s\n" , tmpfile, name); +fclose (fptemp); +fclose (fplist); +if (list) +free (list); +remove (tmpfile); +return false; + } + +fclose (fptemp); +fclose (fplist); +if (list) +free (list); + +return true; +} +int conf_write (const char *name) {FILE *out;
scripts/kconfig/expr.h +9 -0
@@ -76,6 +76,7 @@ enum {S_DEF_AUTO ,/* values read from auto.conf */ S_DEF_DEF3 ,/* Reserved for UI usage */ S_DEF_DEF4 ,/* Reserved for UI usage */ +S_DEF_COMP ,/* values for comparison purposes */ S_DEF_COUNT };
@@ -140,6 +141,13 @@ struct symbol {* "Weak" reverse dependencies through being implied by other symbols */ struct expr_value implied; + +/* +* Used by comparison code. "true" when the symbol is present in the compared +* .config, "false" if it's missing in the compared .config, meaning +* therefore a new feature. +*/ +bool comp_is_avail; };#define SYMBOL_CONST 0x0001/* symbol is const */
@@ -157,6 +165,7 @@ struct symbol {#define SYMBOL_DEF_AUTO 0x20000/* symbol.def[S_DEF_AUTO] is valid */ #define SYMBOL_DEF3 0x40000/* symbol.def[S_DEF_3] is valid */ #define SYMBOL_DEF4 0x80000/* symbol.def[S_DEF_4] is valid */ +#define SYMBOL_DEF_COMP 0x100000/* symbol.def[S_DEF_COMP] is valid */ #define SYMBOL_MAXLENGTH 256
scripts/kconfig/lkc.h +11 -0
@@ -9,6 +9,7 @@#include <assert.h> #include <stdio.h> #include <stdlib.h> +#include <stdbool.h> #include "expr.h"
@@ -131,6 +132,16 @@ static inline bool sym_has_value(const struct symbol *sym)return sym->flags &SYMBOL_DEF_USER ? true : false; } +static inline bool sym_get_comp_is_avail (struct symbol *sym) +{ +return sym->comp_is_avail; +} + +static inline tristate sym_get_comp_tristate_value (struct symbol *sym) +{ +return sym->def[S_DEF_COMP ].tri; +} + #ifdef __cplusplus }#endif
scripts/kconfig/lkc_proto.h +4 -0
@@ -7,6 +7,10 @@/* confdata.c */ void conf_parse (const char *name);int conf_read (const char *name); +bool conf_read_comp (const char *name); +bool conf_write_comp (const char *name); +const char sym_get_comp_tristate_char (struct symbol *sym); +char *comp_get_list_diff (void );int conf_read_simple (const char *name,int );int conf_write_defconfig (const char *name);int conf_write (const char *name);
scripts/kconfig/lxdialog/menubox.c +21 -8
@@ -133,14 +133,15 @@ static void print_arrows(WINDOW * win, int item_no, int scroll, int y, int x,*/ static void print_buttons (WINDOW * win,int height,int width,int selected) { -int x = width /2 -28 ; +int x = width /2 -30 ;int y = height -2 ;print_button (win,"Select" , y, x, selected ==0 ); -print_button (win," Exit " , y, x +12 , selected ==1 ); -print_button (win," Help " , y, x +24 , selected ==2 ); -print_button (win," Save " , y, x +36 , selected ==3 ); -print_button (win," Load " , y, x +48 , selected ==4 ); +print_button (win," Exit " , y, x +10 , selected ==1 ); +print_button (win," Help " , y, x +20 , selected ==2 ); +print_button (win," Save " , y, x +30 , selected ==3 ); +print_button (win," Load " , y, x +40 , selected ==4 ); +print_button (win,"Compare" , y, x +50 , selected ==5 );wmove (win, y, x +1 +12 * selected);wrefresh (win);
@@ -354,14 +355,19 @@ int dialog_menu(const char *title, const char *prompt,case TAB :case KEY_RIGHT : button = ((key ==KEY_LEFT ? --button : ++button) <0 ) - ?4 : (button >4 ?0 : button); + ?5 : (button >5 ?0 : button);print_buttons (dialog, height, width, button);wrefresh (menu);break ; +case KEY_F (1 ): +case KEY_F (2 ): +case KEY_F (4 ):case ' ' :case 's' :case 'y' : +case 'd' : +case 'f' :case 'n' :case 'm' :case '/' :
@@ -376,6 +382,7 @@ int dialog_menu(const char *title, const char *prompt,item_set (scroll + choice);item_set_selected (1 );switch (key) { +case KEY_F (1 ):case 'h' :case '?' :return 2 ;
@@ -392,9 +399,15 @@ int dialog_menu(const char *title, const char *prompt,return 9 ;case 'z' :return 10 ; +case KEY_F (2 ):/* Differences between .config files view */ +case 'd' : +return 40 ; +case KEY_F (4 ):/* Save to file differences between .config files */ +case 'f' : +return 60 ;case '\n' : -return button; - } +return button ==5 ?50 : button;/* Workaround for */ + }/* Compare button */ return 0 ;case 'e' :case 'x' :
scripts/kconfig/mconf.c +219 -21
338 lines not on this page · raw message
Signature · 1 line
2.47.3
Nicolas Schier
maintainerHi Franco,
thanks for your contribution. Some notes below:
Quoted 12 lines · Franco Martelli
This patch allows to compare the tristate value of two .config files inline, symbol by symbol, in mconf (make menuconfig) only. It can be really useful when customizing the .config file.
When a new stable release of a distribution is available, in the Linux kernel many things has changed, this patch comes in help in this situations, it allows to easily compare the customized .config file built for the previous version of the distribution, with the one provided by the new software distribution, used as reference. Generally it can be helpful when the differences between .config files are huge, because you can navigate across them in the menu window.
Quoted 4 lines
The patch has a limitation, it only show the tristate value (Y/N/M) not differences for symbol with a value (string), but it also marks with a "#" the symbol missing in the loaded .config, meaning therefore the symbol as a new feature.
I must confess, that I am not convinced yet, that this will be helpful for general purposes. Yes, large changes in .config files are not easy to parse, but I do not see how your solution is easier to handle than the use of scripts/diffconfig, other than not showing removed config options.
Quoted 3 lines
o I've also added support for the more canonical <F1> key to show inline help window, in addition to <?> and <h> keys.
Please split-off logical these independent changes into separate patches (Add support for 'F1' hot-key).
Using simple letters (here 'h') as hot-keys is not a good idea as those are already used for jumping through the currently shown menu item (cp. highlighted letters in menu config screens).
Quoted 4 lines
o By pressing the <F2> or <D> key you will get a view with all the symbol differences listed.
o By pressing the <F4> or <F> key you'll save to a file the differences.
While the list might be helpful for comparing two config files, a large list within an ncurses window does not look like a good thing to me.
When I save the list to a file (F4), I'd rather choose the output of diffconfig for evaluation -- as it is more complete and has a layout that looks more straight-forward and clear to me.
Quoted 3 lines
o Added help text that it describes the new features.
This software is under GPL-2.0 license.
Please note that the whole Linux kernel source and its build system is GPL-2.0 per se, cp. COPYING and the SPDX header line in each file.
Quoted 8 lines
Changelog:
----------
scripts/kconfig/confdata.c:
---------------------------Silenced a warning emitted when parsing the .config file to compare.
[...]
Please put any patch changelog below the triple-dash line ('---').
I have not looked at the code, yet, as I have doubts regarding the usefulness (see above).
Iff nobody mentions strong interest in these changes, please re-evaluate if it makes sense for you to invest into a v5.
Kind regards,
Nicolas
Quoted 3 lines · Nicolas Schier
Hi Franco,
thanks for your contribution. Some notes below:
Hi Nicolas,
thank you very much for your answer.
Quoted 19 lines · Franco Martelli
Quoted 12 lines
This patch allows to compare the tristate value of two .config files inline, symbol by symbol, in mconf (make menuconfig) only. It can be really useful when customizing the .config file.
When a new stable release of a distribution is available, in the Linux kernel many things has changed, this patch comes in help in this situations, it allows to easily compare the customized .config file built for the previous version of the distribution, with the one provided by the new software distribution, used as reference. Generally it can be helpful when the differences between .config files are huge, because you can navigate across them in the menu window.
Quoted 4 lines
The patch has a limitation, it only show the tristate value (Y/N/M) not differences for symbol with a value (string), but it also marks with a "#" the symbol missing in the loaded .config, meaning therefore the symbol as a new feature.
Quoted 5 lines
I must confess, that I am not convinced yet, that this will be helpful for general purposes. Yes, large changes in .config files are not easy to parse, but I do not see how your solution is easier to handle than the use of
scripts/diffconfig, other than not showing removed config options.
the strong of my patch is interaction; scripts/diffconfig merely show you a list of differences that you'll have to handle instead, having differences reported near every symbol's item in the mconf window let you to interact with the differences inline, on the fly.
Quoted 7 lines
Quoted 4 lines
o I've also added support for the more canonical <F1> key to show inline help window, in addition to <?> and <h> keys.
Please split-off logical these independent changes into separate patches (Add support for 'F1' hot-key).
OK, sorry!
Quoted 4 lines
Using simple letters (here 'h') as hot-keys is not a good idea as those are already used for jumping through the currently shown menu item (cp. highlighted letters in menu config screens).
the 'h' hot-key was already in the source code used to open the 'help' window, it wasn't a my change.
Using simple letters to call functionality was strongly advised to me by Randy Dunlap because some desktop environments intercept function keys by default, using letters provides a workaround for this.
Quoted 8 lines
Quoted 5 lines
o By pressing the <F2> or <D> key you will get a view with all the symbol differences listed.
o By pressing the <F4> or <F> key you'll save to a file the differences.
While the list might be helpful for comparing two config files, a large list within an ncurses window does not look like a good thing to me.
True but the list will (hopefully) shrink during the configuration process and the list now (version 4) is sorted alphabetically.
Quoted 4 lines
When I save the list to a file (F4), I'd rather choose the output of diffconfig for evaluation -- as it is more complete and has a layout that looks more straight-forward and clear to me.
OK, it seems easy to implement.
Quoted 11 lines
Quoted 3 lines
o Added help text that it describes the new features.
This software is under GPL-2.0 license.
Please note that the whole Linux kernel source and its build system is GPL-2.0 per se, cp. COPYING and the SPDX header line in each file.
Quoted 4 lines
Changelog:
----------
Quoted 7 lines
Quoted 4 lines
scripts/kconfig/confdata.c:
---------------------------Silenced a warning emitted when parsing the .config file to compare.
[...]
Please put any patch changelog below the triple-dash line ('---').
OK sorry, I'm new to the kernel process patching.
Quoted 6 lines
I have not looked at the code, yet, as I have doubts regarding the usefulness (see above).
Iff nobody mentions strong interest in these changes, please re-evaluate if it makes sense for you to invest into a v5.
I'll wait a couple of week, if in the meanwhile nobody appreciate my patch and therefore it will be rejected I'll made it available on my Github profile for the Linux 6.12.y kernel series.
Quoted 2 lines
Kind regards,
Nicolas
Thanks again, kind regards.
Signature · 1 line
Franco Martelli