libabigail/doc/manuals/abipkgdiff.rst

.. _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.