Commit 31efe701aedaf2d67704f1b293dd919bd4cf5e3d
1 parent
5a02471b
Image comparison tests are off by default
Showing
4 changed files
with
35 additions
and
6 deletions
ChangeLog
| 1 | 1 | 2012-07-21 Jay Berkenbilt <ejb@ql.org> |
| 2 | 2 | |
| 3 | + * Change configure to have image comparison tests disabled by | |
| 4 | + default. Update README and README.maintainer with information | |
| 5 | + about running them. | |
| 6 | + | |
| 3 | 7 | * Add --pages command-line option to qpdf to enable page-based |
| 4 | 8 | merging and splitting. |
| 5 | 9 | ... | ... |
README
| ... | ... | @@ -95,3 +95,27 @@ files in include/qpdf, especially QPDF.hh, QPDFObjectHandle.hh, and |
| 95 | 95 | QPDFWriter.hh. You can also study the code of qpdf/qpdf.cc, which |
| 96 | 96 | exercises most of the public interface. There are additional example |
| 97 | 97 | programs in the examples directory. |
| 98 | + | |
| 99 | + | |
| 100 | +Additional Notes on Test Suite | |
| 101 | +============================== | |
| 102 | + | |
| 103 | +By default, slow tests are disabled. Slow tests include image | |
| 104 | +comparison tests and large file tests. Image comparison tests can be | |
| 105 | +enabled by passing --enable-test-compare-images to ./configure. Large | |
| 106 | +file tests can be enabled by passing --with-large-file-test-path=path | |
| 107 | +to ./configure or by setting the LARGE_FILE_TEST_PATH environment | |
| 108 | +variable. Run ./configure --help for additional options. The test | |
| 109 | +suite provides nearly full coverage even without these tests. Unless | |
| 110 | +you are making deep changes to the library or testing this on a new | |
| 111 | +platform for the first time, there is no real reason to run these | |
| 112 | +tests. If you're just running the test suite to make sure that qpdf | |
| 113 | +works for your build, the default tests are adequate. | |
| 114 | + | |
| 115 | +If you are packaging qpdf for a distribution and preparing a build | |
| 116 | +that is run by an autobuilder, you may want to add the | |
| 117 | +--enable-show-failed-test-output to configure options. This way, if | |
| 118 | +the test suite fails, test failure detail will be included in the | |
| 119 | +build output. Otherwise, you will have to have access to the | |
| 120 | +qtest.log file from the build to view test failures. The debian | |
| 121 | +packages for qpdf enable this option, for example. | ... | ... |
README.maintainer
| 1 | 1 | Release Reminders |
| 2 | 2 | ================= |
| 3 | 3 | |
| 4 | - * When making a release, always remember to run large file tests. | |
| 5 | - For a major release, consider running a spelling checker over the | |
| 6 | - source code to catch errors in variable names, strings, and | |
| 7 | - comments. | |
| 4 | + * When making a release, always remember to run large file tests and | |
| 5 | + image comparison tests (--enable-test-compare-images | |
| 6 | + --with-large-file-test-path=/path). For a major release, consider | |
| 7 | + running a spelling checker over the source code to catch errors in | |
| 8 | + variable names, strings, and comments. | |
| 8 | 9 | |
| 9 | 10 | * Consider running tests with latest gcc and/or valgrind. To do |
| 10 | 11 | this, replace, build with debugging and without shared libraries. | ... | ... |
configure.ac
| ... | ... | @@ -213,13 +213,13 @@ fi |
| 213 | 213 | AC_SUBST(SKIP_TEST_COMPARE_IMAGES) |
| 214 | 214 | AC_ARG_ENABLE(test-compare-images, |
| 215 | 215 | AS_HELP_STRING([--enable-test-compare-images], |
| 216 | - [whether to compare images in test suite; enabled by default, enabling requires ghostscript and tiffcmp to be available]), | |
| 216 | + [whether to compare images in test suite; disabled by default, enabling requires ghostscript and tiffcmp to be available]), | |
| 217 | 217 | [if test "$enableval" = "no"; then |
| 218 | 218 | SKIP_TEST_COMPARE_IMAGES=1 |
| 219 | 219 | else |
| 220 | 220 | SKIP_TEST_COMPARE_IMAGES=0 |
| 221 | 221 | fi], |
| 222 | - [SKIP_TEST_COMPARE_IMAGES=0]) | |
| 222 | + [SKIP_TEST_COMPARE_IMAGES=1]) | |
| 223 | 223 | |
| 224 | 224 | AC_SUBST(SHOW_FAILED_TEST_OUTPUT) |
| 225 | 225 | AC_ARG_ENABLE(show-failed-test-output, | ... | ... |