summaryrefslogtreecommitdiff
path: root/README.rst
AgeCommit message (Collapse)Author
2018-10-14Make 10.14.0 releasev10.14.0Ulf Magnusson
Adds two menuconfig improvements and a documentation improvement: - Commit 96682d7 ("menuconfig: Add jump-to for choices, menus, and comments") generalizes the jump-to feature so that choices, menus, and comments can be jumped to in addition to symbols (or into, in the case of choices and menus). - Commit fae2e70 ("menuconfig: Do not show range hint for symbols without ranges") despams the menuconfig interface and could potentially avoid some confusion. - Commit bde4cc7 ("Add some hints re. generating custom configuration output") adds some documentation hints re. using the Symbol.config_string field when generating custom output. It can be useful for pruning symbols even when the output format isn't .config-like.
2018-10-13Add some hints re. generating custom configuration outputUlf Magnusson
It's not obvious that Symbol.config_string can be useful even when generating other output formats, as it provides a hook for _write_to_conf. Mention it in the 'config_string' documentation and in relevant parts of the README.
2018-10-10Make 10.13.0 releasev10.13.0Ulf Magnusson
Adds commit a247f3f ("menuconfig: Improve/fix promptless choice handling"), which fixes an obscure menuconfig crash involving symbols in promptless choices, and improves how choices are displayed in show-all/show-name mode a bit ('<choice (name, if any)>' instead of either nothing or '<name>').
2018-10-06Make 10.12.0 releasev10.12.0Ulf Magnusson
Adds commit f1e4d04 ("menuconfig: Remove "Value for " prefix from input dialog titles"), which de-spams the menuconfig interface a bit. Some documentation fixes and improvements are included as well: - Commit 631c51f ("Point to IS_ENABLED() is README") - Commit f594975 ("Add hints on incremental building to 'getting started'") - Commit d044ee9 ("Clarify --config-out description a bit") - Commit 358b77a ("Hint that load_config() with replace=False is for merging") - Commit 5d15df9 ("Update genconfig usage description") The naming in some internal evaluation functions was cleaned up too.
2018-10-06Fix typo in READMEUlf Magnusson
2018-10-06Add hints on incremental building to 'getting started'Ulf Magnusson
2018-10-06Point to IS_ENABLED() is READMEUlf Magnusson
Might be tricky to discover.
2018-10-04Fix link to kconfig-language.txt in how-toUlf Magnusson
The link accidentally went to kconfig-macro-language.txt.
2018-10-03Clarify --config-out description a bitUlf Magnusson
2018-10-03README language nitUlf Magnusson
Remove some parentheses.
2018-10-03Make 10.11.0 releasev10.11.0Ulf Magnusson
Adds commit 4602028 ("genconfig: Allow writing a full .config without incremental build info"), which adds a flag to genconfig that might be handy in projects that include .config files in Makefiles but that don't use incremental build information.
2018-10-03genconfig: Allow writing a full .config without incremental build infoUlf Magnusson
For projects that don't use incremental build information, it's a bit wasteful to generate it just to get an updated .config file to include in Makefiles. Add a '--config-out <filename>' option that just writes the updated .config file, for those cases. Also remove a redundant default=None argument for --sync-deps. None is the default value.
2018-10-03Clarify '# CONFIG_FOO is not set' in how-toUlf Magnusson
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.