RepoMirrors/libabigail
1
0
Fork 0
mirror of git://sourceware.org/git/libabigail.git synced 2025-03-25 04:38:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

More docs about ABIDIFF_ABI_INCOMPATIBLE_CHANGE

Browse Source 
In the manual of abidiff, explain the kind of changes that flip the
ABIDIFF_ABI_INCOMPATIBLE_CHANGE flag.

	* doc/manuals/abidiff.rst: Explain the kind of changes that flip
	the ABIDIFF_ABI_INCOMPATIBLE_CHANGE flag.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
Dodji Seketeli 2016-03-16 20:39:39 +01:00
parent 7bd768af64
commit ec99d6eb1d
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/manuals/abidiff.rst
View File

@ -263,6 +263,20 @@ ABIs being compared might or might not be compatible. In that case, a
human being needs to review the ABI changes to decide if they are
compatible or not.
Note that, at the moment, there are only a few kinds of ABI changes
that would result in setting the flag ``ABIDIFF_ABI_INCOMPATIBLE_CHANGE``.
Those ABI chanages are either:
- the removal of the symbol of a function or variable that has been
defined and exported.
- the modification of the index of a member of a virtual function
table (for C++ programs and libraries).
With time, when more ABI change patterns are found to *always*
constitute incompatible ABI changes, we will adapt the code to
recognize those cases and set the ``ABIDIFF_ABI_INCOMPATIBLE_CHANGE``
accordingly. So, if you find such patterns, please let us know.
The remaining bits are not used for the moment.
.. _abidiff_usage_example_label: