Blob Blame History Raw
.\" Automatically generated by Pod::Man 4.12 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CHECK-ABI 1"
.TH CHECK-ABI 1 "2020-01-31" "annobin-1" "RPM Development Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
check\-abi \- ABI Checking
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
check-abi
  [\fB\-\-help\fR]
  [\fB\-\-version\fR]
  [\fB\-\-verbose\fR]
  [\fB\-\-quiet\fR]
  [\fB\-\-silent\fR]
  [\fB\-\-inconsistencies\fR]
  [\fB\-\-ignore\-unknown\fR]
  [\fB\-\-ignore\-\fR\fIABI|enum|FORTIFY|stack\-prot\fR]
  [\fB\-\-readelf=\fR\fIpath\fR]
  [\fB\-\-tmpdir=\fR\fIdir\fR]
  [\fB\-\-\fR]
  \fIfile\fR...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fIcheck-abi\fR script reports any potential \s-1ABI\s0 conflicts in
the files specified.  This includes the use of the
\&\fB\-fshort\-enums\fR option, the \fB\-fstack\-protector\fR option
and the \fB\-D_FORTIFY_SOURCE\fR option.  All of these can affect
passing data between functions and hence should be used uniformly
throughout the binary.
.PP
The script accepts the following command line options:
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
.PD 0
.IP "\fB\-h\fR" 4
.IX Item "-h"
.PD
Displays the usage of the script and then exits.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD 0
.IP "\fB\-v\fR" 4
.IX Item "-v"
.PD
Displays the version of the script.
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
.PD 0
.IP "\fB\-V\fR" 4
.IX Item "-V"
.PD
Enables verbose mode, causing the script to detail each action it
takes.
.IP "\fB\-\-quiet\fR" 4
.IX Item "--quiet"
.PD 0
.IP "\fB\-q\fR" 4
.IX Item "-q"
.PD
Do not include the name of script in the out generated by the script.
.IP "\fB\-\-silent\fR" 4
.IX Item "--silent"
.PD 0
.IP "\fB\-s\fR" 4
.IX Item "-s"
.PD
Produce no output.  Just return an exit status.
.IP "\fB\-\-inconsitencies\fR" 4
.IX Item "--inconsitencies"
.PD 0
.IP "\fB\-i\fR" 4
.IX Item "-i"
.PD
Only report files with potential \s-1ABI\s0 problems.
.IP "\fB\-\-ignore\-unknown\fR" 4
.IX Item "--ignore-unknown"
Do not report file types that are not supported or recognised.
.IP "\fB\-\-ignore\-\fR\fIABI|enum|FORTIFY|stack\-prot\fR" 4
.IX Item "--ignore-ABI|enum|FORTIFY|stack-prot"
Disables individual \s-1ABI\s0 checks.  Multiple occurences of this option
accumulate.  Possible option values are:
.RS 4
.IP "\fB\s-1ABI\s0\fR" 4
.IX Item "ABI"
Disable checks of the general \s-1ABI\s0 information.
.IP "\fBenum\fR" 4
.IX Item "enum"
Disable checks of the \fB\-fshort\-enum\fR option.
.IP "\fB\s-1FORTIFY\s0\fR" 4
.IX Item "FORTIFY"
Disable checks of the \fB\-D_FORTIFY_SOURCE\fR option.
.IP "\fBstack-prot\fR" 4
.IX Item "stack-prot"
Disable checks of the \fB\-fstack\-protect\fR option.
.RE
.RS 4
.RE
.IP "\fB\-\-tmpdir=\f(BIdir\fB\fR" 4
.IX Item "--tmpdir=dir"
.PD 0
.IP "\fB\-t=\f(BIdir\fB\fR" 4
.IX Item "-t=dir"
.PD
Directory to use to store temporary files.
.IP "\fB\-\-readelf=\f(BIpath\fB\fR" 4
.IX Item "--readelf=path"
.PD 0
.IP "\fB\-r=\f(BIpath\fB\fR" 4
.IX Item "-r=path"
.PD
Use the specified program to read the notes from the files.
.IP "\fB\-\-\fR" 4
.IX Item "--"
Stop accumulating command line options.  This allows the script to be
run on files whose names starts with a dash.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2018 \- 2020 Red Hat.
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the \s-1GNU\s0 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 \*(L"\s-1GNU\s0 Free Documentation License\*(R".