diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 9 insertions, 6 deletions
@@ -2,10 +2,10 @@ Kconfiglib ========== 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'). +extract information, query and set symbol values, and read and write +<i>.config</i> files. Highly compatible with the <i>scripts/kconfig/\*conf</i> +utilities in the kernel, usually invoked via make targets such as +<i>menuconfig</i> and <i>defconfig</i>. See kconfiglib.py for a longer introduction. The (extensive) documentation is generated with @@ -17,7 +17,7 @@ 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.) +<i>(Note: The directory name Kconfiglib/ is significant.)</i> Please tell me if the patch does not apply. It should be trivial to apply manually. @@ -26,7 +26,10 @@ The test suite is run with > $ python Kconfiglib/testsuite.py -You might want to use the "speedy" option. See testsuite.py. +It includes a set of selftests as well as a set of automatic compatibility +tests that compare the configurations generated by Kconfiglib with those +generated by <i>scripts/kconfig/conf</i> for a number of cases. You might want +to use the "speedy" option; see testsuite.py. Please tell me if you miss some API instead of digging into internals. The internal data structures and APIs, and dependency stuff in particular, are |