Browse Source

docs: added new API compatibility section

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 8 years ago
parent
commit
c7bd37b322
2 changed files with 29 additions and 0 deletions
  1. 9
    0
      README.md
  2. 20
    0
      docs/apichanges.md

+ 9
- 0
README.md View File

@@ -114,6 +114,15 @@ API Documentation
114 114
 <a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a>
115 115
 <a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a>
116 116
 
117
+### API Compatibility
118
+Even if we try our best not to, every once in a while we are forced to modify
119
+our API in a way that will break backwards compatibility. If you find yourself
120
+unable to compile code that was working fine before a library update, make sure
121
+you check the [API changes](docs/apichanges.md) section first.
122
+
123
+**NOTE** - Our **C++ header files** will change their extension from *.h* to
124
+*.hpp* in the upcoming version.
125
+
117 126
 ### Changelog
118 127
 Version changelog [here](docs/changelog.md).
119 128
 

+ 20
- 0
docs/apichanges.md View File

@@ -0,0 +1,20 @@
1
+API Changes                       {#apichanges}
2
+===============
3
+
4
+**IMPORTANT NOTICE**
5
+
6
+Our **C++ header files** will change their extension from *.h* to *.hpp*. This
7
+change is anticipated in the upcoming version and unfortunately will break
8
+source compatibility with previous versions of UPM for every library. You will
9
+need to update your code and change to the new extension format in your
10
+`#include` directives.
11
+
12
+Here's a list of other API changes made to the library that break source/binary
13
+compatibility between releases:
14
+
15
+ * **my9221**, **groveledbar** and **grovecircularled** are now all part of the
16
+ same library (my9221) and new functionality was added going to v.0.5.1
17
+ * **stepmotor** driver API was changed significantly from v.0.4.1 to v.0.5.0
18
+ * **eboled** library was greatly improved in version 0.4.0 and the `draw()`
19
+ function was removed in favor of a more complete GFX library implementation
20
+