.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "dpkg-build-api 7"
.TH dpkg-build-api 7 2024-03-10 1.22.6 "dpkg suite"
.\" 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
dpkg\-build\-api \- source package dpkg build API level
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& Build\-Depends:
\&  dpkg\-build\-api (= 1),
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The source package dpkg build API level, defines a versioned interface for
source packages, where each API level provides specific behaviors and
guarantees.
.PP
These interfaces can then be adopted by packages in a gradual way,
and phased out more easily than with global behavior changes.
.PP
The declaration of this API level is done through build-dependencies, in
one of \fBBuild-Depends\fR, \fBBuild-Depends-Indep\fR or \fBBuild-Depends-Arch\fR,
or via the environment variable \fBDPKG_BUILD_API\fR, which will override these
if both are present, and might emit a warning in case they are different.
.SH "API LEVELS"
.IX Header "API LEVELS"
.IP v2 4
.IX Item "v2"
This level is still under development, and cannot be declared via
build-dependencies.
.IP v1 4
.IX Item "v1"
This is the recommended level.
Since dpkg 1.22.0.
.Sp
Changes from v0 are:
.RS 4
.IP \(bu 4
\&\fBdpkg-shlibdeps\fR no longer uses the \fBLD_LIBRARY_PATH\fR environment variable.
The \fB\-l\fR option should be used instead.
.IP \(bu 4
\&\fBdpkg-buildpackage\fR defaults to \fBRules-Requires-Root\fR value \fBno\fR.
To restore the \fBv0\fR behavior \fBRules-Requires-Root\fR should be set to
\&\fBbinary-targets\fR.
.IP \(bu 4
\&\fBdpkg-buildpackage\fR expects all required \fIdebian/rules\fR targets to be
supported and no longer has backwards compatibility fallback code.
The required targets are \fBclean\fR, \fBbuild\fR, \fBbuild-indep\fR, \fBbuild-arch\fR,
\&\fBbinary-indep\fR and \fBbinary-arch\fR.
.IP \(bu 4
\&\fBvendor.mk\fR defaults to using \fBdpkg_vendor_derives_from_v1\fR for the
\&\fBdpkg_vendor_derives_from\fR macro.
To restore the \fBv0\fR behavior set \fBdpkg_vendor_derives_from\fR to
\&\fBdpkg_vendor_derives_from_v0\fR.
.IP \(bu 4
\&\fBdefault.mk\fR defaults to including \fBbuildtools.mk\fR.
.RE
.RS 4
.RE
.IP v0 4
.IX Item "v0"
This is the current global level, equivalent to not specifying one.
The interfaces and behaviors provided are subject to the normal global
interface updates, which tend to require longer deprecation cycles and/or
coordinated transitions.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdeb\-src\-control\fR\|(5).