3.2.2 Control Files

Each package source must contain a number of control files in the top-level directory. These files in general can be created and then ignored, except for a few variables that need to be updated when new versions are released. In most cases even adding, renaming, and removing library source files can be handled by generic rules.

The package control files include

Makefile

Must set a few make variables used by the administrative utilities, and defines a couple of package-building targets to depend on appropriate targets defined generically in XEmacs.rules. It may also provide various variables and rules to transform the source tree structure into that expected by the run-time system.

package-info.in

Provides a template for package information to be provided to the administrative utilities. Static variables that are rarely changed (such as the package’s name) are entered as literals. Some variables are generated by the build process (build dates and MD5 checksums) and are automatically filled in. Finally, some variables that change irregularly (dependences and even version numbers) are set as make variables in the Makefile.

ChangeLog

Not strictly required, but normally a ChangeLog will be added by the XEmacs package maintainer if different from the upstream maintainer.

_pkg.el

Generated. Simply does a package-provide for the package.

auto-autoloads.el

Generated. Read when XEmacs is initialized, and provides autoloads for defuns and other forms in the sources that are marked with an autoload cookie (‘;;;###autoload’.

custom-loads.el

Generated. Read when XEmacs is initialized, and informs the Customize subsystem how to find the defcustom forms needed to create Customization forms for the usre configuration variables of the package.