[Genabel-commits] r1743 - in pkg/ProbABEL: . doc

[noreply at r-forge.r-project.org]

Author: lckarssen
Date: 2014-05-26 21:45:42 +0200 (Mon, 26 May 2014)
New Revision: 1743

Modified:
   pkg/ProbABEL/configure.ac
   pkg/ProbABEL/doc/INSTALL
   pkg/ProbABEL/doc/Makefile.am
Log:
Added ./configure option to ProbABEL that allows the user to disable creating the PDF manual from the LaTeX source. This can be used for example when the user doesn't have the required LaTeX packages installed.
Before this change ./configure only checked for the presence of the pdflatex binary.

Also added some documentation in the INSTALL file for this option and listed the required LaTeX packages.


Modified: pkg/ProbABEL/configure.ac
===================================================================
--- pkg/ProbABEL/configure.ac	2014-05-26 17:51:04 UTC (rev 1742)
+++ pkg/ProbABEL/configure.ac	2014-05-26 19:45:42 UTC (rev 1743)
@@ -116,13 +116,6 @@
 # Check for the presence of awk. Needed in the test suite
 AC_PROG_AWK
 
-# Check for presence of pdfLaTeX
-AC_CHECK_PROGS(PDFLATEX, pdflatex)
-if test -z "$PDFLATEX"; then
-  AC_MSG_NOTICE([pdflatex not found - Unable to create PDF version of the user manual])
-fi
-AM_CONDITIONAL([HAVE_PDFLATEX], test -n "$PDFLATEX")
-
 # Check for presence of R
 AC_CHECK_PROGS(R, R)
 if test -z "$R"; then
@@ -130,6 +123,26 @@
 fi
 AM_CONDITIONAL([HAVE_R], test -n "$R")
 
+# The user can disable building of the PDF of the manual, for example
+# if the required LaTeX packages are not installed
+AC_ARG_ENABLE([latex-doc],
+    [AS_HELP_STRING([--disable-latex-doc], [disable building the PDF
+    documentation from LaTeX source])],
+    [latexdoc=no],
+    [latexdoc=yes])
+
+if test "x$latexdoc" = "xyes"; then
+   AC_MSG_NOTICE([building of the PDF of the user manual from LaTeX source is enabled])
+   # Check for presence of pdfLaTeX
+   AC_CHECK_PROGS(PDFLATEX, pdflatex)
+   if test -z "$PDFLATEX"; then
+      AC_MSG_NOTICE([pdflatex not found - Unable to create PDF version of the user manual])
+   fi
+fi
+AM_CONDITIONAL([HAVE_PDFLATEX], test -n "$PDFLATEX")
+AM_CONDITIONAL([BUILD_latexdoc], test "x$latexdoc" = "xyes")
+
+
 # Check for the presence of Doxygen
 AC_CHECK_PROGS([DOXYGEN], doxygen)
 if test -z "$DOXYGEN"; then

Modified: pkg/ProbABEL/doc/INSTALL
===================================================================
--- pkg/ProbABEL/doc/INSTALL	2014-05-26 17:51:04 UTC (rev 1742)
+++ pkg/ProbABEL/doc/INSTALL	2014-05-26 19:45:42 UTC (rev 1743)
@@ -19,6 +19,30 @@
    directory in which files like Eigen/Dense and Eigen/Cholesky can be
    found. If ./configure cannot find the Eigen library it will say so.
 
+** LaTeX dependencies
+   In order to generate a PDF of the user manual, ProbABEL depends on
+   a basic LaTeX installation with pdflatex. In order to build the
+   documentation the following LaTeX packages need to be present:
+   - inputenc
+   - fontenc
+   - textcomp
+   - xcolor
+   - verbating
+   - listings
+   - titleref
+   - amsmath
+   - makeidx
+   - hyperref
+   - hypcap
+
+   By default the ./configure script tries to find the pdflatex
+   program. If it finds it the PDF manual will be built. To disable
+   building of the PDF manual from LaTeX source run ./configure as
+   follows:
+./configure --disable-latex-doc
+   This will also bypass the search for pdflatex.
+
+
 * Compiling for Linux
   If you downloaded the source from SVN (this is not necessary when
   installing from the distributed .tar.gz file), run:
@@ -35,9 +59,7 @@
   This will install the binaries (palinear etc.) in /usr/local/bin/,
   the documentation in /usr/local/share/doc/probabel/, the
   probabel_config.cfg file in /usr/local/etc/, and the examples in
-  /usr/local/share/ProbABEL/examples/. The ./configure script tests
-  for the presence of the pdflatex program. If it is not present the
-  PDF version of the documentation will not be built.
+  /usr/local/share/ProbABEL/examples/.
 
   NOTE: make install will OVERWRITE any file with the same name if it
   already exists. By default the name of the probabel config file is
@@ -84,7 +106,7 @@
   ones you specified when running ./configure earlier won't be
   "transmitted" to this run). This can be done as in the following
   example:
-DISTCHECK_CONFIGURE_FLAGS="--without-eigen" make distcheck
+DISTCHECK_CONFIGURE_FLAGS="--disable-latex-doc" make distcheck
 
   To clean up all files generated by ./configure and make, run
 make distclean

Modified: pkg/ProbABEL/doc/Makefile.am
===================================================================
--- pkg/ProbABEL/doc/Makefile.am	2014-05-26 17:51:04 UTC (rev 1742)
+++ pkg/ProbABEL/doc/Makefile.am	2014-05-26 19:45:42 UTC (rev 1743)
@@ -21,6 +21,7 @@
 
 CLEANFILES =
 
+if BUILD_latexdoc
 if HAVE_PDFLATEX
 MANNAME = ProbABEL_manual
 MANPDF = $(MANNAME).pdf
@@ -31,6 +32,7 @@
 CLEANFILES += $(MANPDF) $(MANNAME).log $(MANNAME).idx $(MANNAME).out \
  $(MANNAME).toc $(MANNAME).idx $(MANNAME).ilg $(MANNAME).ind $(MANAUX) .btmp
 endif
+endif
 
 if HAVE_DOXYGEN
 doxygen.stamp: Doxyfile