[SCM] Debian package checker branch, master, updated. 2.5.11-178-gb4ad56d
The following commit has been merged in the master branch:
commit b4ad56dd8bcfa27306de5ae3e4e3db8c56abccfa
Author: Niels Thykier <niels@thykier.net>
Date: Tue Feb 19 16:13:51 2013 +0100
doc: Move the "running tests" to L::Tutorial
Signed-off-by: Niels Thykier <niels@thykier.net>
diff --git a/doc/README.developers b/doc/README.developers
index 20390ed..2834742 100644
--- a/doc/README.developers
+++ b/doc/README.developers
@@ -170,105 +170,6 @@ locale. If this is absent, it may trigger some issues with some
(e.g. manpage) checks. With libc-bin from Wheezy and Lintian 2.5.5,
this is no longer an issue.
-=head3 Running tests
-
-Lintian has two "major" test-suites; the first one is the "new" test
-suite, which is devided into 5 sub-suites, and then there is the
-"legacy" test suite. Running all of the tests is as simple as
-invoking:
-
- $ debian/rules runtests
-
-Lintian has a large test suite that easily takes up to 30 minutes. So
-when debugging a particular test or check, you may want to run only
-parts of the test suite.
-
-Unless otherwise stated, only the new test suite supports the "extra"
-run options listed below. The legacy test-suite will generally give a
-warning about it being unable to find a test to run.
-
-=over 4
-
-=item Changing parallelization
-
-The test suite respects the "DEB_BUILD_OPTIONS=parallel=n", though "n"
-denotes the amount of "worker" threads. The test runner will
-generally have 2 threads more than that. Also each "worker" will run
-lintian, which parallelizes its unpacking as well.
-
-In case you are wondering about the 2 extra threads in the test
-runner, the first of them is the "coordinator"-thread (which will
-generally be waiting when the workers are active) and the second one
-is the "output"-thread (which handles the fancy output).
-
-Note: the legacy test suite only runs a single test at a time regardless
-of this setting.
-
-=item Running a single test
-
-To run a single test by its name, use:
-
- $ debian/rules runtests onlyrun=$name
-
-The legacy test suite supports this.
-
-Note: if the name does not match any test you will see up to two
-warnings about the test could not be found. If the test only exists
-in one of the suites (which is usually the case), you will see a
-warning from the other suite.
-
-=item Running all tests for a check
-
-To run all tests for a given check, use:
-
- $ debian/rules runtests onlyrun=$check
-
-$check must be the name of a check (it will test for
-checks/$check.desc). This will run all tests that starts with
-"$check-".
-
-Note: The "changes" sub-suite in the new test suite does not support
-this.
-
-If the name of the check clashes with the name of a test in the legacy
-test suite, then that test will also be run. Otherwise a warning will
-be printed from the legacy test suite.
-
-=item Running all tests in a sub-suite
-
-To run all tests in a given sub-suite, use:
-
- $ debian/rules runtests onlyrun=suite:$suites
-
-$suites is a comma-separated list of names of sub-suites to run.
-
-Note: this cannot be used to influence the order, in which the sub-suites
-are run.
-
-=item Running all tests designed for a specific tag
-
-To run all tests that has a "Test-For" or a "Test-Against" for a given
-tag, use:
-
- $ debian/rules runtests onlyrun=tag:$tag
-
-Alternatively:
-
- $ debian/rules check-tag tag=$tag
-
-The legacy test suite will not be run in this case.
-
-=item Running only the legacy test suite
-
-To run only the tests in legacy test suite use:
-
- $ debian/rules runtests onlyrun=--legacy-only
-
-The new test suite will not be run in this case, but it is not possible
-to select specific tests to run.
-
-=back
-
=head2 collections and checks
Collections (as the names suggests) are used to extract or/and
diff --git a/doc/tutorial/Lintian/Tutorial.pod b/doc/tutorial/Lintian/Tutorial.pod
index dd2bf86..fc3f0c8 100644
--- a/doc/tutorial/Lintian/Tutorial.pod
+++ b/doc/tutorial/Lintian/Tutorial.pod
@@ -13,9 +13,11 @@ approach Lintian and its code.
=over 4
-=item L<Writing a Lintian check|Lintian::Tutorial::WritingChecks>
+=item * L<Writing a Lintian check|Lintian::Tutorial::WritingChecks>
-=item Understanding Lintian
+=item * L<Running (parts of) the Lintian test suite|Lintian::Tutorial::TestSuite>
+
+=item * Understanding Lintian
To be written.
diff --git a/doc/tutorial/Lintian/Tutorial/TestSuite.pod b/doc/tutorial/Lintian/Tutorial/TestSuite.pod
new file mode 100644
index 0000000..6871e5d
--- /dev/null
+++ b/doc/tutorial/Lintian/Tutorial/TestSuite.pod
@@ -0,0 +1,115 @@
+=encoding utf-8
+
+=head1 NAME
+
+Lintian::Tutorial::TestSuite -- Quick intro to running the Lintian testsuite
+
+=head1 SYNOPSIS
+
+This guide will quickly introduce you to running the Lintian test
+suite and some tricks. The Lintian test suite is fairly large and
+accordingly it can take a substantial amount of time to run. To speed
+up development, there are various options to limit the tests to run.
+
+=head1 DESCRIPTION
+
+The Lintian test suite is an extensive collection of various test
+cases. The test suite consists of a "legacy" and a "new" part. The
+latter is further divided into 5 "sub-suites". The majority of all
+tests are currently located in the "tests" sub-suite (of the new
+part).
+
+To run the full suite in all of its glory, simply invoke:
+
+ $ debian/rules runtests
+
+But while writing a new tag (or check) you probably only want to run a
+particular (subset of the) test(s). See L</Running a subset of the
+tests> for the available options.
+
+The test suite respects the "DEB_BUILD_OPTIONS=parallel=n", though "n"
+denotes the amount of "worker" threads. The test runner will
+generally have 2 threads more than that. Also each "worker" will run
+lintian, which parallelizes its unpacking as well.
+
+In case you are wondering about the 2 extra threads in the test
+runner, the first of them is the "coordinator"-thread (which will
+generally be waiting when the workers are active) and the second one
+is the "output"-thread (which handles the fancy output).
+
+Note: the legacy test suite only runs a single test at a time regardless
+of this setting.
+
+=head2 Running a subset of the tests
+
+The following options are available:
+
+=over 4
+
+=item Running a single test
+
+To run a single test by its name, use:
+
+ $ debian/rules runtests onlyrun=$name
+
+The legacy test suite supports this.
+
+Note: if the name does not match any test you will see up to two
+warnings about the test could not be found. If the test only exists
+in one of the suites (which is usually the case), you will see a
+warning from the other suite.
+
+=item Running all tests for a check
+
+To run all tests for a given check, use:
+
+ $ debian/rules runtests onlyrun=$check
+
+$check must be the name of a check (it will test for
+checks/$check.desc). This will run all tests that starts with
+"$check-".
+
+Note: The "changes" sub-suite in the new test suite does not support
+this.
+
+If the name of the check clashes with the name of a test in the legacy
+test suite, then that test will also be run. Otherwise a warning will
+be printed from the legacy test suite.
+
+=item Running all tests in a sub-suite
+
+To run all tests in a given sub-suite, use:
+
+ $ debian/rules runtests onlyrun=suite:$suites
+
+$suites is a comma-separated list of names of sub-suites to run.
+
+Note: this cannot be used to influence the order, in which the sub-suites
+are run.
+
+=item Running all tests designed for a specific tag
+
+To run all tests that has a "Test-For" or a "Test-Against" for a given
+tag, use:
+
+ $ debian/rules runtests onlyrun=tag:$tag
+
+Alternatively:
+
+ $ debian/rules check-tag tag=$tag
+
+The legacy test suite will not be run in this case.
+
+=item Running only the legacy test suite
+
+To run only the tests in legacy test suite use:
+
+ $ debian/rules runtests onlyrun=--legacy-only
+
+The new test suite will not be run in this case, but it is not possible
+to select specific tests to run.
+
+=back
+
+=cut
+
--
Debian package checker
Reply to: