Rename APIs to be more consistent and intuitive.

1 files changed, 9 insertions, 0 deletions

diff --git a/README.md b/README.md
index b589253..db8a7b2 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,15 @@ 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 :).
 
+Note: To make the API more consistent and intuitive, some methods have been
+renamed as follows:
+ * Symbol.calc\_value() -> Symbol.get\_value()
+ * Choice.calc\_mode() -> Choice.get\_mode()
+ * Symbol.set\_value() -> Symbol.set\_user\_value()
+ * Symbol.reset() -> Symbol.unset\_user\_value()
+ * Config.reset() -> Config.unset\_user\_values()
+
+
 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](https://lkml.org/lkml/2012/12/5/458):