fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-21 02:40:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some minimal documentation about static linking

Browse source 
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>
This commit is contained in:
Peter Hutterer 2014-08-19 10:31:12 +10:00
parent 31113e6038
commit 0ceee5ec65
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
libevdev/libevdev.h
View file

@ -540,6 +540,20 @@ extern "C" {
* @include linux/input.h
*/
/**
* @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
*