git » nmdb » commit f54d724

Add an UPGRADING doc to note backwards-incompatible changes.

author Alberto Bertogli
2007-06-29 05:33:07 UTC
committer Alberto Bertogli
2007-06-29 05:33:07 UTC
parent ef5ab8d7f14cf8b9c4074ddba1a327122f68e64e
Add an UPGRADING doc to note backwards-incompatible changes.

Let's hope this doesn't grow too big.

Signed-off-by: Alberto Bertogli <albertito@gmail.com>
UPGRADING +13 -0 
diff --git a/UPGRADING b/UPGRADING
new file mode 100644
index 0000000..bd4c765
--- /dev/null
+++ b/UPGRADING
@@ -0,0 +1,13 @@
+
+Here are the notes for upgrading nmdb from one version to another.
+
+While normally nothing should be done, sometimes things change in incompatible
+ways. Here's the listing for the releases, you should always check it before
+upgrading.
+
+0.20 -> 0.21
+ * nmdb_get() and nmdb_cache_get() now return -1 instead of 0 when there is a
+   missing key. This was done to allow setting a value to be "" (no data). All
+   bindings have been upgraded, so you only need to worry if you used the C
+   library.
+