diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2014-08-19 10:31:12 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2014-08-25 10:12:37 +1000 |
commit | 0ceee5ec652ce4e45d74281b1a869687e6c088b9 (patch) | |
tree | 4b4ecfdce70c3e188c685f8be852136094673f2a | |
parent | 31113e6038a6ba4d8504f6329fb99b9adc4d58c2 (diff) | |
download | libevdev-0ceee5ec652ce4e45d74281b1a869687e6c088b9.tar.gz |
Add some minimal documentation about static linking
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@who-t.net>
-rw-r--r-- | libevdev/libevdev.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h index 321f980..afc1d13 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 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. + * + * If you do link libevdev statically, note that 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 |