Skip to content

Commit

Permalink
Reminder to use Windows paths for large file tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jberkenbilt committed Aug 22, 2017
1 parent fabff0f commit 014d1ab
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
22 changes: 11 additions & 11 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -175,17 +175,17 @@ enabled by passing --enable-test-compare-images to ./configure. This
was on by default in qpdf versions prior to 3.0, but is now off by
default. Large file tests can be enabled by passing
--with-large-file-test-path=path to ./configure or by setting the
QPDF_LARGE_FILE_TEST_PATH environment variable. Run ./configure
--help for additional options. The test suite provides nearly full
coverage even without these tests. Unless you are making deep changes
to the library that would impact the contents of the generated PDF
files or testing this on a new platform for the first time, there is
no real reason to run these tests. If you're just running the test
suite to make sure that qpdf works for your build, the default tests
are adequate. The configure rules for these tests do nothing other
than setting variables in autoconf.mk, so you can feel free to turn
these on and off directly in autoconf.mk rather than rerunning
configure.
QPDF_LARGE_FILE_TEST_PATH environment variable. On Windows, this
should be a Windows path. Run ./configure --help for additional
options. The test suite provides nearly full coverage even without
these tests. Unless you are making deep changes to the library that
would impact the contents of the generated PDF files or testing this
on a new platform for the first time, there is no real reason to run
these tests. If you're just running the test suite to make sure that
qpdf works for your build, the default tests are adequate. The
configure rules for these tests do nothing other than setting
variables in autoconf.mk, so you can feel free to turn these on and
off directly in autoconf.mk rather than rerunning configure.

If you are packaging qpdf for a distribution and preparing a build
that is run by an autobuilder, you may want to add the
Expand Down
8 changes: 5 additions & 3 deletions README.maintainer
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ Release Reminders

* When making a release, always remember to run large file tests and
image comparison tests (--enable-test-compare-images
--with-large-file-test-path=/path). For a major release, consider
running a spelling checker over the source code to catch errors in
variable names, strings, and comments. Use ispell -p ispell-words.
--with-large-file-test-path=/path). For Windows, use a Windows
style path, not an MSYS path for large files. For a major release,
consider running a spelling checker over the source code to catch
errors in variable names, strings, and comments. Use ispell -p
ispell-words.

* Run tests with sanitize address enabled:

Expand Down

0 comments on commit 014d1ab

Please sign in to comment.