1======= 2abilint 3======= 4 5abilint parses the native XML representation of an ABI as emitted by 6:doc:`abidw`. Once it has parsed the XML representation of the ABI, 7``abilint`` builds and in-memory model from it. It then tries to save 8it back to an XML form, to standard output. If that read-write 9operation succeeds chances are the input XML ABI representation is 10meaningful. 11 12Note that the main intent of this tool to help debugging issues in the 13underlying Libabigail library. 14 15Note also that ``abilint`` can also read an `ELF`_ input file, build the 16in-memory model for its ABI, and serialize that model back into XML to 17standard output. In that case, the `ELF`_ input file must be 18accompanied with its debug information in the `DWARF`_ format. 19 20Invocation 21========== 22 23:: 24 25 abilint [options] [<abi-file1>] 26 27Options 28======= 29 30 * ``--help`` 31 32 Display a short help message and exits. 33 34 * `--version | -v` 35 36 Display the version of the program and exit. 37 38 * ``--debug-info-dir`` <*path*> 39 40 When reading an `ELF`_ input file which debug information is split 41 out into a separate file, this options tells ``abilint`` where to 42 find that separate debug information file. 43 44 Note that *path* must point to the root directory under which the 45 debug information is arranged in a tree-like manner. Under Red 46 Hat based systems, that directory is usually 47 ``<root>/usr/lib/debug``. 48 49 Note also that this option is not mandatory for split debug 50 information installed by your system's package manager because 51 then ``abidiff`` knows where to find it. 52 53 * ``--diff`` 54 55 For XML inputs, perform a text diff between the input and the 56 memory model saved back to disk. This can help to spot issues in 57 the handling of the XML format by the underlying Libabigail library. 58 59 * ``--noout`` 60 61 Do not display anything on standard output. The return code of 62 the command is the only way to know if the command succeeded. 63 64 * ``--suppressions | suppr`` <*path-to-suppression-specifications-file*> 65 66 Use a :ref:`suppression specification <suppr_spec_label>` file 67 located at *path-to-suppression-specifications-file*. Note that 68 this option can appear multiple times on the command line. In 69 that case, all of the provided suppression specification files are 70 taken into account. ABI artifacts matched by the suppression 71 specifications are suppressed from the output of this tool. 72 73 * ``--headers-dir | --hd`` <headers-directory-path-1> 74 75 Specifies where to find the public headers of the first shared 76 library that the tool has to consider. The tool will thus filter 77 out types that are not defined in public headers. 78 79 * ``--header-file | --hf`` <header-file-path> 80 81 Specifies where to find one of the public headers of the abi file 82 that the tool has to consider. The tool will thus filter out 83 types that are not defined in public headers. 84 85 * ``--stdin | --`` 86 87 Read the input content from standard input. 88 89 * ``--tu`` 90 91 Expect the input XML to represent a single translation unit. 92 93 * ``--ctf`` 94 95 Extract ABI information from CTF debug information, if present in 96 the given object. 97 98.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format 99.. _DWARF: http://www.dwarfstd.org 100