From 0b1622b8d55793de07790b3ec7f763099befc79a Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Sun, 16 Dec 2012 07:36:11 +0100 Subject: Clarify README. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dbc6996..42e9569 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,15 @@ The test suite is run with > $ python Kconfiglib/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 scripts/kconfig/conf for a number of cases. You might want -to use the "speedy" option; see testsuite.py. +It comprises a set of selftests and a set of compatibility tests that compare +configurations generated by Kconfiglib with configurations generated by +scripts/kconfig/conf 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 unlikely to be exactly what you want as a user (hence why they're internal :). +Patches are welcome too of course. ;) Note: To make the API more consistent and intuitive, some methods have been renamed as follows: @@ -51,8 +52,8 @@ renamed as follows: -The test suite failures for the following Blackfin defconfigs on e.g. -Linux 3.7.0-rc8 are due to +The test suite failures (should be the only ones) for the following Blackfin +defconfigs on e.g. Linux 3.7.0-rc8 are due to [a bug in the C implementation](https://lkml.org/lkml/2012/12/5/458): * arch/blackfin/configs/CM-BF537U\_defconfig -- cgit v1.2.3