.\" Automatically generated by Pod::Man 4.11 (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 .\" ======================================================================== .\" .IX Title "autodep8 1" .TH autodep8 1 "2020-08-11" "" "" .\" 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" autodep8 \- DEP\-8 test control file generator .SH "DESCRIPTION" .IX Header "DESCRIPTION" autodep8 will detect well-known types of packages and generate DEP\-8\-compliant test control files for them. It can be used by \s-1DEP\-8\s0 implementations to support implicit test control files. .SH "USAGE" .IX Header "USAGE" .Vb 2 \& $ autodep8 # assumes source package in current dir \& $ autodep8 /path/to/srcpkg # path to source package .Ve .PP If a known package type is detected, autodep8 exits with 0 and prints the suggested contents of debian/tests/control to the standard output. .PP If a known package type is \s-1NOT\s0 detected, autodep8 exits with 1 and produces not output. .SH "AUTOMATIC USAGE BY AUTOPKGTEST" .IX Header "AUTOMATIC USAGE BY AUTOPKGTEST" autodep8 can be automatically called by \fBautopkgtest\fR\|(1). To achieve that, you must set the \fITestsuite:\fR field in the source package paragraph to \&\fIautopkgtest-pkg-TYPE\fR, where \fI\s-1TYPE\s0\fR if one of package types supported by autodep8. The valid values of \fI\s-1TYPE\s0\fR are listed below as the headings of the \&\*(L"\s-1EXAMPLES OF PRODUCED TEST CONTROL FILES\*(R"\s0 section. .PP See the \fBautopkgtest\fR\|(1) documentation for more details. .SH "HOW THE PACKAGE TYPE IS DETECTED" .IX Header "HOW THE PACKAGE TYPE IS DETECTED" \&\fBautodep8\fR will first look for \fITestsuite: autopkgtest-pkg-TYPE\fR field in \&\fIdebian/control\fR. if \fI\s-1TYPE\s0\fR is a known package type, then that is used. If not, each supported package type is tried against a set of heuristics, based on packages names, build dependencies. specific files under debian/, or a combination of those. .SH "PACKAGE-SPECIFIC CONFIGURATION" .IX Header "PACKAGE-SPECIFIC CONFIGURATION" Packages can provide configuration for \fBautodep8\fR in \&\fIdebian/tests/autopkgtest\-pkg\-${\s-1PACKAGETYPE\s0}.conf\fR. The file format is the following: .PP .Vb 3 \& # comment lines start with # and are ignored. \& # note that #\*(Aqs only mark comments when in the beginning of the line \& # empty lines are also ignored \& \& # values are set in this format: \& var1=value1 \& \& # spaces around the = sign are allowed \& var2 = value 2 \& \& # backslashes allow one to set values that span multiple lines. \& # Note that the newline is removed in the final value, though \& # The following is equivalent to "multiline=value1, value2" \& variable = value1, \e \& value2 .Ve .PP The following configuration variables are supported: .SS "All package types" .IX Subsection "All package types" \&\fBextra_depends\fR: extra test dependencies to be added to the generated tests. Will be included as-is in the generated control file. .PP \&\fBextra_restrictions\fR: extra restrictions to be added to the generated tests. Will be included as-is in the generated control file. .SS "python (debian/tests/autopkgtest\-pkg\-python.conf)" .IX Subsection "python (debian/tests/autopkgtest-pkg-python.conf)" \&\fBimport_name\fR: name of the module to import, if it cannot be inferred from the name of the Debian package. For example, `python3\-xlib` is used via `import Xlib`, so `import_name = Xlib` would be appropriate. This used to be configured by writing to `debian/tests/pkg\-python/import\-name`, but that is now deprecated. .SH "COMBINING AUTO-GENERATED TESTS WITH MANUALLY SPECIFIED ONES" .IX Header "COMBINING AUTO-GENERATED TESTS WITH MANUALLY SPECIFIED ONES" If `debian/tests/control` exists, autodep8 will prepend the contents of that file to its own output. In that case, autodep8 will exit with a status of 0 even if no known package type is detected. The same applies for `debian/tests/control.autodep8`, but the use of that file is deprecated because the test dependencies defined there aren't processed by dpkg-source. .SH "EXAMPLES OF PRODUCED TEST CONTROL FILES" .IX Header "EXAMPLES OF PRODUCED TEST CONTROL FILES" .SS "dkms (kpatch)" .IX Subsection "dkms (kpatch)" .Vb 3 \& Test\-Command: /usr/lib/dkms/dkms\-autopkgtest \& Restrictions: needs\-root, allow\-stderr \& Depends: @, dkms .Ve .SS "elpa (flycheck)" .IX Subsection "elpa (flycheck)" .Vb 3 \& Test\-Command: dh_elpa_test \-\-autopkgtest \& Depends: @, @builddeps@ \& Restrictions: rw\-build\-tree .Ve .SS "go (prometheus)" .IX Subsection "go (prometheus)" .Vb 3 \& Test\-Command: /usr/bin/dh_golang_autopkgtest \& Depends: @, @builddeps@, dh\-golang \& Restrictions: allow\-stderr .Ve .SS "nodejs (node-tar)" .IX Subsection "nodejs (node-tar)" .Vb 3 \& Test\-Command: /usr/share/pkg\-js\-autopkgtest/runner require \& Depends: @, pkg\-js\-autopkgtest \& Restrictions: superficial \& \& Test\-Command: /usr/share/pkg\-js\-autopkgtest/runner \& Depends: @, @builddeps@, pkg\-js\-autopkgtest \& Restrictions: allow\-stderr, skippable .Ve .SS "octave (octave-signal)" .IX Subsection "octave (octave-signal)" .Vb 3 \& Test\-Command: DH_OCTAVE_TEST_ENV="xvfb\-run \-a" /usr/bin/dh_octave_check \-\-use\-installed\-package \& Depends: @, octave\-control (>= 3.1.0), dh\-octave\-autopkgtest (>= 0.5.6), xauth, xvfb \& Restrictions: allow\-stderr .Ve .SS "perl (libtest-most-perl)" .IX Subsection "perl (libtest-most-perl)" .Vb 3 \& Test\-Command: /usr/share/pkg\-perl\-autopkgtest/runner build\-deps \& Depends: @, @builddeps@, pkg\-perl\-autopkgtest \& Features: test\-name=autodep8\-perl\-build\-deps \& \& Test\-Command: /usr/share/pkg\-perl\-autopkgtest/runner runtime\-deps \& Depends: @, pkg\-perl\-autopkgtest \& Features: test\-name=autodep8\-perl \& \& Test\-Command: /usr/share/pkg\-perl\-autopkgtest/runner runtime\-deps\-and\-recommends \& Depends: @, pkg\-perl\-autopkgtest \& Restrictions: needs\-recommends \& Features: test\-name=autodep8\-perl\-recommends .Ve .SS "python (python-flaky)" .IX Subsection "python (python-flaky)" .Vb 4 \& Test\-Command: set \-e ; for py in $(pyversions \-r 2>/dev/null) ; do cd "$AUTOPKGTEST_TMP" ; echo "Testing with $py:" ; $py \-c "import flaky; print flaky" ; done \& Depends: python\-all, python\-flaky \& Restrictions: allow\-stderr, superficial \& Features: test\-name=autodep8\-python2 \& \& Test\-Command: set \-e ; for py in $(py3versions \-r 2>/dev/null) ; do cd "$AUTOPKGTEST_TMP" ; echo "Testing with $py:" ; $py \-c "import flaky; print(flaky)" ; done \& Depends: python3\-all, python3\-flaky \& Restrictions: allow\-stderr, superficial \& Features: test\-name=autodep8\-python3 \& \& Test\-Command: cd "$AUTOPKGTEST_TMP" ; pypy \-c "import flaky; print flaky" \& Depends: pypy\-flaky \& Restrictions: allow\-stderr, superficial \& Features: test\-name=autodep8\-pypy .Ve .SS "r (r\-cran-evaluate)" .IX Subsection "r (r-cran-evaluate)" .Vb 3 \& Test\-Command: /usr/share/dh\-r/pkg\-r\-autopkgtest \& Depends: @, r\-cran\-testthat,r\-cran\-testthat\-dbgsym,r\-cran\-lattice,r\-cran\-lattice\-dbgsym,r\-cran\-ggplot2, pkg\-r\-autopkgtest \& Restrictions: allow\-stderr .Ve .SS "ruby (ruby\-sqlite3)" .IX Subsection "ruby (ruby-sqlite3)" .Vb 2 \& Test\-Command: gem2deb\-test\-runner \-\-autopkgtest \-\-check\-dependencies 2>&1 \& Depends: @, libsqlite3\-dev,rake,ruby\-hoe,ruby\-minitest,ruby\-redcloth, gem2deb\-test\-runner .Ve .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2014 by the contributing authors. See `git log` for details. .PP This program is free software: you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program. If not, see .