adopted two new variables
[feisty_meow.git] / scripts / clam / variables.def
index 6acd205616d969ea95c8b3a26b2aeab7b880ca7b..809f79e592ff001b606acf47d5edd875fe88b481 100644 (file)
@@ -5,7 +5,7 @@
 
 # This file contains definitions and descriptions of the variables used
 # in the CLAM system (Coordinated Library Automagic Make).  This defaults
-# file should be included near the start of the user's makefile, and then the
+# file should be included near the start of the user makefile, and then the
 # rules file should be included after the user has modified the appropriate
 # variables and added the appropriate rules and targets.
 
@@ -46,8 +46,8 @@ ifeq "$(OP_SYSTEM)" ""
     ifneq "$(IS_DOS)" ""
       OP_SYSTEM := WIN32
     else
-      # we don't have other comparisons yet, so we'll assume unix.  fix this
-      # if it's not your default operating system.
+      # we do not have other comparisons yet, so we will assume unix.  fix this
+      # if it is not your default operating system.
       OP_SYSTEM := UNIX
     endif
   endif
@@ -64,7 +64,7 @@ endif
 # "FEISTY_MEOW_APEX" is the root of the "build" for our compilation oriented
 # features.  All source code and build helper files are usually found there.
 # The build targets to be built are usually stored there also, although the
-# targets can be located elsewhere if desired.  see TARGETS_DIR below.
+# targets can be located elsewhere if desired.  see TARGETS_STORE below.
 export FEISTY_MEOW_APEX
 ifeq "$(FEISTY_MEOW_APEX)" ""
 #  FEISTY_MEOW_APEX = 
@@ -79,30 +79,30 @@ ifeq "$(FEISTY_MEOW_SCRIPTS)" ""
   export FEISTY_MEOW_SCRIPTS := $(FEISTY_MEOW_APEX)/scripts
 endif
 
-# "PRODUCTION_DIR" is where components required for building the code or
+# "PRODUCTION_STORE" is where components required for building the code or
 # installers can be found.
 #hmmm: is this redundant?
-export PRODUCTION_DIR
-ifeq "$(PRODUCTION_DIR)" ""
-  PRODUCTION_DIR=$(FEISTY_MEOW_APEX)/production
+export PRODUCTION_STORE
+ifeq "$(PRODUCTION_STORE)" ""
+  PRODUCTION_STORE=$(FEISTY_MEOW_APEX)/production
 endif
 
-# "CLAM_DIR" points at where the CLAM source files are located.  this is needed
+# "CLAM_SCRIPTS" points at where the CLAM source files are located.  this is needed
 # for finding shell scripts used during compilation.  if you are not using the
 # standard CLAM location, then modify this appropriately.
-export CLAM_DIR
-ifeq "$(CLAM_DIR)" ""
-  export CLAM_DIR := $(FEISTY_MEOW_SCRIPTS)/clam
+export CLAM_SCRIPTS
+ifeq "$(CLAM_SCRIPTS)" ""
+  export CLAM_SCRIPTS := $(FEISTY_MEOW_SCRIPTS)/clam
 endif
 
-# "TARGETS_DIR" is where all generated files will end up.  Usually the
+# "TARGETS_STORE" is where all generated files will end up.  Usually the
 # files are put in a subdirectory named after their file type, such as
-# "include".  These subdirectories will all live under the TARGETS_DIR.
-export TARGETS_DIR
-ifeq "$(TARGETS_DIR)" ""
+# "include".  These subdirectories will all live under the TARGETS_STORE.
+export TARGETS_STORE
+ifeq "$(TARGETS_STORE)" ""
   # the default is to generate files into subdirectories that are at the
   # top-level of the repository.
-  TARGETS_DIR = $(FEISTY_MEOW_APEX)
+  TARGETS_STORE = $(FEISTY_MEOW_APEX)
 endif
 
 # "CURRENT_DIR" is the directory where this make was started.
@@ -112,7 +112,7 @@ export CURRENT_DIR := $(shell pwd)
 
 # "PROJECT" is the root name for the project being compiled.  It is used
 # in generated directory names and for other purposes of uniquification.
-# This is a variable that _must_ be supplied by the user's makefile.
+# This is a variable that _must_ be supplied by the user makefile.
 # Examples:
 #     PROJECT = basis
 #     PROJECT = test_parser
@@ -124,8 +124,8 @@ export PROJECT
 export TARGETS
 
 # "ACTUAL_TARGETS" is how the targets are expected to be passed to the rules
-# file; this allows a plug-in module's rules to manipulate the TARGETS to make
-# sure that important files don't get deleted by the automatic deletion done
+# file; this allows rules from a plug-in module to manipulate the TARGETS to make
+# sure that important files do not get deleted by the automatic deletion done
 # with "make clean."  If the real module used does not create a variable called
 # ACTUAL_TARGETS from the TARGETS, then the default specified here is used.
 export ACTUAL_TARGETS = $(TARGETS)
@@ -158,21 +158,21 @@ export RUN_ALL_TESTS
 
 # "MAKEFILE_NAME" works with BUILD_BEFORE and BUILD_AFTER.  This allows
 # the name of the makefile in the subdirectory to be changed to something other
-# than 'makefile'.
+# than simply "makefile".
 export MAKEFILE_NAME = makefile
 
 ############################################################################
 
 # "FIND" is a macro that points to the real find command, which is the unix
 # find command.  on dosdows, the find command is utter garbage and we need
-# to make sure we don't accidentally run that inferior one.
+# to make sure we do not accidentally run that inferior one.
 export FIND = find
 
 # "PARAMETER_FILE" is the location of our version stamps (if defined) and
 # also contains any extra flags passed to the compilation.
 ifeq "$(PARAMETER_FILE)" ""
   # the default assumes that clam lives under the main hoople branch.
-  export PARAMETER_FILE = $(CLAM_DIR)/clam_parms.ini
+  export PARAMETER_FILE = $(CLAM_SCRIPTS)/clam_parms.ini
 endif
 
 # ensure that our version variables are available to sub-shells.
@@ -188,26 +188,20 @@ include $(PARAMETER_FILE)
 ############################################################################
 
 # "CLEAN" is a powerful flag that affects what clam does.  if the flag is
-# non-empty, then nothing will be built and every generated file that is
-# known about will be deleted.  it is intended as exported, since then sub-
-# shells know that they are cleaning and we do not have to pass them a
-# target.
-#hmmm: (although we do?)
+# non-empty, then nothing new will be built.
 export CLEAN
 # "CLEANUPS" are things to be removed by the "make clean" command.
-undefine CLEANUPS
+#CLEANUPS =
 # OTHER_CLEANS are targets to execute before performing the main clean up.
-# we intentionally reset this here to avoid a polluted variable getting
-# to us from a previous make.
-undefine OTHER_CLEANS
+#OTHER_CLEANS =
 
 # sets the temporary directory.
 export CLAM_TMP
 ifeq "$(CLAM_TMP)" ""
-  CLAM_TMP := $(GENERATED_DIR)/clam_tmp
+  CLAM_TMP := $(FEISTY_MEOW_GENERATED_STORE)/clam_tmp
 endif
 
-#turned off for the moment, since this seems like a bad idea; we define clam tmp in terms of tmp sometimes, don't we???
+#turned off for the moment, since this seems like a bad idea; we define clam tmp in terms of tmp sometimes, do not we???
 #ifeq "$(OP_SYSTEM)" "WIN32"
 #  # set these so that compilers and such will use them.
 #  export TMP := $(CLAM_TMP)
@@ -265,7 +259,7 @@ HIDESH = $(HIDER) $(SH)
 
 # "CATCHER" is a hider that looks for errors in the command being run and
 # stops the make if any are seen.
-CATCHER = $(HIDESH) $(CLAM_DIR)/badness_catcher.sh 
+CATCHER = $(HIDESH) $(CLAM_SCRIPTS)/badness_catcher.sh 
 
 # "NOISY" causes the compilation to be verbose.  All commands issued are echoed
 # to the standard output.