- Added required environment variables.

nigel.stanger / Handbook

Browse code - Added required environment variables. master
1 parent fc32bcd commit 28fad231075129648dddc99acb9328e00f6e3069 nstanger authored on 19 Jan 2005

Patch

Showing 3 changed files

Ignore Space Show notes View makefile-templates/Makefile.content
################################################################################ # # File: $Id$ # # Template makefile for building a particular content file for a document. # Place a copy of this file in the directory containing the content file, # and modify as appropriate. The makefile should be called with the name # of a specific content file as target. It will then check whether there # are any prerequisites to that file that may have changed, and rebuild # them if necessary.Most of the work is done by the include files, and # should cater for almost all cases. However, if custom rules are needed # for a section, they can be appended to the end of the document's # makefile. # # Note that the ONLY mode of operation for this makefile is to be called # from the makefile for a particular document, with the name of a specific # content file as the target. This makefile cannot be easily executed # standalone! This is because the content directory can exist at a # relatively arbitrary location within the paper's directory hierarchy. We # therefore don't know where to look, relative to the current directory, # to find the local include directory, and thus cannot provide a # meaningful value for the variable LOCAL_HANDBOOK_INCLUDE. The value of # LOCAL_HANDBOOK_INCLUDE must therefore be passed in from the calling # environment. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. Since we don't know our current location in the paper's # directory hierarchy, this has to be defined by the makefile's calling # environment. It's an error not to define this variable. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined) ################################################################################ # # Include standard variables and rules for building content files. (Mainly # oriented towards graphics generation.) # include $(GLOBAL_HANDBOOK_INCLUDE)/build_content_rules.make ################################################################################ # # Add custom rules below here, as necessary. Rules should ensure that they # at least touch their targets. # ################################################################################ # # File: $Id$ # # Template makefile for building a particular content file for a document. # Place a copy of this file in the directory containing the content file, # and modify as appropriate. The makefile should be called with the name # of a specific content file as target. It will then check whether there # are any prerequisites to that file that may have changed, and rebuild # them if necessary.Most of the work is done by the include files, and # should cater for almost all cases. However, if custom rules are needed # for a section, they can be appended to the end of the document's # makefile. # # Note that the ONLY mode of operation for this makefile is to be called # from the makefile for a particular document, with the name of a specific # content file as the target. This makefile cannot be easily executed # standalone! This is because the content directory can exist at a # relatively arbitrary location within the paper's directory hierarchy. We # therefore don't know where to look, relative to the current directory, # to find the local include directory, and thus cannot provide a # meaningful value for the variable LOCAL_HANDBOOK_INCLUDE. The value of # LOCAL_HANDBOOK_INCLUDE must therefore be passed in from the calling # environment. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. Since we don't know our current location in the paper's # directory hierarchy, this has to be defined by the makefile's calling # environment. It's an error not to define this variable. # GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined) ################################################################################ # # Include standard variables and rules for building content files. (Mainly # oriented towards graphics generation.) # include $(GLOBAL_HANDBOOK_INCLUDE)/build_content_rules.make ################################################################################ # # Add custom rules below here, as necessary. Rules should ensure that they # at least touch their targets. #

Ignore Space Show notes View

makefile-templates/Makefile.content

################################################################################
#
# File: $Id$
#
# Template makefile for building a particular content file for a document.
# Place a copy of this file in the directory containing the content file,
# and modify as appropriate. The makefile should be called with the name
# of a specific content file as target. It will then check whether there
# are any prerequisites to that file that may have changed, and rebuild
# them if necessary.Most of the work is done by the include files, and
# should cater for almost all cases. However, if custom rules are needed
# for a section, they can be appended to the end of the document's
# makefile.
#
# Note that the ONLY mode of operation for this makefile is to be called
# from the makefile for a particular document, with the name of a specific
# content file as the target. This makefile cannot be easily executed
# standalone! This is because the content directory can exist at a
# relatively arbitrary location within the paper's directory hierarchy. We
# therefore don't know where to look, relative to the current directory,
# to find the local include directory, and thus cannot provide a
# meaningful value for the variable LOCAL_HANDBOOK_INCLUDE. The value of
# LOCAL_HANDBOOK_INCLUDE must therefore be passed in from the calling
# environment.
#
################################################################################

SHELL=/bin/sh

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and is defined relative to the root of that hierarchy.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. Since we don't know our current location in the paper's
# directory hierarchy, this has to be defined by the makefile's calling
# environment. It's an error not to define this variable.
#
GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes

LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined)

################################################################################
#
# Include standard variables and rules for building content files. (Mainly
# oriented towards graphics generation.)
#
include $(GLOBAL_HANDBOOK_INCLUDE)/build_content_rules.make

################################################################################
#
# Add custom rules below here, as necessary. Rules should ensure that they
# at least touch their targets.
#

SHELL=/bin/sh

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. Since we don't know our current location in the paper's
# directory hierarchy, this has to be defined by the makefile's calling
# environment. It's an error not to define this variable.
#
GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined)

################################################################################
#
# Add custom rules below here, as necessary. Rules should ensure that they
# at least touch their targets.
#

Ignore Space Show notes View makefile-templates/Makefile.document
################################################################################ # # File: $Id$ # # Template makefile for building a particular document within a section of # the handbook (e.g., Tutorials 5). Place a copy of this file in the # directory for each document, and modify as appropriate. The default # makefile checks (and rebuilds if necessary) all of the content files for # the current document, using recursive make calls to each content file. # Most of the work is done by the include files, and should cater for # almost all cases. However, if custom rules are needed for a section, # they can be appended to the end of the document's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes ################################################################################ # # Include standard variables and rules for building a document. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_document_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+= ################################################################################ # # File: $Id$ # # Template makefile for building a particular document within a section of # the handbook (e.g., Tutorials 5). Place a copy of this file in the # directory for each document, and modify as appropriate. The default # makefile checks (and rebuilds if necessary) all of the content files for # the current document, using recursive make calls to each content file. # Most of the work is done by the include files, and should cater for # almost all cases. However, if custom rules are needed for a section, # they can be appended to the end of the document's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes ################################################################################ # # Include standard variables and rules for building a document. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_document_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+=

Ignore Space Show notes View

makefile-templates/Makefile.document

################################################################################
#
# File: $Id$
#
# Template makefile for building a particular document within a section of
# the handbook (e.g., Tutorials 5). Place a copy of this file in the
# directory for each document, and modify as appropriate. The default
# makefile checks (and rebuilds if necessary) all of the content files for
# the current document, using recursive make calls to each content file.
# Most of the work is done by the include files, and should cater for
# almost all cases. However, if custom rules are needed for a section,
# they can be appended to the end of the document's makefile.
#
################################################################################

SHELL=/bin/sh

################################################################################
#
# Required Environment Variables
#
# TEACHING_SHARED
#	This variable specifies the path to the top level of the teaching
#	shared directory hierarchy (e.g., /path/to/Teaching/Shared).
#
TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared))
#
# ALL_PAPERS_ROOT
#	This variable specifies the path to the top level directory for all
#	papers taught, i.e., the directory that contains the individual paper
#	directory hierarchies. For example, /path/to/Teaching/2005.
#
ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005))
#
# HANDBOOK_INSTALL_ROOT
#	This variable specifies the path to the top level directory on the web
#	server, under which the files for this paper will be installed (that is,
#	the directory that contains the individual paper directory hierarchies).
#	For example, \\INFO-NTS-12\DBCourses$ (this may require munging).
#
HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$))

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and is defined relative to the root of that hierarchy.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. We are assuming a fixed directory structure here! We can't
# really do this as an environment variable because the full path will be
# different for each paper, and we can't use the variables from
# paper_variables.make to set the path, because that file is in the
# include directory! <head spins> We will, however, allow for the
# possibility of someone wanting to define this as an environment variable
# by making it a conditional assignment.
#
GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes

################################################################################
#
# Include standard variables and rules for building a document.
#
include $(GLOBAL_HANDBOOK_INCLUDE)/build_document_rules.make

################################################################################
#
# Add custom rules below here, as necessary. Add files to be deleted to the
# variables below, as appropriate.
#
# WEB_CLEAN_FILES+=
# PRINT_CLEAN_FILES+=
# ALL_CLEAN_FILES+=

SHELL=/bin/sh

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. We are assuming a fixed directory structure here! We can't
# really do this as an environment variable because the full path will be
# different for each paper, and we can't use the variables from
# paper_variables.make to set the path, because that file is in the
# include directory! <head spins> We will, however, allow for the
# possibility of someone wanting to define this as an environment variable
# by making it a conditional assignment.
#
GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes

Ignore Space Show notes View makefile-templates/Makefile.section
################################################################################ # # File: $Id$ # # Template makefile for building a complete section of the handbook (e.g., # Tutorials). Place a copy of this file in the directory for each section, # and modify as appropriate. The default makefile rebuilds all the # documents within that section, using recursive make calls to each # document. Most of the work is done by the include files, and should # cater for almost all cases. However, if custom rules are needed for a # section, they can be appended to the end of the section's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes ################################################################################ # # Include standard variables and rules for building a section. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+= ################################################################################ # # File: $Id$ # # Template makefile for building a complete section of the handbook (e.g., # Tutorials). Place a copy of this file in the directory for each section, # and modify as appropriate. The default makefile rebuilds all the # documents within that section, using recursive make calls to each # document. Most of the work is done by the include files, and should # cater for almost all cases. However, if custom rules are needed for a # section, they can be appended to the end of the section's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes ################################################################################ # # Include standard variables and rules for building a section. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+=

Ignore Space Show notes View

makefile-templates/Makefile.section

################################################################################
#
# File: $Id$
#
# Template makefile for building a complete section of the handbook (e.g.,
# Tutorials). Place a copy of this file in the directory for each section,
# and modify as appropriate. The default makefile rebuilds all the
# documents within that section, using recursive make calls to each
# document. Most of the work is done by the include files, and should
# cater for almost all cases. However, if custom rules are needed for a
# section, they can be appended to the end of the section's makefile.
#
################################################################################

SHELL=/bin/sh

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and is defined relative to the root of that hierarchy.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. We are assuming a fixed directory structure here! We can't
# really do this as an environment variable because the full path will be
# different for each paper, and we can't use the variables from
# paper_variables.make to set the path, because that file is in the
# include directory! <head spins> We will, however, allow for the
# possibility of someone wanting to define this as an environment variable
# by making it a conditional assignment.
#
GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes

################################################################################
#
# Include standard variables and rules for building a section.
#
include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make

SHELL=/bin/sh

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# LOCAL_HANDBOOK_INCLUDE is the local include directory for this
# particular paper, and is defined relative to the current execution
# directory. We are assuming a fixed directory structure here! We can't
# really do this as an environment variable because the full path will be
# different for each paper, and we can't use the variables from
# paper_variables.make to set the path, because that file is in the
# include directory! <head spins> We will, however, allow for the
# possibility of someone wanting to define this as an environment variable
# by making it a conditional assignment.
#
GLOBAL_HANDBOOK_INCLUDE?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes

Show line notes below