How to use symbols files

This page is meant to collect some generic recommendations for handling symbols files. It's related to the improved dpkg-shlibdeps project.

Maintainers should not drop symbols file directly into debian without understanding the mechanisms behind. Please read this page carefully (and the manual pages of dpkg-shlibdeps / dpkg-gensymbols) to have a good grasp on the various issues that need to be taken into account.

Check the content of symbols files

Pre-generated files on mole associate to each symbol the first version of the package where the symbol has appeared. However symbols files are supposed to contain the minimal version for the dependency that we want when we know that the application is using this symbol.

Check the list of symbols exported by the library

If you find (on some arches) symbols that are exported which are not supposed to be public, you must not use symbols versioning at all. You might want to update the libtool scripts of your package from the latest version in Debian to fix the problem. There are old libtool versions which are not doing their job properly on some arches.

If your library exports private symbols, you might want to discuss with upstream to implement a version script to fix this. For libtool using packages, it can be easily generated using libtool's -export-symbols and -export-symbols-regex options.

Be responsive to porters

In some cases, the usage of symbols file might create problems to unofficial architectures. Be kind to them and incorporate quickly their patches, or offer them to NMU your package if you're busy.

See also

Essays from Russ Allbery about symbols files in C++ libraries: