summaryrefslogtreecommitdiff
path: root/README.rst
AgeCommit message (Collapse)Author
2018-10-03Make 10.10.2 releasev10.10.2Ulf Magnusson
Just adds commit 4af2ac3 ("Actually fix README RST display on PyPI").
2018-10-03Actually fix README RST display on PyPIUlf Magnusson
Use anonymous hyperlinks to avoid having two links named 'Kconfig', like in commit fe28703 ("Fix README RST display on PyPI").
2018-10-03Make 10.10.1 releasev10.10.1Ulf Magnusson
Just adds commit fe28703 ("Fix README RST display on PyPI").
2018-10-03Fix README RST display on PyPIUlf Magnusson
Use anonymous hyperlinks to avoid having two links named 'here', which RST apparently doesn't like. Related: https://stackoverflow.com/questions/5464627/how-to-have-same-text-in-two-links-with-restructured-text/14067756
2018-10-03Make 10.10.0 releasev10.10.0Ulf Magnusson
Gets the README updated from commit 534e3e7 ("Add a 'getting started' section to the README") up on PyPI.
2018-10-03Fix is/if typo in READMEUlf Magnusson
2018-10-03Mention that pip3 is needed for menuconfigUlf Magnusson
2018-10-03Add a 'getting started' section to the READMEUlf Magnusson
Might make it clearer how the different parts fit together. Also mention that deps/auto.conf can be used as Make input, and that it's preferable to using .config. This is hard to discover on your own.
2018-10-03Make 10.9.3 releasev10.9.3Ulf Magnusson
Adds commit 21e47ce ("Fix parse error message on the line after help texts"), which fixes incorrect line contents being reported for parse errors on the line after a help text.
2018-10-02Link olddefconfig.py in the READMEUlf Magnusson
2018-10-02Mention documentation generation earlyUlf Magnusson
2018-10-02API should be stable by nowUlf Magnusson
2018-10-02Make 10.9.2 releasev10.9.2Ulf Magnusson
Adds some documentation nits: - 08abf44 ("Mention that pydoc works after installing with pip") - 6aaf01c ("Clean up documentation a bit re. named choice") - 6fe5198 ("menuconfig: Mark quit_dialog() as internal")
2018-10-02Mention that pydoc works after installing with pipUlf Magnusson
Also mention that menuconfig.py has documentation.
2018-10-01Make 10.9.1 releasev10.9.1Ulf Magnusson
Adds commit 43e7711 ("setup: Use a list instead of a tuple for 'classifiers'"), which fixes a setup.py issue on Python 3.7.
2018-10-01Make 10.9.0 releasev10.9.0Ulf Magnusson
Adds commit 3b692df ("olddefconfig: Add script"), which bundles a new script that mimics 'make olddefconfig'. This could also be accomplished by entering the menuconfig interface and saving, but its more awkward. Some minor internal documentation clarifications and cleanups are included as well: - Commit 53db3ee ("Clarify node_iter() documentation re. iteration order") - Commit c1dcaa3 ("Refactor parsing to get rid of _saved_line") - Commit 6aab113 ("Don't set filename and linenr on 'if' menu nodes")
2018-09-27Make 10.8.1 releasev10.8.1Ulf Magnusson
Adds commit c91e17c ("Give clearer errors for bad endchoice/endif/endmenu nesting"). Previously, an endchoice/endif/endmenu without a corresponding choice/if/menu generated a cryptic "unrecognized construct" error.
2018-09-26Point out the Linux kernel Kconfigs being hugeUlf Magnusson
2018-09-23Make 10.8.0 releasev10.8.0Ulf Magnusson
Adds support for user-defined preprocessor functions in Python, which can be used to get information from existing Python tools into Kconfig, e.g. to have Kconfig symbols depend on hardware information stored in some other format. See commit b6827ca ("Add support for user-defined Python preprocessor functions").
2018-09-23Add support for user-defined Python preprocessor functionsUlf Magnusson
Allow preprocessor functions to be defined in Python by putting a module called 'kconfigfunctions' into sys.path. Internally, this simply adds the functions to the predefined functions in Kconfig._functions. User-defined Python functions make it simple to integrate information from existing Python tools into Kconfig, e.g. to have Kconfig symbols depend on hardware information stored in some other format. This might be used to get device tree information into Kconfig in Zephyr. Piggyback module docstring documentation for some extensions that were previously only mentioned in the README.
2018-09-14Make 10.7.0 releasev10.7.0Ulf Magnusson
Adds commit b9b2ebb ("menuconfig: Add RGB color support to styles."), which makes it possible to specify colors in MENUCONFIG_STYLE using #RRGGBB notation. The rendered colors may be more or less exact depending on terminal capabilities. In the best case, we can redefine colors. Otherwise, we fall back on the closest available color. Contributed by Mitja Horvat (punkfluid).
2018-09-09Make 10.6.1 releasev10.6.1Ulf Magnusson
Adds commit af6c8dc ("menuconfig: Fix some glitching on small terminals"), which fixes some minor graphical glitching in the menuconfig interface when the terminal is too small for things to fit. Commit 374f488 ("Clean up kernel Makefile patch and add new targets") adds some new targets to the Linux makefile patch as well, though the makefile patch isn't bundled on PyPI.
2018-09-09Mention the jump-to menuconfig functionality in the text tooUlf Magnusson
2018-09-09Replace all menuconfig screenshots with a single gif animationUlf Magnusson
Makes the README much less spammy.
2018-09-08Clean up kernel Makefile patch and add new targetsUlf Magnusson
Add two new targets: - 'make kmenuconfig' runs the menuconfig interface - 'make dumpvarsconfig' lists all referenced environment variables together with their values (assuming they used the preprocessor syntax) Remove the 'kconfiglibtestconfig' target, which is no longer used. Also clean up the target definitions. The joys of ancient code.
2018-09-08Add some more thanks to the READMEUlf Magnusson
2018-09-08Make 10.6.0 releasev10.6.0Ulf Magnusson
New features: - Commit ac8d152 ("menuconfig: Add support for custom color schemes (aka styles)"), contributed by Mitja Horvat (pinkfluid), adds support for configuring the style (colors and attributes) of menuconfig interface elements by setting a new MENUCONFIG_STYLE environment variable. The format of MENUCONFIG_STYLE is documented in the menuconfig.py module docstring. This format is now used internally as well to define the predefined styles. - Commit a092257 ("Allow macro expansion within symbol names") adds support for expanding macros within symbol names. This could be used e.g. to define template Kconfig files that get instantiated by setting preprocessor variables before including them. Other changes: - Commit 6683213 ("Allow user values on 'option env' symbols") makes it possible to give 'option env' symbols user values. There's no good reason to disallow it (it's a leftover from an older way of implementing them), and it simplifies the code a bit. Note that 'option env' symbols are only supported for backwards compatibility at this point. Environment variables can be expanded directly.
2018-08-29Make 10.5.0 releasev10.5.0Ulf Magnusson
Adds a small menuconfig tweak that could avoid some user confusion: Commit 66a2bf5 ("menuconfig: Do not use red for invisible symbols outside of show-all mode")
2018-08-29Make 10.4.0 releasev10.4.0Ulf Magnusson
New features: - Commit 84bd863 ("menuconfig: Add a more 'make menuconfig'-like color scheme") adds an alternative menuconfig color scheme contributed by contributed by Mitja Horvat (pinkfluid). The new color scheme can be enabled by setting the environment variable MENUCONFIG_THEME to 'aquatic'. The default color scheme now also uses bold text for the selected entry, like the 'aquatic' theme. Fixes: - Commit d1e2a65 ("menuconfig: Always show implicit submenus with visible nodes") fixes a display issue involving prompt-only conditions where visible child nodes could disappear outside of show-all mode. Other changes: - Commit 0ed2ba0 ("Improve the running-without-Makefile-patch documentation") updates the documentation on how to run Kconfiglib on the Linux kernel without using the Makefile patch. - Misc. internal menuconfig refactoring.
2018-08-26Make 10.3.0 releasev10.3.0Ulf Magnusson
New features: - Commit 20de53b ("Add a Kconfig.kconfig_filenames attribute") and commit 932d0f7 ("Add a Kconfig.env_vars attribute that lists env. variables") make lists of all Kconfig files and referenced environment variables available. This could be used e.g. to implement alternative incremental build schemes. Note that the sync_deps() mechanism already indirectly catches any relevant changes to files and environment variables though (anything that changes the configuration output). - Commit 17d7c1e ("menuconfig: Show all symbols at each menu location for multi.def. choices") makes it so that if a named choice is defined in multiple locations, each of which adds options, you can select any of the options regardless of via menu entry you enter the choice. Previously, you could only select the options defined at that menu entry's location. Named choices with symbols in more than one location are completely broken in the C tools, so there's no reference for the behavior there. This seems less confusing at least. Suggested by Mitja Horvat (pinkfluid). Fixes: - Commit 0b46af4 ("menuconfig: Don't return when selecting a choice symbol with children") improves menuconfig behavior in an extremely obscure case. - Commit 1c2c4ae ("oldconfig: Fix help display command for choices") makes '?' print the help for choices in oldconfig. The command was accidentally set to '??' there. - Commit ddfd5df ("Improve menu structure for promptless choices") fixes a menuconfig display issue for promptless choices (which can appear "legitimately" if a named choice is defined in multiple locations to add extra options). Cleanup: - Commit 2320b7a ("oldconfig: Use Kconfig.node_iter() and clean up") - Some manual tree walking in other places has also been rewritten to use Kconfig.node_iter().
2018-08-24Make 10.2.1 releasev10.2.1Ulf Magnusson
Fixes broken-looking menuconfig include path information for items in the top-level Kconfig file, via commit 64600b3 ("menuconfig: Hide the include path for top-level items").
2018-08-24Make 10.2.0 releasev10.2.0Ulf Magnusson
Adds commit 13884e9 ("Show include paths in menuconfig symbol information"), which adds a MenuNode.include_path attribute to Kconfiglib. MenuNode.include_path holds the Kconfig include path of the menu node, which shows how its Kconfig file got 'source'd, starting from the top-level Kconfig file. MenuNode.include_path is used to show include paths in the menuconfig symbol information. It will also be used in genrest.py in Zephyr, which generates an RST Kconfig reference.
2018-08-23Make 10.1.1 releasev10.1.1Ulf Magnusson
Includes two small bug fixes: - Commit 9b77511 ("Fix file descriptor leak for the top-level Kconfig file") - Commit d158fed ("Fix recursive 'source' error reporting")
2018-08-23Make 10.1.0 releasev10.1.0Ulf Magnusson
New features: - Commit 7dae988 ("Add a generic node iterator") adds a Kconfig.node_iter() helper generator for iterating through all menu nodes in the menu tree, in definition order. Optionally, symbols defined in multiple locations are only generated once. This generator is now used internally by write_config() as well. Suggested by Mitja Horvat (pinkfluid). - Commit d2c1430 ("Introduce Kconfig.unique_defined_syms and Kconfig.unique_choices") adds versions of Kconfig.defined_syms/choices that only include symbols and choices defined in multiple locations once, while still preserving definition order. This is almost always what you want when iterating through (just) symbols and choices. It removes set() hackery (where it's easy to accidentally mess up the order) and the like. Fixes: - Commit 4ebc2aa ("Flag extra tokens after 'if'/'depends on'/'visible if' expressions") tightens up syntax checking so that extra trailing tokens after 'if', 'depends on', and 'visible if' expressions raise a syntax error, instead of being silently ignored. Oversight.
2018-08-21Make 10.0.1 releasev10.0.1Ulf Magnusson
Adds commit 7f3844f ("Make symbol order match between headers and .config files"), which fixes a bug introduced by commit 71872a8 ("Massively speed up U-Boot parsing"). The ordering of symbols in header files now matches the order in .config files again, which was always the intent. It makes things more readable, and is nice for version control too.
2018-08-18List new Kconfig.__init__() $srctree behavior among changes in READMEUlf Magnusson
2018-08-18Make 10.0.0 releasev10.0.0Ulf Magnusson
Adds commit 8a3999b ("Fix $srctree logic for the top-level Kconfig file"), which fixes an old braino: The top-level Kconfig file passed to Kconfig.__init__() wasn't looked up relative to $srctree, breaking out-of-tree operation for scripts unless ugly manual $srctree hacks were added. All Kconfig files are now consistently looked up relative to $srctree. This is a backwards-incompatible change (though with a simple fix), so the major version is bumped. A note is printed on errors that might be due to the changed behavior.
2018-08-18Make 9.4.2 releasev9.4.2Ulf Magnusson
This just reverts commit 8a3999f ("Fix $srctree logic for the top-level Kconfig file"), so that it can go in a major release instead. I realized it has enough breakage potential for existing scripts to warrant a major version bump.
2018-08-17Make 9.4.1 releasev9.4.1Ulf Magnusson
- Commit 8a3999b ("Fix $srctree logic for the top-level Kconfig file") fixes a major braino where the top-level Kconfig file passed to Kconfig.__init__() wasn't looked up relative to $srctree, breaking out-of-tree operation for e.g. menuconfig. All Kconfig files are now consistently looked up relative to $srctree. - Misc. internal code cleanup
2018-08-11Make 9.4.0 releasev9.4.0Ulf Magnusson
Kconfiglib changes: - Commit 1f864b1 ("Support custom printing of symbols/choices in expressions") adds support for printing symbols and choices with a custom format in expressions. This makes it simpler to implement things like like turning all symbols/choices into links when generating documentation, and printing symbol values after symbols. - Commit 6aea8d0 ("Don't pass encoding= to Popen()") fixes an accidental Python 3.6+ requirement when using the $(shell) preprocessor function with Python 3. menuconfig changes: - Commit 8efc358 ("menuconfig: Omit tristate value hint for int/string/hex defaults") removes the boolean value hints to the right of defaults in the symbol information for string/int/hex symbols. Stuff like '- 74 (value: "n")' isn't helpful, and looks confusing. - Commit 3511f24 ("menuconfig: Make symbol information less spammy") makes the symbol information more compact in general, e.g. by skipping value hints where they aren't helpful ('FOO(=y)' instead of 'FOO(=y) (=y)'), and by shortening stuff like '(value: "y")' to just '(=y)'.
2018-07-27Make 9.3.0 releasev9.3.0Ulf Magnusson
- b650ccd ("Use universal newlines mode in $(shell) implementation") improves the behavior of $(shell) on Windows. A trailing \r\n-style newline sequence is now stripped in full, instead of leaving \r in there. - 6899f91 ("Restore compatibility with old kernels") restores some compatibility with old kernels originally dropped by c19fc11 ("Drop some compatibility and tighten up lexing"). It turns out that people are still running Kconfiglib on kernels from at least 2013 (see https://github.com/ulfalizer/Kconfiglib/pull/48).
2018-07-20Make 9.2.1 releasev9.2.1Ulf Magnusson
Just adds commit 5452ad3 ("Fix detection of hex literals"). Braino. Include some int and hex literals in the Kstrict testcase too.
2018-07-20Make 9.2.0 releasev9.2.0Ulf Magnusson
Adds support for automatically warning for references to undefined Kconfig symbols. See commit ca89d02 ("Add KCONFIG_STRICT flag for flagging refs. to undefined syms"). (There was an outdated docstring in that comment. KCONFIG_STRICT needs to be set to "y".)
2018-07-20Mention KCONFIG_STRICT in the READMEUlf Magnusson
Also fix up Kconfig.__init__() docstring to say that KCONFIG_STRICT needs to be "y".
2018-07-20Add KCONFIG_STRICT flag for flagging refs. to undefined symsUlf Magnusson
Settings KCONFIG_STRICT to y in the environment turns on warnings for all references to undefined symbols within Kconfig files (with the only gotcha that hex literals must be prefixed by 0x or 0X, to make it possible to distinguish them from undefined references). Always flagging undefined references gets awkward, as some projects (e.g. the Linux kernel) use multiple Kconfig trees with shared files, leading to some safe undefined references. It's helpful for other projects though. Having KCONFIG_STRICT as an environment variable is handy when multiple tools are involved. Piggyback a small README change re. warnings. Kconfiglib now has many more warnings than the C tools.
2018-07-18Make 9.1.0 releasev9.1.0Ulf Magnusson
Adds e08b695 ("Add def_int, def_hex, and def_string keywords"), getting rid of some Kconfig inconsistency.
2018-07-18Add def_int, def_hex, and def_string keywordsUlf Magnusson
Analogous to def_bool and def_tristate, setting the type and adding a default at the same time. This is a Kconfiglib extension. These keywords can be useful in projects that make use of symbols defined in multiple locations, and remove some Kconfig inconsistency.
2018-07-15Fix typo in READMEUlf Magnusson
2018-07-15Make 9.0.0 releasev9.0.0Ulf Magnusson
This release revamps the globbing design to make 'source' globbing, requiring at least at least one matching file. A new o(r)source statement can be used when it's okay for a pattern to not match any files. Relevant commit, with motivations: 7a428aa ("Switch to more sensible globbing statements (w/ backwards compatibility)"). Backwards compatibility is maintained by having g(r)source be an alias for o(r)source. A small API change was introduced too: Kconfig.srctree is now set to the empty string instead of None when $srctree is unset. This gives nice behavior for e.g. os.path.join().
2018-07-15Switch to more sensible globbing statements (w/ backwards compatibility)Ulf Magnusson
Instead of having 'source' and 'gsource', have 'source' always glob, but require the pattern to match at least one file, throwing KconfigError otherwise. Have separate 'osource' and 'orsource' statements (the o is for "optional") for cases where it's okay for the pattern to not match any files. This is analogous to 'include' and '-include' in Make. The biggest flaw with 'gsource' was that there was no way to do a globbing match while requiring something to match, possibly leading to subtle failures. Preserve backwards compatibility by having "gsource" and "grsource" be aliases for "osource" and "orsource", respectively. Also include some related changes: - Kconfig.srctree is now set to the empty string if $srctree is unset, rather than to None. This gives nice behavior with os.path.join() and os.path.relpath(), which treat the empty string as the current directory (without adding './', for os.path.join()). - When $srctree is set, Kconfig files in the current directory will no longer override Kconfig files in $srctree when the relative paths match. This was likely a bug all along in the C tools, and probably only makes sense for .config files. I've seen it cause breakage in Zephyr. - Clarify the behavior of $srctree in the Kconfig.__init__() docstring. - Make MenuNode.filename be relative to $srctree for the Kconfig file passed to Kconfig.__init__(). This makes it consistent. The major version will be bumped later due to the small Kconfig.srctree API change.
generated by cgit v1.2.3 (git 2.46.0) at 2026-05-15 20:47:06 +0000