General Makefile Generator

A.J.Hurst

Version 1.3.3

20101213:091644

Table of Contents

1. Introduction

This document describes the construction of a number of makefiles. Some of these makefiles are independent, some are dependent upon each other. In order to maintain consistency between these makefiles, they are all assembled here, and are dcumented and maintained in this one place.

1.1 Files generated by this document

makefile

The basic makefile. I think this is now obsolete.

MakeXLP

The XML Literate Programming Makefile. It knows how to make tex, dvi, pdf and html files from a literate program xlp file, as well as tangling the program files.

MakeWeb

Build all general web pages. The main task of this makefile is in uploading files to the various servers.

MakeWebRail

Build all railway web pages. The main task of this makefile is in uploading files to the various servers.

2. Global Definitions and Configuration

These makefiles depend upon a number of global parameters to the scripts. These parameters are defined here.

FILES

A list of files in the current directory that are to be made.

RELCWD

The relative path to the current directory. This path must begin with a slash (if it is non-empty), and NOT end with a slash.

TMP-CSSE

Define the directory to be used to build files for transmission to the remote (school/csse) site.

XMLS

A list of xml files for transmission to the remote site.

XSLS

A list of xsl files for transmission to the remote site.

3. The Makefiles

3.1 The Web Makefiles

MakeWeb is the basic makefile for all web pages, except those in the Railway subtree. These are made by the makefile MakeWebRail.

3.1.1 MakeWeb

Make files associated with my general web pages (all except railway pages, see <MakeWebRail 3.4> below). The main task in this makefile is to upload files to the various servers, denoted as csse (the ex-School of Computer Science and Software Engineering), home (my home server, aka www.ajhurst.org), and work (my desktop machine at work).

These uploads are performed in the code fragments <make all csse 8.8>, <make all home 8.26>, and <make all work 8.48> respectively. The remaining code fragments provide definitions to setup the appropriate environment.

3.1.2 MakeWebRail

Similar remarks to <MakeWeb 3.3> apply here. The main differences are due to the fact that additional file types must be handled, which is done in the code fragments with suffix "rail", and by passing a non-empty parameter into the "make all ..." fragments. These parameters define the further (pseudo)files to be made.

4. Variable Definitions

We define first some definitions to expedite the specification of the rsync stages of making. The variable RSYNC defines the full path of the rsync program, at both ends of the transfer. The parameter to the program --rsync-path is the remote site path for the program.

DATE generates the date in ISO format ``YYYYMMDDTHHMMSS''.

RS-FILTR defines a sed filter that strips off rsync verbiage, leaving only statements of explicit file transfers.

The output from the rsync looks like this:

    building file list ... done
    index.xml
    
    sent 140 bytes  received 82 bytes  49.33 bytes/sec
    total size is 4375  speedup is 19.71

and the filter massages that to this:

    20061219T101133 .hurst.locals => index.xml

That is to say, all lines are date-time stamped, the first line and the last three lines are stripped, and the list of files remaining (the files actually synchronized) is annotated to show where they were synchronized to.

The variable DIRINDENT defines the nesting indentation applied when the make script recurses into sub-directories.

5. Machine Definitions

5.1 CSSE Machine

5.2 HOME Machine

5.3 HURST Machine

5.4 WORK Machine

5.5 LOCAL Machine

6. File Definitions

7. Debug Definitions

8. Basic Rules

8.1 Making School Server Files

The approach taken to making files that end up on a remote site with different machine environment is to build a `remote' subdirectory with all the remote files, suitably modified, within it. This directory can then be rsync-ed to the remote site to complete the make. By convention, the name of the subdirectory starts with the prefix .tmp with the nickname of the remote site following.

Files for the remote site are grouped into two basic categories - those that will require modification, and those that don't. Clearly the latter can be rsync-ed directly, and do not need to be built within the subdirectory `.tmpcsse'. Files that do need modification are processed by sed scripts using the local file as source, and the remote build file in .tmpcsse as destination. These modifications are performed by the make tmp csse ... scripts.

The remote copy process (rsync) is performed by the corresponding make csse ... chunks. A set of phony makefiles are built to indicate that the transfer has been performed, to avoid the overheads of re-rsync-ing them.

Synchronize any files that do not need transformation to remote site versions.

Synchronize any html files. It is assumed that these will not have any URLs that need modification - if they do, they should be included with the XML file definitions.

8.2 Making Home Server Files

8.3 Making Hurst Server Files

8.4 Making Work Server Files

8.5 Making Local Server Files

8.6 Making Clean

9. Indices

Document History