Commit 014d1ab2ed1d69c07deac482ab149815b10da1dd
1 parent
fabff0f3
Reminder to use Windows paths for large file tests
Showing
2 changed files
with
16 additions
and
14 deletions
README
| @@ -175,17 +175,17 @@ enabled by passing --enable-test-compare-images to ./configure. This | @@ -175,17 +175,17 @@ enabled by passing --enable-test-compare-images to ./configure. This | ||
| 175 | was on by default in qpdf versions prior to 3.0, but is now off by | 175 | was on by default in qpdf versions prior to 3.0, but is now off by |
| 176 | default. Large file tests can be enabled by passing | 176 | default. Large file tests can be enabled by passing |
| 177 | --with-large-file-test-path=path to ./configure or by setting the | 177 | --with-large-file-test-path=path to ./configure or by setting the |
| 178 | -QPDF_LARGE_FILE_TEST_PATH environment variable. Run ./configure | ||
| 179 | ---help for additional options. The test suite provides nearly full | ||
| 180 | -coverage even without these tests. Unless you are making deep changes | ||
| 181 | -to the library that would impact the contents of the generated PDF | ||
| 182 | -files or testing this on a new platform for the first time, there is | ||
| 183 | -no real reason to run these tests. If you're just running the test | ||
| 184 | -suite to make sure that qpdf works for your build, the default tests | ||
| 185 | -are adequate. The configure rules for these tests do nothing other | ||
| 186 | -than setting variables in autoconf.mk, so you can feel free to turn | ||
| 187 | -these on and off directly in autoconf.mk rather than rerunning | ||
| 188 | -configure. | 178 | +QPDF_LARGE_FILE_TEST_PATH environment variable. On Windows, this |
| 179 | +should be a Windows path. Run ./configure --help for additional | ||
| 180 | +options. The test suite provides nearly full coverage even without | ||
| 181 | +these tests. Unless you are making deep changes to the library that | ||
| 182 | +would impact the contents of the generated PDF files or testing this | ||
| 183 | +on a new platform for the first time, there is no real reason to run | ||
| 184 | +these tests. If you're just running the test suite to make sure that | ||
| 185 | +qpdf works for your build, the default tests are adequate. The | ||
| 186 | +configure rules for these tests do nothing other than setting | ||
| 187 | +variables in autoconf.mk, so you can feel free to turn these on and | ||
| 188 | +off directly in autoconf.mk rather than rerunning configure. | ||
| 189 | 189 | ||
| 190 | If you are packaging qpdf for a distribution and preparing a build | 190 | If you are packaging qpdf for a distribution and preparing a build |
| 191 | that is run by an autobuilder, you may want to add the | 191 | that is run by an autobuilder, you may want to add the |
README.maintainer
| @@ -8,9 +8,11 @@ Release Reminders | @@ -8,9 +8,11 @@ Release Reminders | ||
| 8 | 8 | ||
| 9 | * When making a release, always remember to run large file tests and | 9 | * When making a release, always remember to run large file tests and |
| 10 | image comparison tests (--enable-test-compare-images | 10 | image comparison tests (--enable-test-compare-images |
| 11 | - --with-large-file-test-path=/path). For a major release, consider | ||
| 12 | - running a spelling checker over the source code to catch errors in | ||
| 13 | - variable names, strings, and comments. Use ispell -p ispell-words. | 11 | + --with-large-file-test-path=/path). For Windows, use a Windows |
| 12 | + style path, not an MSYS path for large files. For a major release, | ||
| 13 | + consider running a spelling checker over the source code to catch | ||
| 14 | + errors in variable names, strings, and comments. Use ispell -p | ||
| 15 | + ispell-words. | ||
| 14 | 16 | ||
| 15 | * Run tests with sanitize address enabled: | 17 | * Run tests with sanitize address enabled: |
| 16 | 18 |