.\" Automatically generated by Pod::Man 4.10 (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 "DH_ELPA_TEST 1"
.TH DH_ELPA_TEST 1 "2019-01-25" "perl v5.28.1" "Debhelper"
.\" 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"
dh_elpa_test \- run ELPA package testsuites
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_elpa_test\fR [\fIdebhelper\ options\fR] [\fI\-\-autopkgtest\fR] [\fIpkg-file\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_elpa_test\fR is a debhelper program that is responsible for running
the testsuites of \s-1ELPA\s0 packages, when those test suites use \s-1ERT\s0 or
\&\fBbuttercup\fR\|(1).  \fBdh_auto_test\fR\|(1) is rarely suitable.
.PP
Testing with \fBbuttercup\fR\|(1) will be activated if the package
build-depends on elpa-buttercup.  Testing with \s-1ERT\s0 will be activated
if \s-1ERT\s0 test files can be found.  Neither kind of test will be
activated unless the debhelper compat level is 10 or higher.
.PP
\&\fBdh_elpa_test\fR overrides \fBdh_auto_test\fR\|(1).  If you need to switch back
to use \fBdh_auto_test\fR\|(1), use the \fBdisable\fR configuration key, below.
.SH "FILES"
.IX Header "FILES"
.IP "debian/elpa\-test" 4
.IX Item "debian/elpa-test"
Configuration for running the package's test suite.  Each line is of
the form \fIkey\fR = \fIvalue\fR, with \fIkey\fR drawn from the list of
configuration options below.
.Sp
Note that you should not surround values with double quotation marks.
This is convenient for including lisp.  Configuration values cannot
cover more than one line.  Lines preceded with a # are ignored as
comments.
.Sp
This configuration file is optional; in many cases, \fBdh_elpa_test\fR
can figure out how to run the test suite itself.
.SH "CONFIGURATION KEYS"
.IX Header "CONFIGURATION KEYS"
.IP "\fBdisable\fR" 4
.IX Item "disable"
If this key is set to any value, \fBdh_elpa\fR\|(1) will not invoke
\&\fBdh_elpa_test\fR.
.IP "\fBbuttercup_load_path\fR" 4
.IX Item "buttercup_load_path"
A comma-separated list of directories to add to the load-path when
\&\fBbuttercup\fR\|(1) invokes Emacs.  Will be passed to \fBbuttercup\fR\|(1) with its
\&\fB\-L\fR command line argument.
.IP "\fBbuttercup_patterns\fR" 4
.IX Item "buttercup_patterns"
A comma-separated list of Emacs regular expressions jointly matching
all and only the files containing Buttercup tests that you wish to
run.  If this key is not defined, all tests that can be found
will be run.  Will be passed to \fBbuttercup\fR\|(1) with its \fB\-p\fR command
line argument.
.IP "\fBert_exclude\fR" 4
.IX Item "ert_exclude"
A comma-separated list of file globs matching files containing \s-1ERT\s0
tests that should not be run.
.Sp
The '*' character in globs in this configuration key does \s-1NOT\s0 match
\&'/' directory separators.
.IP "\fBert_helper\fR" 4
.IX Item "ert_helper"
The name of a *.el file containing Emacs Lisp code that will run the
\&\s-1ERT\s0 test suite.  When this key is not defined, \fBdh_elpa_test\fR
calls the function \fB(ert-run-tests-batch-and-exit)\fR.
.Sp
Note that this is not the way to load test helpers that do needed work
but don't actually run the tests.  For that, you can use something like
.RS 4
.Sp
.Vb 1
\&    ert_eval = (load\-file "test\-helper.el")
.Ve
.RE
.RS 4
.RE
.IP "\fBert_eval\fR" 4
.IX Item "ert_eval"
Emacs Lisp code to be run prior to running \s-1ERT\s0 tests by the Emacs
instance spawned by \fBdh_elpa_test\fR to run those tests.
.IP "\fBert_load_path\fR" 4
.IX Item "ert_load_path"
A comma-separated list of directories to add to the load-path when
\&\fBdh_elpa_test\fR invokes Emacs to run \s-1ERT\s0 tests.
.IP "\fBautopkgtest_keep\fR" 4
.IX Item "autopkgtest_keep"
A comma-separated list of file globs matching files that should not be
moved out of the source tree before running \s-1DEP8\s0 tests (see the
\&\fB\-\-autopkgtest\fR option below).
.Sp
The '*' character in globs in this configuration key matches '/'
directory separators.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-autopkgtest\fR" 4
.IX Item "--autopkgtest"
Operate in autopkgtest mode.  \fBdh_elpa_test\fR will rename non-test *.el
files so that Emacs will not load them.  This ensures that the test
test the installed binary package rather than the unpacked source
package.
.Sp
To exclude files from this removal, specify them in the
\&\fBautopkgtest_keep\fR configuration option (see above).
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
Older versions of \fBdh_elpa_test\fR were configured using environment
variables corresponding to some of the above configuration keys.  For
example, the \fBert_eval\fR configuration key replaced environment
variable \fB\s-1DH_ELPA_TEST_ERT_EVAL\s0\fR.  Their use is now deprecated.  If
the debian/elpa\-test file exists, they will be ignored.