.\" -*- 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::BuildTypes 3perl"
.TH Dpkg::BuildTypes 3perl 2024-03-10 1.22.6 libdpkg-perl
.\" 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::BuildTypes \- track build types
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Dpkg::BuildTypes module is used by various tools to track and decide
what artifacts need to be built.
.PP
The build types are bit constants that are exported by default. Multiple
types can be ORed.
.PP
\&\fBNote\fR: This is a private module, its API can change at any time.
.SH CONSTANTS
.IX Header "CONSTANTS"
.IP BUILD_DEFAULT 4
.IX Item "BUILD_DEFAULT"
This build is the default.
.IP BUILD_SOURCE 4
.IX Item "BUILD_SOURCE"
This build includes source artifacts.
.IP BUILD_ARCH_DEP 4
.IX Item "BUILD_ARCH_DEP"
This build includes architecture dependent binary artifacts.
.IP BUILD_ARCH_INDEP 4
.IX Item "BUILD_ARCH_INDEP"
This build includes architecture independent binary artifacts.
.IP BUILD_BINARY 4
.IX Item "BUILD_BINARY"
This build includes binary artifacts.
.IP BUILD_FULL 4
.IX Item "BUILD_FULL"
This build includes source and binary artifacts.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP build_has_any($bits) 4
.IX Item "build_has_any($bits)"
Return a boolean indicating whether the current build type has any of the
specified \f(CW$bits\fR.
.IP build_has_all($bits) 4
.IX Item "build_has_all($bits)"
Return a boolean indicating whether the current build type has all the
specified \f(CW$bits\fR.
.IP build_has_none($bits) 4
.IX Item "build_has_none($bits)"
Return a boolean indicating whether the current build type has none of the
specified \f(CW$bits\fR.
.IP build_is($bits) 4
.IX Item "build_is($bits)"
Return a boolean indicating whether the current build type is the specified
set of \f(CW$bits\fR.
.ie n .IP "set_build_type($build_type, $build_option, %opts)" 4
.el .IP "set_build_type($build_type, \f(CW$build_option\fR, \f(CW%opts\fR)" 4
.IX Item "set_build_type($build_type, $build_option, %opts)"
Set the current build type to \f(CW$build_type\fR, which was specified via the
\&\f(CW$build_option\fR command-line option.
.Sp
The function will check and abort on incompatible build type assignments,
this behavior can be disabled by using the boolean option "nocheck".
.ie n .IP "set_build_type_from_options($build_types, $build_option, %opts)" 4
.el .IP "set_build_type_from_options($build_types, \f(CW$build_option\fR, \f(CW%opts\fR)" 4
.IX Item "set_build_type_from_options($build_types, $build_option, %opts)"
Set the current build type from a list of comma-separated build type
components.
.Sp
The function will check and abort on incompatible build type assignments,
this behavior can be disabled by using the boolean option "nocheck".
.ie n .IP "set_build_type_from_targets($build_targets, $build_option, %opts)" 4
.el .IP "set_build_type_from_targets($build_targets, \f(CW$build_option\fR, \f(CW%opts\fR)" 4
.IX Item "set_build_type_from_targets($build_targets, $build_option, %opts)"
Set the current build type from a list of comma-separated build target
components.
.Sp
The function will check and abort on incompatible build type assignments,
this behavior can be disabled by using the boolean option "nocheck".
.IP \fBget_build_options_from_type()\fR 4
.IX Item "get_build_options_from_type()"
Get the current build type as a set of comma-separated string options.
.SH CHANGES
.IX Header "CHANGES"
.SS "Version 0.xx"
.IX Subsection "Version 0.xx"
This is a private module.