check-symbols(1) [debian man page]

CHECK-SYMBOLS(1)					      General Commands Manual						  CHECK-SYMBOLS(1)

NAME

       check-symbols - verify symbols exported by a new library version

SYNOPSIS

       check-symbols <source-package> [DEBDIR]

DESCRIPTION

       To  verify the symbols exported by a new library version, run check-symbols with the name of the source package as argument.  check-symbols
       will first determine the symbols exported by the existing and installed library version, then install the new library and compare the  sym-
       bols  exported  by the new library version with the symbols exported by the old version.  For each of the symbols found, check-symbols will
       list if the symbol is new, unchanged or has been removed in the new library version.

       In case the source package contains multiple binary library packages, all library files in each of the binary packages will be verified.

       check-symbols uses nm -D to determine the exported symbols of the libraries.

       If no value is given for DEBDIR, the script will assume the new library deb files are stored in /var/cache/pbuilder/result.

EXAMPLES

       check-symbols telepathy-glib .

       This will:

	 o Use nm -D to determine the exported symbols of the old,
	   installed versions of the libraries provided by telepathy-glib.

	 o Install the binary libraries provided by the new version of
	   telepathy-glib.

	 o Compare the output of nm -D of the new libraries with the
	   output of the old version.

	 o List the result in diff format.

BUGS

       Please report bugs on:
       https://bugs.launchpad.net/ubuntu/+source/ubuntu-dev-tools/

SEE ALSO

       nm(1)

AUTHOR

       check-symbols was written by Daniel Holbach <daniel.holbach@ubuntu.com> and this manpage by Albert Damen <albrt@gmx.net>. Both are licensed
       under the GNU General Public License, version 2.

ubuntu-dev-tools						 December 9, 2007						  CHECK-SYMBOLS(1)

deb-symbols(5)							    dpkg suite							    deb-symbols(5)

NAME

       deb-symbols - Debian's extended shared library information file

SYNOPSIS

       symbols

DESCRIPTION

       The  symbol files are shipped in Debian binary packages, and its format is a subset of the template symbol files used by dpkg-gensymbols(1)
       in Debian source packages.

       The format for an extended shared library dependency information entry in these files is:

       library-soname main-dependency-template
       [| alternative-dependency-template]
       [...]
       [* field-name: field-value]
       [...]
	symbol minimal-version [id-of-dependency-template]

       The library-soname is exactly the value of the SONAME field as exported by objdump(1). A dependency-template is a dependency where #MINVER#
       is  dynamically	replaced  either  by  a  version  check  like "(>= minimal-version)" or by nothing (if an unversioned dependency is deemed
       sufficient).

       Each exported symbol (listed as name@version, with version being "Base" if the library is not versioned) is associated to a minimal-version
       of  its	dependency  template  (the  main  dependency  template	is always used and will end up being combined with the dependency template
       referenced by id-of-dependency-template if present). The first alternative dependency template is numbered 1, the second one 2, etc.

       Each entry for a library can also have some fields of meta-information.	Those fields are  stored  on  lines  starting  with  an  asterisk.
       Currently, the only valid fields are:

       Build-Depends-Package
	      It indicates the name of the "-dev" package associated to the library and is used by dpkg-shlibdeps to make sure that the dependency
	      generated is at least as strict as the corresponding build dependency (since dpkg 1.14.13).

       Ignore-Blacklist-Groups
	      It indicates what blacklist groups should be ignored, as a whitespace separated list, so that the symbols contained in those  groups
	      get  included  in  the  output  file  (since  dpkg  1.17.6).   This  should only be necessary for toolchain packages providing those
	      blacklisted symbols. The available groups are system dependent, for ELF and GNU-based systems these are aeabi and gomp.

EXAMPLES

   Simple symbols file
       libftp.so.3 libftp3 #MINVER#
	DefaultNetbuf@Base 3.1-1-6
	FtpAccess@Base 3.1-1-6
	[...]

   Advanced symbols file
       libGL.so.1 libgl1
       | libgl1-mesa-glx #MINVER#
       * Build-Depends-Package: libgl1-mesa-dev
	publicGlSymbol@Base 6.3-1
	[...]
	implementationSpecificSymbol@Base 6.5.2-7 1
	[...]

SEE ALSO

       https://wiki.debian.org/Projects/ImprovedDpkgShlibdeps
       dpkg-shlibdeps(1), dpkg-gensymbols(1).

1.19.0.5							    2018-04-16							    deb-symbols(5)