Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
@@ -17,18 +17,16 @@
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
-.TH interface_cmp 1ONBLD "25 March 2010"
+.TH INTERFACE_CMP 1ONBLD "Mar 25, 2010"
.SH NAME
interface_cmp \- compare shared object interface descriptions
.SH SYNOPSIS
\fBinterface_cmp [-dot] [-e exfile] old new\fP
-.LP
.SH DESCRIPTION
-.IX "OS-Net build tools" "interface_cmp" "" "\fBinterface_cmp\fP"
The
.I interface_cmp
command compares the interface definition files for two workspaces
and reports versioning inconsistencies. Interface definition
files are created by
@@ -46,13 +44,11 @@
.PP
Note that version definition inheritance has the effect of causing a
symbol to be viewed as existing in multiple definitions. This insures
that both version definitions and their inheritance relationship are
processed as part of the comparison.
-.LP
.SH OPTIONS
-.LP
The following options are supported:
.TP 4
.B \-c vertype_module
By default,
.I interface_cmp
@@ -85,11 +81,10 @@
The new interface must not add new empty versions. Pre-existing empty
versions represent public interfaces that cannot be changed, but new
ones should be removed before the product ships.
.RE
.sp
-.LP
.TP 4
.B \-e exfile
An exception file is used to exclude objects from
the usual rules. See EXCEPTION FILE FORMAT.
.TP 4
@@ -107,11 +102,10 @@
and the output from
.I interface_cmp
\fB-t\fP
should be identical, excluding header comments.
This is a debugging feature, and not intended for general use.
-.LP
.SH EXCEPTION FILE FORMAT
Exceptions to the rules enforced by
.I interface_cmp
are specified using an exception file. The \fB-e\fP option is used to
specify an explicit exception file. Otherwise, if used in an activated
@@ -121,11 +115,11 @@
$CODEMGR_WS/exception_list/interface_cmp does not exist,
.I interface_cmp
will use
.I /opt/onbld/etc/exception_list/interface_cmp
as a fallback default exception file.
-.p
+.P
To run
.I interface_cmp
without applying exceptions, specify \fB-e\fP with a value of /dev/null.
.P
A '#' character at the beginning of a line, or at any point in
@@ -162,16 +156,14 @@
The exceptions understood by
.I interface_cmp
are:
.sp
.ne 2
-.mk
.na
\fBADDSYM\fR sym_re version_re object_re
.ad
.RS 17n
-.rt
.sp
The interfaces in a given version are not supposed to change.
.I interface_cmp
will normally issue an error if a new interface is added to a previously
released version. ADDSYM is used to override this
@@ -179,16 +171,14 @@
the regular expressions specified by ADDSYM, the added symbol is ignored.
.RE
.sp
.ne 2
-.mk
.na
\fBDELDYM\fR sym_re version_re object_re
.ad
.RS 17n
-.rt
.sp
Once released to the public, interfaces are required to remain available
in subsequent releases. DELSYM is used to override this
requirement, as can occur when interfaces are EOL'd. Such an action generally
requires a PSARC case. If the deleted symbol, version, and object match
@@ -195,16 +185,14 @@
the regular expressions specified by DELSYM, the deleted symbol is ignored.
.RE
.sp
.ne 2
-.mk
.na
\fBEMPTY_TOPVERSION\fR version_re object_re
.ad
.RS 17n
-.rt
.sp
.I
interface_cmp
normally issues an error if the old object has an empty top version
that is non-empty in the new object. Such a situation is normally
@@ -211,11 +199,10 @@
an error, but may legitimately occur as part of a fix to another versioning
error. If the version, and object match
the regular expressions specified by EMPTY_TOPVERSION, the error is suppressed.
.RE
-.PP
.SH EXAMPLES
The following example uses
.I interface_cmp
to compare this releases interface definition with a previous
builds results:
@@ -239,7 +226,5 @@
.BR interface_check(1ONBLD),
.BR ld(1),
.BR ldd(1),
.BR elfdump(1),
.BR pvs(1).
-.LP
-.TZ LLM