1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
# Initialize the reproduction pipeline.
#
# Original author:
# Mohammad Akhlaghi <mohammad@akhlaghi.org>
# Contributing author(s):
# Your name <your@email.address>
# Copyright (C) 2018, Your Name.
#
# This Makefile is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# This Makefile is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details.
#
# A copy of the GNU General Public License is available at
# <http://www.gnu.org/licenses/>.
# High-level directory definitions
# --------------------------------
#
# Basic directories that are used throughout the whole pipeline.
#
# Locks are used to make sure that an operation is done in series not in
# parallel (even if Make is run in parallel with the `-j' option). The most
# common case is downloads which are better done in series and not in
# parallel. Also, some programs may not be thread-safe, therefore it will
# be necessary to put a lock on them. This pipeline uses the `flock'
# program to achieve this.
texdir = $(BDIR)/tex
srcdir = reproduce/src
lockdir = $(BDIR)/locks
indir = $(BDIR)/inputs
texbdir = $(texdir)/build
tikzdir = $(texbdir)/tikz
mtexdir = $(texdir)/macros
pconfdir = reproduce/config/pipeline
installdir = $(BDIR)/dependencies/installed
# --------- Delete for no Gnuastro ---------
gconfdir = reproduce/config/gnuastro
# ------------------------------------------
# System's environment
# --------------------
#
# Before defining the local sub-environment here, we'll need to save the
# system's environment for some scenarios (for example after `clean'ing the
# built programs).
sys-path := $(PATH)
sys-rm := $(shell which rm)
curdir := $(shell echo $$(pwd))
# High level environment
# ----------------------
#
# We want the full recipe to be executed in one call to the shell. Also we
# want Make to run the specific version of Bash that we have installed
# during `./configure' time.
#
# Regarding the directories, this pipeline builds its major dependencies
# itself and doesn't use the local system's default tools. With these
# environment variables, we are setting it to prefer the software we have
# build here.
.ONESHELL:
.SHELLFLAGS = -ec
export PATH := $(installdir)/bin
export LD_LIBRARY_PATH := $(installdir)/lib
export LDFLAGS := -L$(installdir)/lib
export SHELL := $(installdir)/bin/bash
export CPPFLAGS := -I$(installdir)/include
# Make the high-level level directories
# -------------------------------------
#
# These are just the top-level directories for all the separate steps. The
# directories (or possible sub-directories) for individual steps will be
# defined and added within their own Makefiles.
#
# IMPORTANT NOTE for $(BDIR)'s dependency: it only depends on the existance
# (not the time-stamp) of `$(pconfdir)/LOCAL.mk'. So the user can make any
# changes within that file and if they don't affect the pipeline. For
# example a change of the top $(BDIR) name, while the contents are the same
# as before.
#
# The `.SUFFIXES' rule with no prerequisite is defined to eliminate all the
# default implicit rules. The default implicit rules are to do with
# programming (for example converting `.c' files to `.o' files). The
# problem they cause is when you want to debug the make command with `-d'
# option: they add too many extra checks that make it hard to find what you
# are looking for in this pipeline.
.SUFFIXES:
$(tikzdir): | $(texbdir); mkdir $@
$(texdir) $(lockdir): | $(BDIR); mkdir $@
$(mtexdir) $(texbdir): | $(texdir); mkdir $@
# High-level Makefile management
# ------------------------------
#
# About `.PHONY': these are targets that must be built even if a file with
# their name exists.
#
# Only `$(mtexdir)/initialize.tex' corresponds to a file. This is because
# we want to ensure that the file is always built in every run: it contains
# the pipeline version which may change between two separate runs, even
# when no file actually differs.
.PHONY: all clean distclean clean-mmap $(mtexdir)/initialize.tex
# --------- Delete for no Gnuastro ---------
clean-mmap:; rm -f reproduce/config/gnuastro/mmap*
# ------------------------------------------
clean: clean-mmap
# Delete the top-level PDF file.
rm -f *.pdf
# Delete all the built outputs except the dependency
# programs. We'll use Bash's extended options builtin (`shopt') to
# enable "extended glob" (for listing of files). It allows extended
# features like ignoring the listing of a file with `!()' that we
# are using afterwards.
shopt -s extglob
rm -rf $(BDIR)/!(dependencies)
distclean: clean
# We'll be deleting the built environent programs and just need the
# `rm' program. So for this recipe, we'll use the host system's
# `rm', not our own.
$(sys-rm) -rf $(BDIR) reproduce/build
$(sys-rm) -f Makefile .gnuastro .local
$(sys-rm) -f $(pconfdir)/LOCAL.mk $(gconfdir)/gnuastro-local.conf
# Check the version of programs which write their version
# -------------------------------------------------------
pvcheck = prog="$(strip $(1))"; \
ver="$(strip $(2))"; \
name="$(strip $(3))"; \
macro="$(strip $(4))"; \
v=$$($$prog --version | awk '/'$$ver'/{print "y"; exit 0}'); \
if [ x$$v != xy ]; then \
echo; echo "PIPELINE ERROR: Not running $$name $$ver"; echo; \
exit 1; \
fi; \
echo "\newcommand{\\$$macro}{$$ver}" >> $@
lvcheck = idir=$(BDIR)/dependencies/installed/include; \
f="$$idir/$(strip $(1))"; \
ver="$(strip $(2))"; \
name="$(strip $(3))"; \
macro="$(strip $(4))"; \
v=$$(awk '/^\#/&&/define/&&/'$$ver'/{print "y";exit 0}' $$f); \
if [ x$$v != xy ]; then \
echo; echo "PIPELINE ERROR: Not linking with $$name $$ver"; \
echo; exit 1; \
fi; \
echo "\newcommand{\\$$macro}{$$ver}" >> $@
# Pipeline initialization results
# -------------------------------
#
# This file will store some basic info about the pipeline that is necessary
# for the final PDF. Since these are not version controlled, it must be
# calculated everytime the pipeline is run. So even though this file
# actually exists, it is also aded as a `.PHONY' target above.
$(mtexdir)/initialize.tex: | $(mtexdir)
# Version of the pipeline and build directory (for LaTeX inputs).
@v=$$(git describe --dirty --always);
echo "\newcommand{\pipelineversion}{$$v}" > $@
@echo "\newcommand{\bdir}{$(BDIR)}" >> $@
# Versions of programs (same order as 'dependency-versions.mk').
$(call pvcheck, awk, $(gawk-version), GNU AWK, gawkversion)
$(call pvcheck, bash, $(bash-version), GNU Bash, bashversion)
$(call pvcheck, cmake, $(cmake-version), CMake, cmakeversion)
$(call pvcheck, curl, $(curl-version), cURL, curlversion)
$(call pvcheck, diff, $(diffutils-version), GNU Diffutils, \
diffutilsversion)
$(call pvcheck, find, $(findutils-version), GNU Findutils, \
findutilsversion)
$(call pvcheck, gs, $(ghostscript-version), GPL Ghostscript, \
ghostscriptversion)
$(call pvcheck, git, $(git-version), Git, gitversion)
$(call pvcheck, grep, $(grep-version), GNU Grep, grepversion)
$(call pvcheck, glibtool, $(libtool-version), GNU Libtool, \
libtoolversion)
$(call pvcheck, gzip, $(gzip-version), GNU Gzip, gzipversion)
$(call pvcheck, ls, $(coreutils-version), GNU Coreutils, \
coreutilsversion)
$(call pvcheck, lzip, $(lzip-version), Lzip, lzipversion)
$(call pvcheck, make, $(make-version), GNU Make, makeversion)
$(call pvcheck, pkg-config, $(pkgconfig-version), pkg-config, \
pkgconfigversion)
$(call pvcheck, sed, $(sed-version), GNU SED, sedversion)
$(call pvcheck, tar, $(tar-version), GNU Tar, tarversion)
$(call pvcheck, wget, $(wget-version), GNU Wget, wgetversion)
$(call pvcheck, which, $(which-version), GNU Which, whichversion)
$(call pvcheck, xz, $(xz-version), XZ Utils, xzversion)
# --------- Delete for no Gnuastro ---------
$(call pvcheck, astnoisechisel, $(gnuastro-version), Gnuastro, \
gnuastroversion)
# ------------------------------------------
# Bzip2 prints its version in standard error, not standard output!
echo "" | bzip2 --version &> $@_bzip2_ver;
v=$$(awk 'NR==1 && /'$(bzip2-version)'/{print "y"; exit 0}' \
$@_bzip2_ver);
if [ x$$v != xy ]; then
echo; echo "PIPELINE ERROR: Not running Bzip2 $(bzip2-version)";
echo; exit 1;
fi;
rm $@_bzip2_ver
echo "\newcommand{\\bziptwoversion}{$(bzip2-version)}" >> $@
# Unfortunately we couldn't find a way to retrieve the version of
# the discoteq `flock' that we are using here. So we'll just repot
# the version we downloaded and installed.
echo "\newcommand{\\flockversion}{$(flock-version)}" >> $@
# Versions of libraries.
$(call lvcheck, fitsio.h, $(cfitsio-version), CFITSIO, cfitsioversion)
$(call lvcheck, gsl/gsl_version.h, $(gsl-version), \
GNU Scientific Library (GSL), gslversion)
########## libjpeg not yet checked.
$(call lvcheck, git2/version.h, $(libgit2-version), Libgit2, \
libgitwoversion)
$(call lvcheck, openssl/opensslv.h, $(openssl-version), OpenSSL, \
opensslversion)
$(call lvcheck, tiffvers.h, $(libtiff-version), Libtiff, \
libtiffversion)
$(call lvcheck, wcslib/wcsconfig.h, $(wcslib-version), WCSLIB, \
wcslibversion)
$(call lvcheck, zlib.h, $(zlib-version), zlib, zlibversion)
# TeX package versions
cat $(BDIR)/dependencies/texlive-versions.tex >> $@
|
