From 28cc9a1e67b4eb06031db825b1ed8304d37aeeae Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Sat, 8 Dec 2012 23:38:44 +0100 Subject: Update README. --- README.md | 49 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index abccea6..4b5653d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,39 @@ Kconfiglib ========== -A parser for the Linux kernel's configuration language, Kconfig. Presents -configuration symbols as objects that can be queried and assigned values, -automatically invalidating and reevaluating dependent symbols as needed. -Supports reading and writing .config files. Highly compatible with the C -implementation. See kconfiglib.py for a longer introduction. - -I mainly wrote this for my master's thesis -(http://liu.diva-portal.org/smash/get/diva2:473038/FULLTEXT01), to -automatically generate a minimal kernel configuration for a given system. See -Chapter 4 - Boot time optimization through semi-automatic kernel minimization. - -Haven't worked on this in a long time. Not sure if it will work with recent -Kconfig versions. +A Python library for doing stuff with Kconfig-based configuration systems. Can +extract information, query and set symbol values, and read and write .config +files. Highly compatible with the C implementation (the scripts/kconfig/\*conf +utilities in the kernel, usually invoked via make targets such as 'menuconfig' +and 'defconfig'). + +See kconfiglib.py for a longer introduction. The (extensive) documentation is +generated with + + $ pydoc [-w] kconfiglib + +Installation instructions for the Linux kernel (in the kernel root): + + $ git clone git://github.com/ulfalizer/Kconfiglib.git + $ git am Kconfiglib/makefile.patch + +(Note: The directory name Kconfiglib/ is significant.) + +Please tell me if the patch does not apply. It should be trivial to apply +manually. + +The test suite is run with + + $ python Kconfiglib/kconfigtest.py + +You might want to use the "speedy" option. See kconfigtest.py. + +The test suite failures for the following Blackfin defconfigs on e.g. +Linux 3.7.0-rc8 are due to a bug in the C implementation (see +https://lkml.org/lkml/2012/12/5/458): + +arch/blackfin/configs/CM-BF537U\_defconfig +arch/blackfin/configs/BF548-EZKIT\_defconfig +arch/blackfin/configs/BF527-EZKIT\_defconfig +arch/blackfin/configs/BF527-EZKIT-V2\_defconfig +arch/blackfin/configs/TCM-BF537\_defconfig -- cgit v1.2.3