The Starlink Build System

Starlink System Note 78.1
Norman Gray, Peter W Draper, Mark B Taylor, Steven E Rankin
11 April 2005. Release snapshot: $Revision: 1.116 $. Last updated 28 May 2006

Central Laboratory of the Research Councils
Particle Physics & Astronomy Research Council

Starlink Project

Copyright 2004-5, Council for the Central Laboratory of the Research Councils

Retrieve hardcopy

Contents

• Abstract
• 1. Introduction
  • 1. Quick entry-points
• 2. Tools
  • 1. Overview of the Autotools
    • 1. Autoconf
      • 1. M4 syntax and traps
    • 2. Automake
    • 3. Libtool
    • 4. Autoreconf: why you don't need to know about aclocal
    • 5. Running ./configure
  • 2. Starconf, and the Starlink autoconf macros
    • 1. STARCONF_DEFAULT_PREFIX and STARCONF_DEFAULT_STARLINK
    • 2. Components
    • 3. File templates
    • 4. The format of the component.xml file
  • 3. Version numbers
  • 4. A few remarks on state
  • 5. Preprocessable Fortran
  • 6. Using the Starlink CVS repository
  • 7. CVS
    • 1. CVS and tagging
    • 2. CVS and recursion -- checking out only a subtree
• 3. Building applications and libraries
  • 1. The top-level Makefile
  • 2. Bootstrapping and building the entire tree
  • 3. Building a single component
  • 4. Building monoliths
  • 5. Bootstrapping without building: configuring starconf and the autotools
• 4. Incorporating a package into the Starlink build system
  • 1. Autoconfing a library
  • 2. The build system `interface'
  • 3. Distribution of components
    • 1. Making a distribution
      • 1. A distribution from the complete tree
      • 2. Distributing a single component
  • 4. Regression tests
  • 5. Importing third-party sources
    • 1. Configuring m4
    • 2. Configuring CFITSIO
    • 3. Configuring tcl
  • 6. Documentation
    • 1. Components containing only documentation
  • 7. Adding components: the final step
• 5. FAQs
  • 1. General FAQs
  • 2. Installation FAQs
  • 3. State FAQs
• 6. Miscellaneous hints and tips
  • 1. Forcing automake's choice of linking language
  • 2. Conditionally building components, I
  • 3. Conditionally Building Components, II
  • 4. Manipulating compiler and linker flags
• Appendices
  • A. The Starconf macros and variables
    • 1. AC_FC_CHECK_HEADERS
    • 2. AC_FC_CHECK_INTRINSICS
    • 3. AC_FC_HAVE_BOZ
    • 4. AC_FC_HAVE_OLD_TYPELESS_BOZ
    • 5. AC_FC_HAVE_PERCENTLOC
    • 6. AC_FC_HAVE_PERCENTVAL
    • 7. AC_FC_HAVE_TYPELESS_BOZ
    • 8. AC_FC_HAVE_VOLATILE
    • 9. AC_FC_LITERAL_BACKSLASH
    • 10. AC_FC_OPEN_SPECIFIERS
    • 11. AC_FC_RECL_UNIT
    • 12. AC_PROG_FC
    • 13. AC_PROG_FPP
    • 14. STAR_CHECK_PROGS
    • 15. STAR_CNF_COMPATIBLE_SYMBOLS
    • 16. STAR_DECLARE_DEPENDENCIES
    • 17. STAR_DEFAULTS
    • 18. STAR_INITIALISE_FORTRAN
    • 19. STAR_LARGEFILE_SUPPORT
    • 20. STAR_LATEX_DOCUMENTATION
    • 21. Variable STAR_MANIFEST_DIR
    • 22. STAR_MESSGEN
    • 23. STAR_MONOLITHS
    • 24. STAR_PATH_TCLTK
    • 25. STAR_PLATFORM_SOURCES
    • 26. STAR_PREDIST_SOURCES
    • 27. STAR_SPECIAL_INSTALL_COMMAND
    • 28. STAR_SUPPRESS_BUILD_IF
    • 29. STAR_XML_DOCUMENTATION
    • 30. starxxx_DATA -- special installation directories
    • 31. Obsolete macros
      • 1. AC_F77_HAVE_OPEN_READONLY
      • 2. STAR_DOCS_FILES and friends
      • 3. STAR_FC_LIBRARY_LDFLAGS
      • 4. STAR_HAVE_FC_OPEN_READONLY
  • B. The relationship with the GNU autotools
  • C. Possible future changes
• Backmatter
  • Changes
  • ID index
  • Keyword index