aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-11-15 13:28:57 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-11-15 13:32:57 +0000
commitfcc77a774f2e34bd9ed6ca4ea0f5577cba967f58 (patch)
treec06d88b87b8a258fd96edf31819bc6d555455fc4
parent9cfb8d30a7e0fc92dc60f4dad30efc7231b363dc (diff)
Building final PDF: pdf-build-final has to be given an explicit yes
Until now, when the 'pdf-build-final' configuration variable (defined in 'reproduce/analysis/config/pdf-build.conf') was given any string a PDF would be built. This was very confusing, because people could put a 'no' and the PDF would still be built! With this commit, only when this variable has a value of 'yes' will the PDF be built. If given any other string (or no string at all), it will not produce a PDF. This issue was reported by Zahra Sharbaf.
-rw-r--r--reproduce/analysis/config/pdf-build.conf10
-rw-r--r--reproduce/analysis/make/paper.mk16
-rw-r--r--reproduce/analysis/make/top-make.mk4
3 files changed, 15 insertions, 15 deletions
diff --git a/reproduce/analysis/config/pdf-build.conf b/reproduce/analysis/config/pdf-build.conf
index e2d59cc..48585b4 100644
--- a/reproduce/analysis/config/pdf-build.conf
+++ b/reproduce/analysis/config/pdf-build.conf
@@ -3,13 +3,13 @@
#
# During the project's early phases, it is usually not necessary to build
# the PDF file (which makes a lot of output lines on the command-line and
-# can make it hard to find the commands and possible errors (and their
-# outputs). Also, in some cases, only the produced results may be of
+# can make it hard to find the analysis commands and possible errors (and
+# their outputs). Also, in some cases, only the produced results may be of
# interest and not the final PDF, so LaTeX (and its necessary packages) may
-# not be installed.
+# not be installed at all.
#
-# If this variable is given any string, a PDF will be made with
-# LaTeX. Otherwise, a notice will just printed that for now, no PDF will be
+# If 'pdf-build-final' is given the value 'yes', a PDF will be made with
+# LaTeX. Otherwise, a notice will just printed that, no PDF will be
# created.
#
# Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>
diff --git a/reproduce/analysis/make/paper.mk b/reproduce/analysis/make/paper.mk
index 906b4d9..28f44a9 100644
--- a/reproduce/analysis/make/paper.mk
+++ b/reproduce/analysis/make/paper.mk
@@ -37,14 +37,14 @@
# completed.
#
# Note that if you don't want the final PDF and just want the processing
-# and file outputs, you can remove the value of `pdf-build-final' in
-# `reproduce/analysis/config/pdf-build.conf'.
+# and file outputs, you can give any value other than 'yes' to
+# 'pdf-build-final' in `reproduce/analysis/config/pdf-build.conf'.
$(mtexdir)/project.tex: $(mtexdir)/verify.tex
# If no PDF is requested, or if LaTeX isn't available, don't
# continue to building the final PDF. Otherwise, merge all the TeX
# macros into one for building the PDF.
- @if [ -f .local/bin/pdflatex ] && [ x"$(pdf-build-final)" != x ]; then
+ @if [ -f .local/bin/pdflatex ] && [ x"$(pdf-build-final)" = xyes ]; then
# Put a LaTeX input command for all the necessary macro files.
# 'hardware-parameters.tex' is created in 'configure.sh'.
@@ -59,11 +59,11 @@ $(mtexdir)/project.tex: $(mtexdir)/verify.tex
echo "LaTeX-built PDF paper will not be built."
echo
if [ x$(more-on-building-pdf) = x1 ]; then
- echo "To do so, make sure you have LaTeX within the project (you"
- echo "can check by running './.local/bin/latex --version'), _AND_"
- echo "make sure that the 'pdf-build-final' variable has a value."
- echo "'pdf-build-final' is defined in: "
- echo "'reproduce/analysis/config/pdf-build.conf'."
+ echo "To build the PDF, make sure you have LaTeX within the "
+ echo "project (you can check by running "
+ echo "'./.local/bin/latex --version'), _AND_ make sure that "
+ echo "the 'pdf-build-final' variable has a value of 'yes', it "
+ echo "is defined in: 'reproduce/analysis/config/pdf-build.conf'."
echo
echo "If you don't have LaTeX within the project, please re-run"
echo "'./project configure -e' when you have internet access."
diff --git a/reproduce/analysis/make/top-make.mk b/reproduce/analysis/make/top-make.mk
index 9a26f22..140b026 100644
--- a/reproduce/analysis/make/top-make.mk
+++ b/reproduce/analysis/make/top-make.mk
@@ -62,8 +62,8 @@ include reproduce/software/config/LOCAL.conf
# -----------------------------
#
# If you are just interested in the processing and don't want to build the
-# PDF, you can skip the creatation of the final PDF by removing the value
-# of `pdf-build-final' in `reproduce/analysis/config/pdf-build.conf'.
+# PDF, you can skip the creation of the final PDF by giving a value of
+# `yes' to `pdf-build-final' in `reproduce/analysis/config/pdf-build.conf'.
ifeq (x$(reproducible_paper_group_name),x$(GROUP-NAME))
all: paper.pdf
else