1ABILINT(1)                        Libabigail                        ABILINT(1)
2
3
4

NAME

6       abilint - validate an abigail ABI representation
7
8       abilint  parses  the  native XML representation of an ABI as emitted by
9       abidw.  Once it has parsed the XML representation of the  ABI,  abilint
10       builds  and  in-memory model from it.  It then tries to save it back to
11       an XML form, to standard output.  If that read-write operation succeeds
12       chances are the input XML ABI representation is meaningful.
13
14       Note  that the main intent of this tool to help debugging issues in the
15       underlying Libabigail library.
16
17       Note also that abilint can also read  an  ELF  input  file,  build  the
18       in-memory  model for its ABI, and serialize that model back into XML to
19       standard output.  In that case, the ELF input file must be  accompanied
20       with its debug information in the DWARF format.
21

INVOCATION

23          abilint [options] [<abi-file1>]
24

OPTIONS

26          • --help
27
28            Display a short help message and exits.
29
30          • –version | -v
31
32            Display the version of the program and exit.
33
34          • --debug-info-dir <path>
35
36            When  reading  an  ELF input file which debug information is split
37            out into a separate file, this options tells abilint where to find
38            that separate debug information file.
39
40            Note  that  path  must point to the root directory under which the
41            debug information is arranged in a tree-like  manner.   Under  Red
42            Hat based systems, that directory is usually <root>/usr/lib/debug.
43
44            Note also that this option is not mandatory for split debug infor‐
45            mation installed by your system’s  package  manager  because  then
46            abidiff knows where to find it.
47
48          • --diff
49
50            For XML inputs, perform a text diff between the input and the mem‐
51            ory model saved back to disk.  This can help to spot issues in the
52            handling of the XML format by the underlying Libabigail library.
53
54          • --noout
55
56            Do  not  display  anything on standard output.  The return code of
57            the command is the only way to know if the command succeeded.
58
59          • --suppressions | suppr <path-to-suppression-specifications-file>
60
61            Use a suppression specification file located  at  path-to-suppres‐
62            sion-specifications-file.  Note that this option can appear multi‐
63            ple times on the command line.  In that case, all of the  provided
64            suppression specification files are taken into account.  ABI arti‐
65            facts matched by the  suppression  specifications  are  suppressed
66            from the output of this tool.
67
68          • --headers-dir | --hd <headers-directory-path-1>
69
70            Specifies where to find the public headers of the first shared li‐
71            brary that the tool has to consider.  The tool  will  thus  filter
72            out types that are not defined in public headers.
73
74          • --header-file | --hf <header-file-path>
75
76            Specifies  where to find one of the public headers of the abi file
77            that the tool has to consider.  The  tool  will  thus  filter  out
78            types that are not defined in public headers.
79
80          • --stdin | --
81
82            Read the input content from standard input.
83
84          • --tu
85
86            Expect the input XML to represent a single translation unit.
87
88          • --ctf
89
90            Extract  ABI information from CTF debug information, if present in
91            the given object.
92

AUTHOR

94       Dodji Seketeli
95

97       2014-2022, Red Hat, Inc.
98
99
100
101
102                                 Dec 02, 2022                       ABILINT(1)
Impressum