Changeset 3850

Timestamp:

Oct 10, 2018 9:13:14 PM (14 months ago)

Author:

lou

Message:

Rationalise the handling of data directories. Add/update comments.

Location:

trunk

Files:

• Makemain.inc (modified) (1 diff)
• coin.m4 (modified) (8 diffs)

trunk/Makemain.inc

@@ -38 +38 @@
 COIN_HAS_LATEX = @COIN_HAS_LATEX_TRUE@TRUE
 
-# Needless to say, it's important that doxydocdir_nosub not be a target for
+# Needless to say, it's important that baredocdir_nosub not be a target for
 # autoconf substitution.
 

trunk/coin.m4

@@ -492 +492 @@
 
 # This macro sets up the public variables for lib, PROJ_LFLAGS_PUB,
-# PROJ_CFLAGS_PUB, PROJ_PCFILES_PUB, and PROJ_DATA. These variables correspond
-# to Libs, Cflags, Requires, and datadir in the .pc.in file for a project.
-# More generally, this macro is useful when a project builds libraries that
-# are used by other libraries during the project build. For example, Osi
-# builds OsiLib, which is used by OsiCommonTest and the various OsiXxxLib
-# interfaces to third-party solvers.
+# PROJ_CFLAGS_PUB, PROJ_PCFILES_PUB, and PROJ_DATA_PUB. These variables
+# correspond to Libs, Cflags, Requires, and datadir in the .pc.in file for
+# a project.  More generally, this macro is useful when a project builds
+# libraries that are used by other libraries during the project build. For
+# example, Osi builds OsiLib, which is used by OsiCommonTest and the various
+# OsiXxxLib interfaces to third-party solvers.
 
 # PROJ_PCFILES_PUB should be used rarely, if ever. We're exposing public
@@ -504 +504 @@
 
 # The datadir variable is a COIN extension in the .pc file. It defaults
-# to @datadir@/@PACKAGE_TARNAME@ in accordance with Gnu standards.
+# to ${datarootdir}/PACKAGE_TARNAME in accordance with Gnu standards.
 
 AC_DEFUN([AC_COIN_INIT_LIBVARS],
@@ -511 +511 @@
   AC_SUBST(m4_toupper($1_CFLAGS_PUB),["$3"])
   AC_SUBST(m4_toupper($1_PCFILES_PUB),["$4"])
-  AC_SUBST(m4_toupper($1_DATA),["$5"])
+  AC_SUBST(m4_toupper($1_DATA_PUB),
+           [m4_default([$5],[\${datarootdir}/$PACKAGE_TARNAME])])
 ])
   
@@ -874 +875 @@
 # client packages. These variables match Requires.private, Libs.private,
 # and Cflags.private, respectively, in a .pc file.
+
+# Data directory information is used differently. Typically what's wanted is
+# individual variables specifying the data directory for each primitive. Hence
+# the macro defines PRIM_DATA for the primitive.
 
 # The macro doesn't test that the specified values actually work. This is
@@ -1199 +1204 @@
 # Cflags.private, respectively, in a .pc file.
 
+# Data directory information is used differently. Typically what's wanted is
+# individual variables specifying the data directory for each primitive. Hence
+# the macro defines PRIM_DATA for the primitive.
+
 # The macro doesn't test that the specified values actually work. This is
 # deliberate.  There's no guarantee that user-specified libraries and/or
@@ -1475 +1484 @@
 #                       doxygen documentation
 
+# It's not immediately obvious, but the code in this macro, configure-time
+# substitions in doxygen.conf.in, and build-time edits of doxygen.conf in
+# Makemain.inc combine to hardwire the assumptions that a tag file is named
+# proj_doxy.tag, that PKG_TARNAME is coin-or-proj, and that the doxygen
+# documentation is in the GNU default location $(docdir)/$PKG_TARNAME. Have
+# a look over the complete machinery before you start changing things. The
+# point of the build-time edits is to allow the user to redefine docdir at
+# build time, as per GNU standards. Failure to use coin-or-proj as PKG_TARNAME
+# will surely break linking of documentation with tag files.
+
 AC_DEFUN([AC_COIN_DOXYGEN],
 [
@@ -1501 +1520 @@
 fi
 
-# Generate a tag file name and a log file name
+# Generate a tag file name and a log file name.
 
 lc_pkg=`echo ${PACKAGE_NAME} | [tr [A-Z] [a-z]]`
@@ -1509 +1528 @@
 AM_CONDITIONAL(COIN_HAS_LATEX, [test $coin_have_latex = yes])
 
-# Process the list of project names and massage each one into the name of a
-# tag file. Further substitution for @doxydocdir@ will happen during make
-# install.
+# Process the list of project names and massage each one into the name of
+# a tag file. The value of coin_doxy_tagfiles is substituted for TAGFILES
+# in doxygen.conf.in. Further substitution for @baredocdir_nosub@ will happen
+# as an edit during make install. See comments in Makemain.inc.
 
 coin_doxy_tagfiles=