MNT: Clean up/comment vars.mk

config/common/vars.mk

-# $Id$
+#########################################################
+# Variables used for FSL project compilation/installation
+#########################################################
 
-INCDIR = ${FSLDIR}/include
-LIBDIR = ${FSLDIR}/lib
+# All projects must specify a name
+PROJNAME =
 
-DEVINCDIR = ${FSLDEVDIR}/include
-DEVLIBDIR = ${FSLDEVDIR}/lib
+# Project-specific compiler/linker flags - these
+# can be overridden in the project Makefile
+USRLDFLAGS =
+USRINCFLAGS =
+USRCFLAGS =
+USRCXXFLAGS =
+LIBS =
 
-DESTDIR = ${FSLDEVDIR}
+# Project outputs - these variables control
+# what gets installed from a project. May
+# be customised/overridden in project
+# Makefiles
+HFILES = *.h
+AFILES = *.a
+SOFILES = *.so
+XFILES =
+SCRIPTS =
+TCLFILES = *.tcl
+MANFILES = man/*
+TESTXILES =
 
+# Final install destinations for project outputs
+DESTDIR = ${FSLDEVDIR}
 dest_INCDIR = ${DESTDIR}/include
 dest_LIBDIR = ${DESTDIR}/lib
 dest_BINDIR = ${DESTDIR}/bin
@@ -16,43 +36,30 @@ dest_TCLDIR = ${DESTDIR}/tcl
 dest_DOCDIR = ${DESTDIR}/doc
 dest_REFDOCDIR = ${DESTDIR}/refdoc
 
-
-# All projects must specify a name
-PROJNAME =
-
-# Project-specific compiler/linker flags - these
-# can be populated in the project Makefile
-USRLDFLAGS =
-USRINCFLAGS =
-USRCFLAGS =
-USRCXXFLAGS =
-LIBS=
+# Standard header/library locations for compiling/linking
+INCDIR = ${FSLDIR}/include
+LIBDIR = ${FSLDIR}/lib
+DEVINCDIR = ${FSLDEVDIR}/include
+DEVLIBDIR = ${FSLDEVDIR}/lib
 
 # Final header include directories
 INCFLAGS = ${USRINCFLAGS} -I. -I${DEVINCDIR} -I${INCDIR}
 
+#############################
 # Final compiler/linker flags
+#############################
+
+# All projects must use these flags for
+# compilation/linking, using the form:
+#
+# $(CXX) $(CXXFLAGS) <project flags/files> $(LDFLAGS)
+# $(CC)  $(CFLAGS)   <project flags/files> $(LDFLAGS)
+#
+# LDFLAGS *must* come at the end, to ensure proper linking.
+
 LDFLAGS = ${ARCHLDFLAGS} ${USRLDFLAGS} \
   -L. -L${DEVLIBDIR} -L${LIBDIR} \
   ${LIBS} ${ARCHLIBS}
 
 CFLAGS   = ${ARCHCFLAGS}   ${USRCFLAGS}   ${USRINCFLAGS} ${INCFLAGS}
 CXXFLAGS = ${ARCHCXXFLAGS} ${USRCXXFLAGS} ${USRINCFLAGS} ${INCFLAGS}
-
-HFILES = *.h
-AFILES = *.a
-SOFILES = *.so
-XFILES =
-SCRIPTS =
-TCLFILES = *.tcl
-MANFILES = man/*
-
-TESTXILES =
-
-DATATYPES =     if [ $$FDT = "8UI" ] ;  then STR="unsigned char" ; fi ; \
-                if [ $$FDT = "8SI" ] ;  then STR="signed char" ; fi ; \
-                if [ $$FDT = "16UI" ] ; then STR="unsigned short" ; fi ; \
-                if [ $$FDT = "16SI" ] ; then STR="signed short" ; fi ; \
-                if [ $$FDT = "32UI" ] ; then STR="unsigned int" ; fi ; \
-                if [ $$FDT = "32SI" ] ; then STR="signed int" ; fi ; \
-                if [ $$FDT = "32R" ] ;  then STR="float" ; fi