#
# Description of make targets
# ---------------------------
#
# default, src  -->  build source
#
# doc  -->  build documentation
#
# config  -->  configure the build, write the build configuration file
#
#   optional parameters:
#     ARCH="value"     -->  corresponds to suffix for config file
#     OSNAME="value"   -->  name of OS
#     MACH="value"     -->  name of machine architecture
#     OPT="value"      -->  optional name
#     BUILD="value"    -->  whitespace separated list of build types,
#         acceptable values from list:  dynamic static plugin binary testbin
#     SRCMODS="value"  -->  whitespace separated list of source modules
#         to be built, corresponding to subdirectories under src/
#     INSTALL="value"  -->  base directory for installation (which can
#         be overridden in config/config.$(ARCH) file)
#
#   notes:
#     ARCH can be automatically determined and the other parameters have
#     default values.  OSNAME, MACH, and OPT can be used to override or
#     supplement automatic detection of ARCH.  When they are assigned
#     instead of ARCH, ARCH is determined to be "$(OSNAME)_$(MACH)-$(OPT)"
#     where the "_" is omitted if MACH is null and "-" is omitted if OPT
#     is null.  Whatever value is assigned to ARCH, a corresponding
#     config/config.$(ARCH) file must exist or an error occurs and no build
#     configuration file is written.  The order of the BUILD and SRCMODS
#     lists is significant to satisfy library dependencies.  It is best to
#     use default values for these if you aren't yet familiar with these
#     build dependencies.
#
#   example:
#     On a Linux box, "make config" will automatically set "ARCH=Linux"
#     in the build configuration file.  Using "make config OPT=debug" will
#     instead set "ARCH=Linux-debug" which builds libraries and binaries
#     without optimization and with debugging information for use in gdb.
#     On an Alpha box running Linux, "make config" will automatically
#     recognize and set "ARCH=Linux_alpha".
#
# show, show-config  -->  show the build configuration file
#
# clean  -->  cleanup build objects based on ARCH, BUILD, and SRCMODS
#
# clean-build  -->  remove the entire ARCH subdirectory tree
#
# clean-config  -->  remove the build configuration file
#
# clean-doc  -->  cleanup documentation build objects
#
# clean-all, very-clean  -->  cleanup documentation, remove all build
#               subdirectories, configuration files, and install logfiles
#
# install  -->  install source and doc builds, write install logfile
#
# show-install  -->  show install logfile
#
# uninstall  -->  use install logfile to remove all installed objects
#
# help  -->  display this file
#
#
# Quick directions for use
# ------------------------
#
# You must first configure before you can build the source.
# The easiest way to do this (using defaults) is as follows:
#
#   $ make config
#   $ make
#   $ make doc
#   $ make install  # you might need super-user privileges for this
#
# (You might need to edit the "make.config" file or create a
# "config/config.$(ARCH)" file for your architecture if one does not
# already exist.)  See document "Hacking MDX" for more information.
#