Kconfiglib.git/kconfiglib.py, branch v12.0.0

Improve warning control API (with backwards compatibility)

2019-06-03T04:50:06Z

A wart of the warning control API (enable/disable_*_warnings()) is that the current warning settings can't be queried. Querying warning settings is useful in functions that want to temporarily enable/disable some warning and then put things back to how they were. kconfiglib.load_allconfig() ran into this, for example. Make the internal warning control variables public (improve the naming at the same time), and encourage just setting them directly. Keep the old API for backwards compatibility. Also remove _warn_redun_assign() and _warn_override(). They're trivial and were called in a single place.

Have load_config() and write_(min_)config() return messages

2019-06-03T04:50:06Z

Hardcoding load_config() and write_(min_)config() to write any message to stdout is awkward, because it means that the message can't be easily reused when stdout is the wrong place to write it to (e.g. in menuconfig/guiconfig). This gets extra bad now that there's also the "No change to ..." message. Modify load_config() and write_(min_)config() to return the message as a string instead, and have them always return a message, instead of just when 'filename' is None and verbose=True. This makes things flexible and straightforward. Use the new behavior in menuconfig.py and guiconfig.py. They now show "No change to ..." when saving a file doesn't modify it. Tools that want to write messages to stdout should now do print(kconf.load_config()) / print(kconf.write_config()). There's no clean way to preserve perfect backwards compatibility here, but keep accepting the 'verbose' argument and print a deprecation warning if a value is ever passed for it. That way, scripts will keep running, though possibly with less output on stdout. This changes the meaning of the load_config() return value as well, though I suspect it was only ever used by the menuconfig/guiconfig interfaces. The new behavior applies for kconfiglib.VERSION >= (12, 0, 0).

Add kconfiglib.VERSION

2019-06-03T02:42:35Z

Holds a (, , ) tuple, e.g. (12, 0, 0).

Fix obscure crash with rsource and $srctree pointing to a symlink

2019-06-01T04:21:54Z

Sourcing a file with an absolute path and using rsource in it triggered a relpath() between the absolute path and $srctree. Since e.g. symlink/../bar/ = bar/ is not guaranteed for symlinks, this could lead to the rsource'd file not being found if $srctree pointed to a symlink. Switch to a simpler, more textual method for stripping $srctree from glob results, which should be robust against symlink shenanigans. This also makes the code a bit easier to follow. Discovered by Marc Herbert. Piggyback some minor cleanup.

Comment nits

2019-05-30T23:46:21Z

Remove some 'Note:'s, update some stuff.

Leave unchanged output files untouched

2019-05-30T22:08:14Z

Before writing a configuration file or header file, compare the old contents of the file against the new contents. If there's no change, skip the write, to avoid updating the file modification time. This might avoid triggering redundant rebuilds depending on how the build system is set up, and could allow for a simpler setup.

Split out helper for writing symbols in write_config()

2019-05-29T00:47:59Z

Gives a better overview.

Use os.replace() if available in _save_old()

2019-05-29T00:47:44Z

Gives *nix rename() semantics on Windows, with overwriting of the target file. Also limit the scope of the catch-all try-except.

Explain why node_iter() is not a good fit for write_config()

2019-05-28T15:09:09Z

Add '# end of ' after menus in .config

2019-05-28T15:00:24Z

Mirrors commit aff11cd983ec ("kconfig: Terminate menu blocks with a comment in the generated config") in the kernel. This makes the compatibility tests pass again, and is handy.