summaryrefslogtreecommitdiff
path: root/kconfiglib.py
AgeCommit message (Collapse)Author
2019-05-22Say "removes" instead of "resets" in the unset_value(s)() docstringUlf Magnusson
Clearer.
2019-05-19Comment nitUlf Magnusson
2019-05-11Clarify direct_dep and dep documentationUlf Magnusson
- Mention that having no direct dependencies corresponds to having y direct dependencies - Remove the note about how direct_dep is used internally. It's also used for the select-with-unsatisfied-deps warning. - Remove the note about how checking direct_dep might be "redundant" since it's propagated. direct_dep can be useful in scripts still, and maybe it could scare people away from it. - Say 'surrounding menus and ifs' instead of of 'parent' in the 'dep' docstring - Fix two s/config/kconfig/ typos
2019-05-10Improve the 'referenced' docstringUlf Magnusson
- Point out why dependencies from surrounding if's and menus are included - Clarify that .referenced isn't transitive. Only "direct" references are included. - Give a hint about direct dependencies and expr_items() Prompted by https://github.com/ulfalizer/Kconfiglib/issues/69.
2019-05-10Do not set top_node location to location of 'mainmenu' statementUlf Magnusson
It's undocumented and unguessable that Kconfig.top_node.filename/linenr gets set to the location of the 'mainmenu' statement (if any). Always set it to the first line of the top-level Kconfig instead, which should be more expected.
2019-05-03guiconfig: Add a Tkinter-based menuconfigUlf Magnusson
This is a graphical configuration interface written in Tkinter. Like menuconfig.py, it supports showing all symbols (with invisible symbols in red) and jumping directly to symbols. Symbol values can also be changed directly from the jump-to dialog. When single-menu mode is enabled, a single menu is shown at a time, like in the terminal menuconfig. Only this mode distinguishes between symbols defined with 'config' and symbols defined with 'menuconfig'. Compatible with both Python 2 and Python 3. Has been tested on X11, Windows, and macOS. To avoid having to carry around a bunch of GIFs, the image data is embedded in guiconfig.py. To use separate GIF files instead, change _USE_EMBEDDED_IMAGES to False. The image files can be found in https://github.com/ulfalizer/Kconfiglib/tree/screenshots/guiconfig. A new `make guiconfig` target in the Makefile patch will run the GUI configuration interface on the Linux kernel.
2019-04-30Never prepend '.' to $KCONFIG_CONFIG.oldUlf Magnusson
In retrospect, trying to be "helpful" by saving the old version of a $KCONFIG_CONFIG that does not start with a '.' as e.g. '.config.old' instead of 'config.old' is a bad idea, because it means that scripts can't rely on the backup file simply being called $KCONFIG_CONFIG.old. I spotted this causing compatibility issues in https://github.com/automate-lfs/jhalfs/commit/a645174fd43ba4eee84089965df85785878e7aa6. I had Vim backup files and the like in mind originally, but .config.old is much more likely to be processed by scripts. This is a small backwards compatibility break, so the major version will be increased to 11.
2019-04-28Avoid chdir()ing in sync_deps()Ulf Magnusson
Temporarily changing the working directory is iffy if threads are involved, since other code will see the change. Seems like a generally rude thing for a random library function to do. dir_fd (open() relative to directory) is another option, but it's Python 3 only, only available on the low-level os.open() interface, and might not be universally supported.
2019-04-28Remove redundant comment in _auto_menu_dep()Ulf Magnusson
Says the same thing the comment above it says.
2019-03-24Use 'from ... import ...' for os.path and glob stuffUlf Magnusson
These are clear in context without the module name, and it speeds up the 'source' code a tiny bit.
2019-03-20Whitespace nitUlf Magnusson
2019-03-16Warn for unquoted argument to 'source', etc.Ulf Magnusson
Print a warning suggesting to add quotes for things like source foo/bar/Kconfig menu title prompt unquoted Example warning: Kconfig:32: warning: style: quotes recommended around 'lib/Kconfig.debug' in 'source lib/Kconfig.debug' That quoteless syntax is supported for compatibility with old versions of the C tools. It only works for a single word.
2019-03-14Comment nitUlf Magnusson
2019-03-14Put two blank lines between top-level functions/classesUlf Magnusson
Make kconfiglib.py consistent with the utilities.
2019-03-14Refactor and optimize type parsing a bitUlf Magnusson
Have BOOL/TRISTATE/... match _T_BOOL/_T_TRISTATE/... so that _set_type() doesn't have to do any conversion in the common case. Conversion is still needed for _T_DEF_BOOL/_T_DEF_TRISTATE/..., but those are rare. Also make use of UNKNOWN being falsy. Piggyback some rearranging of global constants so that related stuff appears closer together, for readability.
2019-03-14Clarify shutil lazy importUlf Magnusson
2019-03-10Import 'platform' and 'subprocess' as neededUlf Magnusson
Saves around 10 ms of startup time when they aren't, as measured with '-X importtime'.
2019-03-08Fix typo in kconfig_filenames docUlf Magnusson
2019-03-06Code formatting nitUlf Magnusson
Make the exception argument to _KconfigIOError() harder to miss.
2019-03-06Give more helpful error messages when files are missingUlf Magnusson
The current error message talks a lot about $srctree, but $srctree is seldom the culprit in practice. More common is 'source "$(SOME_ENV_VAR)/foo"`, where SOME_ENV_VAR hasn't been set. Include the complete 'source ...' line for missing Kconfig files, and mention unset environment variables as a hint. Only mention $srctree briefly. Also shorten the message when a .config can't be a found a bit. This message would usually only be seen when working directly with the library.
2019-02-23Fix spelling in commentUlf Magnusson
2019-02-23Shorten Symbol/Choice.referenced()Ulf Magnusson
Use a set comprehension.
2019-02-23Shorten __repr__() and __str__() code a bitUlf Magnusson
2019-02-20Document that kconfig_filenames keeps absolute paths as-isUlf Magnusson
Came up in https://github.com/ulfalizer/Kconfiglib/issues/67.
2019-01-15Update copyright years for 2019Ulf Magnusson
2018-12-24Warn for '# CONFIG_FOO is not set' when FOO is referenced but undefinedUlf Magnusson
Due to an oversight, '# CONFIG_FOO is not set' with FOO undefined only triggered a warning about assigning an undefined symbol if FOO was never referenced inside the Kconfig files.
2018-12-24menuconfig: Prompt for save if a different .config would be savedUlf Magnusson
Previously, menuconfig.py only prompted for saving the configuration if .config didn't exist or the user changed symbol values within the interface. Also make it prompt for save if Kconfig symbols have been added, removed, or have had their defaults changed, provided it would make the saved .config differ from the loaded one. This usually won't matter for correctness, because loading an outdated configuration performs an implicit olddefconfig, but it's less confusing. Also add a Kconfig.missing_syms attribute that records all assignments to undefined symbols in the most recently loaded .config file. This is needed to implement the check for whether the saved .config would be different. As an unrelated change, always prompt for saving if a .config has been loaded from within the menuconfig interface. The intention is probably often to save the configuration somewhere else, even if it isn't modified.
2018-12-15Simplify _decoding_error() a bitUlf Magnusson
Also add quotes around the filename.
2018-12-15Fix user-defined preprocessor function example codeUlf Magnusson
The functions must be defined before they can be put into 'functions'.
2018-12-15Improve error for missing endchoice/endif/endmenuUlf Magnusson
Say what was expected in the error message.
2018-12-15Store file.readline in _readline instead of having _fileUlf Magnusson
Gets rid of some lookups. A bigger hotspot is all the _next_line() calls though. Wonder if there's some nice restructuring to avoid them. Getting rid of the _reuse_tokens flag would be nice too.
2018-12-15Tighten up _next_line()Ulf Magnusson
self._line is only used for error reporting, and the empty string returned at EOF would never be shown. Move the assignment to after readline() and use a local variable to hold the line instead, to get rid of some property lookups.
2018-12-15Check isspace() before EOF in _parse_help()Ulf Magnusson
More common. isspace() returns False for empty strings.
2018-12-09Clarify that load_config()'s filename argument defaults to NoneUlf Magnusson
Had missed the '(default: None)', and it doesn't hurt to point it out in the description either. Point out that filename=None is the default in the write_config() 'filename' description too, though it already had the '(default: None)'.
2018-12-08_save_old() code nitsUlf Magnusson
2018-12-08Simplify 'verbose' check in write_config()Ulf Magnusson
2018-12-08Preserve symlinks when writing .config.old filesUlf Magnusson
if .config is a symlink, then the intention is probably to overwrite the target, but rename()ing the symlink to .config.old interferes with that. Use the shutil.copyfile() fallback instead if .config is a symlink.
2018-12-08Make {load,write}_config(filename=None) implement the standard behaviorUlf Magnusson
Make the previously obligatory 'filename' argument to load_config() and write_config() default to None, and have that implement the behavior you'd usually want: read/write either KCONFIG_CONFIG or ".config" if unset, and read the 'option defconfig_list' configuration file if KCONFIG_CONFIG/".config" doesn't exist. For load_config(), filename=None also allows the configuration file to be missing without raising an error. load_config() returns True if a local configuration file was loaded, which is useful to check in the menuconfig (if no local configuration file exists, we always want to prompt for saving the configuration when exiting). Also add a 'verbose' argument (default True) to load_config() and read_config() that makes them print which files were read/written in filename=None mode. Also generalize olddefconfig.py and oldconfig.py to not require there to already be a local configuration file. This was a bit silly for olddefconfig.py in particular. Remove the examples/defconfig.py script. It's a duplicate of olddefconfig.py.
2018-12-08Save existing configuration to .<filename>.old in write_config()Ulf Magnusson
Add a default-True 'save_old' flag to write_config(). If 'save_old' is True and an existing configuration file is being overwritten, a copy of the old configuration file is saved to .<filename>.old (e.g. .config.old) in the same directory. Errors are ignored, as the old configuration would usually just be a nice-to-have, and not essential. The same functionality could be added for minimal configuration files and headers, but it's probably most useful for configuration files.
2018-12-07Rename 'val_sym' to 'sym' in str_value()Ulf Magnusson
Consistent with elsewhere.
2018-12-07Remove _internal_error()Ulf Magnusson
These type sanity checks have never hit once during development over the years, and were inconsistently applied too. Remove them to simplify the code. Keep the InternalError exception for backwards compatibility, in case something catches it.
2018-12-01Flag removed symbols as changed in sync_deps()Ulf Magnusson
If a symbol is removed from a Kconfig file, it makes sense to flag it as changed, so that things that still (probably accidentally) depend on it get rebuilt. Saw a patch for the C tools with the same effect floating around, so might as well add it already. The C tools had other brokeness as well though...
2018-12-01Tighten up help text parsingUlf Magnusson
Get rid of _indentation() and inline it into _parse_help(), adding some simplifications and optimizations along the way. Saves a few % of parsing of time. Help text parsing is surprisingly hot.
2018-11-26Reorder some tuples to put y firstUlf Magnusson
CONFIG_FOO=y and 'default y' and the like are more common than the n versions, so test for them first. Turning the tuples into sets would be even better on Python 3, as it optimizes sets with constant keys into a LOAD_CONST, but it has a performance penalty on Python 2.
2018-11-26Speed up more token membership testsUlf Magnusson
Similar change to commit 4b23936 ("Speed up some token tests"), just for more tests. This especially helps for the "not a property line" case in _parse_properties(), which checks against all the cases. Saves 2-3% of parsing time together with the earlier change.
2018-11-25Whitespace nitUlf Magnusson
2018-11-25Speed up some token testsUlf Magnusson
Turn some of the hotter membership test tuples into global sets, like was already done for _TYPE_TOKENS. That saves some global lookups for the tuple members and avoids repeatedly recreating tuples. It's 30%-50% faster in a microbenchmark, even for two-element tuples (with global lookups for the members).
2018-11-25Move _TOKEN_TO_TYPE conversion into _set_type()Ulf Magnusson
Factors out some code. Also use a quick 'is not UNKNOWN' test first inside it, which will usually fail, since single-def symbols are more common. That avoids building a tuple too.
2018-11-24Use constants when _tokens_i is knownUlf Magnusson
Same deal as for the initial token, except we sometimes know that we're dealing with the second token as well. Inline _expect_nonconst_sym_and_eol() and _expect_str(), which are single-use. That allows more specific error messages to be used as well. Also tweak an outdated comment in _tokenize() re. None-termination. Token fetching is more manual now.
2018-11-24Simplify eval_string() a bitUlf Magnusson