.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "apkbuild-lint" "1" "2024-10-14"
.PP
.SH NAME
.PP
apkbuild-lint - A linter for Alpine Linux'\&s build files (apkbuild)
.PP
.SH SYNOPSIS
.PP
\fBapkbuild-lint\fR <apkbuild.\&.\&.\&>
.PP
.SH DESCRIPTION
.PP
apkbuild-lint is a linter for packages in aports.\& It will check the \fBAPKBUILD\fR
file for violations of policy, superfluous statements, stylistic violations
and others.\& See \fBalint(5)\fR under the apkbuild-lint section for an explanation
of each violation that apkbuild-lint checks for.\&
.PP
apkbuild-lint will print the policy violations found and exit 1, if no violations
are found then nothing will be printed and it will exit 0.\&
.PP
.SH ENVIRONMENT
.PP
The \fBCUSTOM_VALID_OPTIONS\fR variable can be set to a whitespace-separated list of
variables that will be considered valid inside the options= variable of an APKBUILD
.PP
.SH OUTPUT
.PP
apkbuild-lint will print to stdout whenever a policy violation is found in the
following format
.PP
.RS 4
SEVERITYCERTAINITY:[TAG]:PATH::MSG
.PP
.RE
.PD 0
.IP \(bu 4
\fBSEVERITY\fR refers to how severe a violation is, ranging from \fBS\fR to \fBM\fR.\&
.IP \(bu 4
\fBCERTAINITY\fR refers to how likely it is not a false positive, ranging from \fBC\fR to \fBP\fR
.IP \(bu 4
\fBTAG\fR refers to the tag of the violation, see \fBalint(5)\fR for more details.\&
.IP \(bu 4
\fBPATH\fR refers to the path given for \fBapkbuild-lint\fR to check.\&
.IP \(bu 4
\fBLINE\fR refers to the number of the line where the violation was found.\&
.IP \(bu 4
\fBMSG\fR is a short message meant for humans to know what is the violation.\&
.PD
.PP
.SH AUTHORS
.PP
Maintained by Leo <thinkabit.\&ukim@gmail.\&com>
.PP
.SH SEE ALSO
.PP
\fBalint(5)\fR \fBaports-lint(1)\fR