qpdf/README.maintainer

70 lines
2.4 KiB
Plaintext

Release Reminders
=================
* To create a source release, do an export from the version control
system to a directory called qpdf-version. From the parent of that
directory, run make_dist with the directory as an argument. For
internally testing releases, you can run make_dist with the
--no-tests option.
* Make sure version numbers are consistent in the following
locations:
configure.ac
qpdf.spec
qpdf/qpdf.cc
manual/qpdf-manual.xml
make_dist does this automatically.
* Each year, update copyright notices. Just search for Copyright.
Last updated: 2008.
* To construct a source distribution from a pristine checkout,
make_release does the following.
autoconf
./configure --enable-doc-maintenance
make build_manual
make distclean
* Remember to update documentation in the "files" subdirectory of the
website on sourceforge.net.
General Build Stuff
===================
QPDF supports autoconf and libtool but does not use automake. In
addition, there is no header file generated by autoconf. The only
file distributed with the qpdf source distribution that is not a
controlled file is "configure", and it is generated by just running
"autoconf". There is no need to run autoreconf, automake, autoheader,
aclocal, or any other autotools programs beyond autoconf.
A small handful of additional files have been taken from autotools
programs. These should probably be updated from time to time.
* config.guess, config.sub, ltmain.sh: these were created by running
libtoolize -c. To update, run libtoolize -f -c or remove the files
and rerun libtoolize.
* Other files copied as indicated:
cp /usr/share/aclocal/libtool.m4 aclocal.m4
cp /usr/share/automake-1.10/install-sh .
cp /usr/share/automake-1.10/mkinstalldirs .
The entire contents of aclocal.m4 came from libtool.m4. If we had
some additional local parts, we could manually combine them or we
could run aclocal. For now, the simple copy statement above is
sufficient.
If building or editing documentation, configure with
--enable-doc-maintenance. This will ensure that all tools or files
required to validate and build documentation are available.
If you want to run make maintainer-clean or make distclean and you
haven't run ./configure, you can pass CLEAN=1 to make on the command
line to prevent it from complaining about configure not having been
run.