mirror of
git://sourceware.org/git/libabigail.git
synced 2025-03-07 07:07:36 +00:00
Add a manual for abipkgidiff
* doc/manuals/abipkgdiff.rst: New manual file. * doc/manuals/libabigail-tools.rst: Refer to the manual for abipkgdiff. * doc/manuals/Makefile.am: Add the new manual file to source distribution. * doc/manuals/conf.py: Add the manual for abipkgdiff to section 1. Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
parent
21bf2a87d8
commit
dea76e9f5f
@ -2,6 +2,7 @@
|
||||
|
||||
EXTRA_DIST = \
|
||||
abidiff.rst \
|
||||
abipkgdiff.rst \
|
||||
abicompat.rst \
|
||||
abidw.rst \
|
||||
abilint.rst \
|
||||
|
61
doc/manuals/abipkgdiff.rst
Normal file
61
doc/manuals/abipkgdiff.rst
Normal file
@ -0,0 +1,61 @@
|
||||
.. _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.
|
||||
|
||||
* --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.
|
@ -215,6 +215,7 @@ latex_documents = [
|
||||
man_pages = [
|
||||
('index', 'libabigail', u'Library to analyze and compare ELF ABIs', [u'Dodji Seketeli'], 7),
|
||||
('abidiff', 'abidiff', u'compare ABIs of ELF files ', [u'Dodji Seketeli'], 1),
|
||||
('abipkgdiff', 'abipkgdiff', u'compare ABIs of ELF files in software packages ', [u'Dodji Seketeli'], 1),
|
||||
('abidw', 'abidw', u'serialize the ABI of an ELF file', [u'Dodji Seketeli'], 1),
|
||||
('abilint', 'abilint', u'validate an abigail ABI representation', [u'Dodji Seketeli'], 1),
|
||||
('abicompat', 'abicompat', u'check ABI compatibility', [u'Dodji Seketeli'], 1),
|
||||
|
@ -16,6 +16,7 @@ Tools manuals
|
||||
:maxdepth: 2
|
||||
|
||||
abidiff
|
||||
abipkgdiff
|
||||
abicompat
|
||||
abidw
|
||||
abilint
|
||||
|
Loading…
Reference in New Issue
Block a user