check-abi man page

check-abi
 [--help]
 [--version]
 [--verbose]
 [--quiet]
 [--silent]
 [--inconsistencies]
 [--ignore-unknown]
 [--ignore-ABI|enum|FORTIFY|stack-prot]
 [--readelf=path]
 [--tmpdir=dir]
 [--]
 file...

The check-abi script reports any potential ABI conflicts in the files specified.  This includes the use of the -fshort-enums option, the -fstack-protector option and the -D_FORTIFY_SOURCE option.  All of these can affect passing data between functions and hence should be used uniformly throughout the binary.

The script accepts the following command line options:

--help

-h

Displays the usage of the script and then exits.

--version

-v

Displays the version of the script.

--verbose

-V

Enables verbose mode, causing the script to detail each action it takes.

--quiet

-q

Do not include the name of script in the out generated by the script.

--silent

-s

Produce no output.  Just return an exit status.

--inconsitencies

-i

Only report files with potential ABI problems.

--ignore-unknown

Do not report file types that are not supported or recognised.

--ignore-ABI|enum|FORTIFY|stack-prot

Disables individual ABI checks.  Multiple occurences of this option accumulate.  Possible option values are:

ABI

Disable checks of the general ABI information.

enum

Disable checks of the -fshort-enum option.

FORTIFY

Disable checks of the -D_FORTIFY_SOURCE option.

stack-prot

Disable checks of the -fstack-protect option.

--tmpdir=dir

-t=dir

Directory to use to store temporary files.

--readelf=path

-r=path

Use the specified program to read the notes from the files.

--

Stop accumulating command line options.  This allows the script to be run on files whose names starts with a dash.

Copyright (c) 2018 Red Hat.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.  A copy of the license is included in the section entitled "GNU Free Documentation License".