libabigail/doc/manuals/abipkgdiff.rst
Dodji Seketeli 71a5e0762e Support comparing only shared libraries
It turned out on some packages we are interested on comparing shared
libraries only.  This patch adds that functionality by adding a new
--dso-only command line option to abipkgdiff.

	* tools/abipkgdiff.cc (options::compare_dso_only): New data
	member.
	(options::options): Initialize it.
	(display_usage): Display a little help string for it.
	(create_maps_of_package_content): Take the option variable.  Do
	not compare non-dso files if the --dso-only option was provided.
	(extract_package_and_map_its_content, prepare_packages, compare):
	Take the option variable.
	(parse_command_line): Parse the new --dso-only option.
	* doc/manuals/abipkgdiff.rst: Add documentation for the new
	--dso-only option.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
2015-07-17 10:11:15 +02:00

67 lines
1.6 KiB
ReStructuredText

.. _abipkgdiff_label:
===========
abipkgdiff
===========
``abipkgdiff`` compares the Application Binary Interfaces (ABI) of the
`ELF`_ binaries contained in two software packages. The format of
software package that is currently supported is `RPM`_.
For a comprehensive ABI change report that includes changes about
function and variable sub-types, the two input packages must be
accompanied with their debug information packages that contain debug
information in `DWARF`_ format.
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _RPM: https://en.wikipedia.org/wiki/RPM_Package_Manager
.. _DWARF: http://www.dwarfstd.org
.. _abipkgdiff_invocation_label:
Invocation
=========
::
abipkgdiff [option] <package1> <package2>
.. _abipkgdiff_options_label:
Options
=======
* --help
Display a short help about the command and exit.
* --debug-info-pkg1|--d1 <path>
For cases where the debug information for *package1* is split out
into a separate file, tells ``abipkgdiff`` where to find that
separate debug information package.
* --debug-info-pkg2|--d2 <path>
For cases where the debug information for *package2* is split out
into a separate file, tells ``abipkgdiff`` where to find that
separate debug information package.
* --dso-only
Compare ELF files that are shared libraries, only. Do not compare
executable files, for instance.
* --verbose
Emit verbose progress messages.
.. _abipkgdiff_return_value_label:
Return value
============
The exit code of the ``abipkgdiff`` command is either 0 if the ABI of
the binaries compared are equal, or 1 if they differ.