summaryrefslogtreecommitdiff
path: root/ReadMe.txt
diff options
context:
space:
mode:
authorMilan Crha <mcrha@redhat.com>2019-02-01 09:28:42 +0100
committerMilan Crha <mcrha@redhat.com>2019-02-01 09:28:42 +0100
commit4ee7848b4ac32658a18860d0ec6598de086da5f4 (patch)
treebcc82229f81461564f03b1c0eacb171fd75c54c4 /ReadMe.txt
parentfb907484c04643475b37f63a4b830ae91be8f91e (diff)
downloadlibical-git-4ee7848b4ac32658a18860d0ec6598de086da5f4.tar.gz
[libical-glib] Introduce LIBICAL_GLIB_UNSTABLE_API define
The users of libical-glib API should define LIBICAL_GLIB_UNSTABLE_API=1 to be able to use it. That's to indicate that the libical-glib API is currently considered unstable and can change any release.
Diffstat (limited to 'ReadMe.txt')
-rw-r--r--ReadMe.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/ReadMe.txt b/ReadMe.txt
index e425a5e5..f8afc3e3 100644
--- a/ReadMe.txt
+++ b/ReadMe.txt
@@ -24,6 +24,11 @@ plus the iCalendar iMIP protocol in [RFC6047][].
[RFC6047]: https://tools.ietf.org/html/rfc6047
[RFC7986]: https://tools.ietf.org/html/rfc7986
+The libical-glib API is currently unstable and can change with any release.
+Until it is considered stable, there should be defined LIBICAL_GLIB_UNSTABLE_API=1
+before including <libical-glib/libical-glib.h>, to indicate that the library user
+is aware of it and is prepared to change the calls anytime.
+
## License
The code and datafiles in this distribution are licensed under the