[PATCH libevdev 5/5] Add some minimal documentation about static linking

[Peter Hutterer]

I can't recommend it, but I can't stop people from doing it, so at least
document the ground rules.

Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
 libevdev/libevdev.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h
index 321f980..5797190 100644
--- a/libevdev/libevdev.h
+++ b/libevdev/libevdev.h
@@ -541,6 +541,20 @@ extern "C" {
  */
 
 /**
+ * @page static_linking Statically linking libevdev
+ *
+ * Statically linking libevdev.a is generally supported but not
+ * recommended. Symbol visibility is difficult to control in a static
+ * library, so extra care must be taken to only use symbols that are
+ * explicitly exported. libevdev's API stability guarantee only applies to
+ * those symbols.
+ *
+ * In addition to the exported symbols, libevdev reserves the
+ * <b>_libevdev_*</b> namespace. Do not use or create symbols with that
+ * prefix, they are subject to change at any time.
+ */
+
+/**
  * @page testing libevdev-internal test suite
  *
  * libevdev's internal test suite uses the
-- 
1.9.3