Next: The ASTERIX File
Up: Introduction
Previous: Revision Control
Lets go back to the state files BUILT_$SYSTEM
etc. A Starlink
package (and for us, any ASTERIX directory) can exist in 4 states, unbuilt
(or source), built, installed and tested. The system is in the first state
if you unpack the source code distribution. The primary targets can now
be understood in terms of transitions between these states.
- build
- Changes the state from unbuilt to built by constructing
all the volatile, usually system dependent, files (eg executables)
Success is marked by the presence of the
.BUILT_$SYSTEM
file.
- unbuild
- Goes from built back to unbuilt by deleting the volatile
files and the built flag file.
- check
- Check that all the files that will be needed for a `build'
are in fact present. Generally a test that the `tar' file was not
corrupted
- clean
- Deletes any temporary files created by the `build' target.
Generally a null task in ASTERIX
- install
- Change the state from built to installed. Involves moving
and sometimes editing the volatile files into different directories.
Create the
.INSTALLED_$SYSTEM
flag file. Generally the built
volatiles are replaced with soft links to their installed counterparts
to save disk space.
- deinstall
- Recover the built system from the installed state. It
is quite important that this pair of targets are well written such
that if the install partially fails then the built system can be
correctly recovered.
- export
- Builds a
tar
file containing all the built files for
the architecture specified by the SYSTEM
environment variable.
The tar file is created compressed in the top-level directory with
name asterix_$SYSTEM.tar.Z
.
- export_source
- Builds a
tar
file containing all the source
and make files required to generate the binary built system and the
developer system. The file is created compressed in the top-level
directory with name asterix.tar.Z
.
- test
- Run a test procedure and create the test flag file. Not used
by ASTERIX.
In addition ASTERIX make files support a few more primary targets,
- help
- List the primary targets available to this directory
- developer
- Create the development system from the normal source
distribution. This involves setting up the SCCS directories.
- makes
- Recreate the
Makefile
for each of the dependent
sub-directories of the current directory. Invoked at the top level
of the ASTERIX distribution this will rebuild all the make files except the
top level one (which is a special case anyhow).
- showtree
- Display the directory structure from the current directory
downwards. Invoked from the top-level shows the ASTERIX directory tree
- rebuild
- Just performs a unbuild, then a build and
finally a clean.
- get_s_files
- Lists source files in the directory and all
sub-directories. This target is used by the
build_export
target
to construct the releasable files.
- get_b_files
- Lists built files in the directory and all sub-directories.
Used for building the binary release.
Next: The ASTERIX File
Up: Introduction
Previous: Revision Control
Asterix
Tue Oct 7 12:01:41 BST 1997