diff options
| -rw-r--r-- | manual/qpdf-manual.xml | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml index 0c921eb6..d30e8ea4 100644 --- a/manual/qpdf-manual.xml +++ b/manual/qpdf-manual.xml @@ -251,6 +251,56 @@ make top-level <filename>Makefile</filename>. </para> </sect1> + <sect1 id="ref.packaging"> + <title>Notes for Packagers</title> + <para> + If you are packaging qpdf for an operating system distribution, + here are some things you may want to keep in mind: + <itemizedlist> + <listitem> + <para> + Passing <option>--enable-show-failed-test-output</option> to + <command>./configure</command> will cause any failed test + output to be written to the console. This can be very useful + for seeing test failures generated by autobuilders where you + can't access qtest.log after the fact. + </para> + </listitem> + <listitem> + <para> + If qpdf's build environment detects the presence of autoconf + and related tools, it will check to ensure that automatically + generated files are up-to-date with recorded checksums and fail + if it detects a discrepancy. This feature is intended to + prevent you from accidentally forgetting to regenerate + automatic files after modifying their sources. If your + packaging environment automatically refreshes automatic files, + it can cause this check to fail. Supress qpdf's checks by + passing <option>--disable-check-autofiles</option> to + <command>/.configure</command>. This is safe since qpdf's + <command>autogen.sh</command> just runs autotools in the normal + way. + </para> + </listitem> + <listitem> + <para> + QPDF's <command>make install</command> does not install + completion files by default, but as a packager, it's good if + you install them wherever your distribution expects such files + to go. You can find completion files to install in the + <filename>completions</filename> directory. + </para> + </listitem> + <listitem> + <para> + Packagers are encouraged to install the source files from the + <filename>examples</filename> directory along with qpdf + development packages. + </para> + </listitem> + </itemizedlist> + </para> + </sect1> </chapter> <chapter id="ref.using"> <title>Running QPDF</title> @@ -4183,6 +4233,38 @@ print "\n"; </listitem> </itemizedlist> </listitem> + <listitem> + <para> + Notes for Packagers + </para> + <itemizedlist> + <listitem> + <para> + A new section has been added to the documentation with notes + for packagers. Please see <xref linkend="ref.packaging"/>. + </para> + </listitem> + <listitem> + <para> + The qpdf detects out-of-date automatically generated files. + If your packaging system automatically refreshes libtool or + autoconf files, it could cause this check to fail. To avoid + this problem, pass + <option>--disable-check-autofiles</option> to + <command>configure</command>. + </para> + </listitem> + <listitem> + <para> + If you would like to have qpdf completion enabled + automatically, you can install completion files in the + distribution's default location. You can find sample + completion files to install in the + <filename>completions</filename> directory. + </para> + </listitem> + </itemizedlist> + </listitem> </itemizedlist> </listitem> </varlistentry> |