# Project initialization.
#
# Copyright (C) 2018-2025 Mohammad Akhlaghi <mohammad@akhlaghi.org>
#
# 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.
#
# You should have received a copy of the GNU General Public License
# along with this Makefile. If not, see <http://www.gnu.org/licenses/>.
# High-level directory definitions
# --------------------------------
#
# Basic directories that are used throughout the project.
#
# 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 project uses the 'flock' program
# to achieve this.
#
# To help with modularity and clarity of the build directory (not mixing
# software-environment built-products with products built by the analysis),
# it is recommended to put all your analysis outputs in the 'analysis'
# subdirectory of the top-level build directory.
badir=$(BDIR)/analysis
bsdir=$(BDIR)/software
# Derived directories (the locks directory can be shared with software
# which already has this directory.).
texdir = $(badir)/tex
lockdir = $(bsdir)/locks
indir = $(badir)/inputs
prepdir = $(badir)/prepare
mtexdir = $(texdir)/macros
installdir = $(bsdir)/installed
bashdir = reproduce/analysis/bash
pconfdir = reproduce/analysis/config
# Preparation phase
# -----------------
#
# This Makefile is loaded both for the 'prepare' phase and the 'make'
# phase. But the preparation files should be dealt with differently
# (depending on the phase). In the 'prepare' phase, the main directory
# should be created, and in the 'make' phase, its contents should be
# loaded.
#
# If your project doesn't need any preparation, you can ignore this.
#
# The '-' behind the include commands is used for adding the files only if
# it is possible (they exist). This is necessary because sometimes the user
# will have only '*.conf' or '*.mk' files, or with 'make clean' (where the
# preparation Makefile may call initialize.mk before the main
# 'top-make.mk'). If the '-' is not used, Make will complain about not
# finding these files.
ifeq (x$(project-phase),xprepare)
$(prepdir):; mkdir $@
else
-include $(bsdir)/preparation-done.mk
ifeq (x$(include-prepare-results),xyes)
-include $(prepdir)/*.mk $(prepdir)/*.conf
endif
endif
# TeX build directory
# ------------------
#
# In scenarios where multiple users are working on the project
# simultaneously, they can't all build the final paper together, there will
# be conflicts! It is possible to manage the working on the analysis, so no
# conflict is caused in that phase, but it would be very slow to only let
# one of the project members to build the paper at every instance
# (independent parts of the paper can be added to it independently). To fix
# this problem, when we are in a group setting, we'll use the user's ID to
# create a separate LaTeX build directory for each user.
#
# The same logic applies to the final paper PDF: each user will create a
# separte final PDF (for example 'paper-user1.pdf' and 'paper-user2.pdf')
# and no 'paper.pdf' will be built. This isn't a problem because
# 'initialize.tex' is a .PHONY prerequisite, so the rule to build the final
# paper is always executed (even if it is present and nothing has
# changed). So in terms of over-all efficiency and processing steps, this
# doesn't change anything.
ifeq (x$(GROUP-NAME),x)
texbtopdir = build
final-paper = paper.pdf
else
user = $(shell whoami)
texbtopdir = build-$(user)
final-paper = paper-$(user).pdf
endif
texbdir = $(texdir)/$(texbtopdir)
tikzdir = $(texbdir)/tikz
# Original system 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).
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 './project configure' time.
#
# Regarding the directories, this project 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.
#
# 'TEXINPUTS': we have to remove all possible user-specified directories to
# avoid conflicts with existing TeX Live solutions. Later (in 'paper.mk'),
# we are also going to overwrite 'TEXINPUTS' just before 'pdflatex'.
.ONESHELL:
export TEXINPUTS :=
export CCACHE_DISABLE := 1
export PATH := $(installdir)/bin
.SHELLFLAGS = --noprofile --norc -ec
export LDFLAGS := -L$(installdir)/lib
export SHELL := $(installdir)/bin/bash
export CPPFLAGS := -I$(installdir)/include
export LD_LIBRARY_PATH := $(installdir)/lib
# Until we build our own C library, without this, the project's GCC won't
# be able to compile anything if the host C library isn't in a standard
# place: in particular Debian-based operatings sytems. On other systems, it
# will be empty.
export CPATH := $(SYS_CPATH)
# RPATH is automatically written in macOS, so 'DYLD_LIBRARY_PATH' is
# ultimately redundant. But on some systems, even having a single value
# causes crashs (see bug #56682). So we'll just give it no value at all.
export DYLD_LIBRARY_PATH :=
# OpenMPI can depend on an existing 'ssh' or 'rsh' binary. However, because
# of security reasons, its best to not install them, disable any
# remote-shell accesss through this environment variable.
export OMPI_MCA_plm_rsh_agent=/bin/false
# Recipe startup script.
export PROJECT_STATUS := make
export BASH_ENV := $(curdir)/reproduce/software/shell/bashrc.sh
# Python enviroment
# -----------------
#
# The main Python environment variable is 'PYTHONPATH'. However, so far we
# have found several other Python-related environment variables on some
# systems which might interfere. To be safe, we are removing all their
# values.
export PYTHONPATH := $(installdir)/lib/python/site-packages
export PYTHONPATH3 := $(PYTHONPATH)
export _LMFILES_ :=
export PYTHONPATH2 :=
export LOADEDMODULES :=
export MPI_PYTHON_SITEARCH :=
export MPI_PYTHON2_SITEARCH :=
export MPI_PYTHON3_SITEARCH :=
# 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.
#
# 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 the outputs.
.SUFFIXES:
$(lockdir): | $(bsdir); mkdir $@
# Version and distribution tarball definitions.
#
# We need to export 'LD_LIBRARY_PATH' before calling 'git' because we the
# default export of 'LD_LIBRARY_PATH' doesn't take effect at this point
# (only within the recipes). Its also safe to directly use the 'git'
# executable using its absolute location (and not rely on 'PATH' at this
# stage).
project-commit-hash := $(shell \
if [ -d .git ]; then \
export LD_LIBRARY_PATH="$(installdir)/lib"; \
echo $$($(installdir)/bin/git describe --dirty --always --long); \
else echo NOGIT; fi)
project-package-name = maneaged-$(project-commit-hash)
project-package-contents = $(texdir)/$(project-package-name)
# 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 project version which may change between two separate runs, even when
# no file actually differs.
.PHONY: all clean dist dist-zip dist-lzip texclean distclean \
$(project-package-contents) $(mtexdir)/initialize.tex
texclean:
rm -f *.pdf
rm -rf $(texdir)/build/*
mkdir $(texdir)/build/tikz # 'tikz' is assumed to already exist.
clean:
# Delete the top-level PDF file.
rm -f *.pdf
# Delete possible LaTeX output in top directory. This can happen when
# the user has run LaTeX with applications other than maneage. For
# example, when opening 'paper.tex' file with 'texstudio' and
# executing 'build'.
rm -f *.aux *.log *.synctex *.auxlock *.dvi *.out *.run.xml *.bcf
# 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 $(texdir)/macros/!(dependencies.tex|dependencies-bib.tex|hardware-parameters.tex)
rm -rf $(badir)/!(tex) $(texdir)/!(macros|$(texbtopdir))
rm -rf $(texdir)/build/!(tikz) $(texdir)/build/tikz/*
rm -rf $(bsdir)/preparation-done.mk
distclean: clean
# Without cleaning the Git hooks, we won't be able to easily commit
# or checkout after this task is done. So we'll remove them first.
rm -f .git/hooks/post-checkout .git/hooks/pre-commit
# 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)
$$sys_rm -f .local .build $(pconfdir)/LOCAL.conf
# Packaging rules
# ---------------
#
# With the rules in this section, you can package the project in a state
# that is ready for building the final PDF with LaTeX. This is useful for
# collaborators who only want to contribute to the text of your project,
# without having to worry about the technicalities of the analysis.
$(project-package-contents): paper.pdf | $(texdir)
# Set up the output directory, delete it if it exists and remake it
# to fill with new contents.
dir=$@
rm -rf $$dir
mkdir $$dir
# Build a small Makefile to help in automatizing the paper building
# (including the bibliography).
m=$$dir/Makefile
echo "paper.pdf: paper.tex paper.bbl" > $$m
printf "\tpdflatex -shell-escape -halt-on-error paper\n" >> $$m
echo "paper.bbl: tex/src/references.tex" >> $$m
printf "\tpdflatex -shell-escape -halt-on-error paper\n" >> $$m
printf "\tbiber paper\n" >> $$m
echo ".PHONY: clean" >> $$m
echo "clean:" >> $$m
printf "\trm -f *.aux *.auxlock *.bbl *.bcf\n" >> $$m
printf "\trm -f *.blg *.log *.out *.run.xml\n" >> $$m
# Copy the top-level contents (see next step for 'paper.tex').
cp COPYING project README.md README-hacking.md $$dir/
# Since the packaging is mainly intended for high-level building of
# the PDF with LaTeX, we'll comment the 'makepdf' LaTeX macro in the
# paper. This will disable usage of TiKZ.
sed -e's|\\newcommand{\\makepdf}{}|%\\newcommand{\\makepdf}{}|' \
paper.tex > $$dir/paper.tex
# Copy ONLY the version-controlled files in 'reproduce' and
# 'tex/src'. This is important because files like 'LOCAL.conf' (in
# 'reproduce/software/config') should not be archived, they contain
# information about the host computer and are irrelevant for
# others. Also some project authors may have temporary files here
# that are not under version control and thus shouldn't be archived
# (although this is bad practice, but that is up to the user).
#
# To keep the sub-directory structure, we are packaging the files
# with Tar, piping it, and unpacking it in the archive directory. So
# afterwards we need to come back to the current directory.
tar -c -f - $$(git ls-files reproduce tex/src) \
| (cd $$dir ; tar -x -f -)
cd $(curdir)
# Build the other two subdirectories of 'tex/' that we need in the
# archive (in the actual project, these are symbolic links to the
# build directory).
mkdir $$dir/tex/tikz $$dir/tex/build
# Copy the 'tex/build' directory into the archive (excluding the
# temporary archive directory that we are now copying to). We will be
# using Bash's extended globbing ('extglob') for excluding this
# directory.
shopt -s extglob
cp -r tex/build/!($(project-package-name)) $$dir/tex/build
# Clean up the $(texdir)/build* directories in the archive (when
# building in a group structure, there will be 'build-user1',
# 'build-user2' and etc). These are just temporary LaTeX build files
# and don't have any relevant/hand-written files in them.
rm -rf $$dir/tex/build/build*
# If the project has any PDFs in its 'tex/tikz' directory (TiKZ or
# PGFPlots was used to generate them), copy them too.
if ls tex/tikz/*.pdf &> /dev/null; then
cp tex/tikz/*.pdf $$dir/tex/tikz
fi
# When submitting to places like arXiv, they will just run LaTeX once
# and won't run 'biber'. So we need to also keep the '.bbl' file into
# the distributing tarball. However, BibLaTeX is particularly
# sensitive to versioning (a '.bbl' file has to be read by the same
# BibLaTeX version that created it). This is hard to do with
# non-up-to-date places like arXiv. Therefore, we thus just copy the
# whole of BibLaTeX's source (the version we are using) into the top
# tarball directory. In this way, arXiv's LaTeX engine will use the
# same BibLaTeX version to interpret the '.bbl' file. TIP: you can
# use the same strategy for other LaTeX packages that may cause
# problems on the arXiv server.
cp tex/build/build/paper.bbl $$dir/
tltopdir=.local/texlive/maneage/texmf-dist/tex/latex
find $$tltopdir/biblatex/ -maxdepth 1 -type f -print0 \
| xargs -0 cp -t $$dir
# Just in case the package users want to rebuild some of the figures
# (manually un-comment the 'makepdf' command we commented above),
# correct the TikZ external directory, so the figures can be rebuilt.
pgfsettings="$$dir/tex/src/preamble-pgfplots.tex"
sed -e's|{tikz/}|{tex/tikz/}|' $$pgfsettings > $$pgfsettings.new
mv $$pgfsettings.new $$pgfsettings
# PROJECT SPECIFIC
# ----------------
# Put any project-specific distribution steps here.
# ----------------
# Clean temporary files that may have been created by text editors.
cd $(texdir)
find $(project-package-name) -name \*~ -delete
find $(project-package-name) -name \*.swp -delete
# Package into '.tar.gz' or '.tar.lz'.
dist dist-lzip: $(project-package-contents)
cd $(texdir)
tar -cf $(project-package-name).tar $(project-package-name)
if [ $@ = dist ]; then
suffix=gz
gzip -f --best $(project-package-name).tar
elif [ $@ = dist-lzip ]; then
suffix=lz
lzip -f --best $(project-package-name).tar
fi
rm -rf $(project-package-name)
cd $(curdir)
mv $(texdir)/$(project-package-name).tar.$$suffix ./
# Package into '.zip'.
dist-zip: $(project-package-contents)
cd $(texdir)
zip -q -r $(project-package-name).zip $(project-package-name)
rm -rf $(project-package-name)
cd $(curdir)
mv $(texdir)/$(project-package-name).zip ./
# Package the software tarballs.
dist-software:
dirname=software-$(project-commit-hash)
cd $(bsdir)
if [ -d $$dirname ]; then rm -rf $$dirname; fi
mkdir $$dirname
cp -L tarballs/* $$dirname/
tar -cf $$dirname.tar $$dirname
gzip -f --best $$dirname.tar
rm -rf $$dirname
cd $(curdir)
mv $(bsdir)/$$dirname.tar.gz ./
# Import input data
# -----------------
#
# The list files to be imported (downloaded from a server, or linked from a
# local location), are listed in 'reproduce/analysis/config/INPUTS.conf'
# along with their URLs and verification checksums. In most cases, you will
# not need to edit this rule. Simply follow the instructions at the top of
# 'INPUTS.conf' and set the variables names according to the described
# standards and everything should be fine.
#
# TECHNICAL NOTE on the '$(foreach, n ...)' loop of 'inputdatasets': we are
# using several (relatively complex!) features particular to Make: In GNU
# Make, '.VARIABLES' "... expands to a list of the names of all global
# variables defined so far" (from the "Other Special Variables" section of
# the GNU Make manual). Assuming that the pattern 'INPUT-%-sha256' is only
# used for input files, we find all the variables that contain the input
# file name (the '%' is the filename). Finally, using the
# pattern-substitution function ('patsubst'), we remove the fixed string at
# the start and end of the variable name.
#
# Download lock file: Most systems have a single connection to the
# internet, therefore downloading is inherently done in series. As a
# result, when more than one dataset is necessary for download, if they are
# done in parallel, the speed will be slower than downloading them in
# series. We thus use the 'flock' program to tie/lock the downloading
# process with a file and make sure that only one downloading event is in
# progress at every moment.
$(indir):; mkdir $@
downloadwrapper = $(bashdir)/download-multi-try.sh
inputdatasets := $(foreach i, \
$(patsubst INPUT-%-sha256,%, \
$(filter INPUT-%-sha256,$(.VARIABLES))) \
$(patsubst INPUT-%-fitsdatasum,%, \
$(filter INPUT-%-fitsdatasum,$(.VARIABLES))), \
$(indir)/$(i))
$(inputdatasets): $(indir)/%: | $(indir) $(lockdir)
# Starting rule with '@': In case there is a username or password
# given for the database, we don't want the values to be printed in
# the terminal as the pipeline is running. We are therefore starting
# this recipe with an '@' (so Make doesn't print the used
# commands). To help the user know what is happening (in case they
# can't tell from the Wget outputs), we'll just start the recipe with
# a notice on what is being imported.
@echo "Importing $@"
# If a username or password has been provided, add them to the WGET
# command. The two variables are defined in the local configuation
# file 'reproduce/software/config/LOCAL.conf' that is not under
# version control. Different servers may use different authentication
# formats. If the default one doesn't work for your server, comment
# it and uncomment the one that works. If your serve needs a
# different kind of authentication format, please add it yourself. In
# case you need a new format, we encourage you to send the format to
# us using the link below:
# https://savannah.nongnu.org/support/?group=reproduce&func=additem
authopt=""
if [ x"$(DATABASEAUTHTYPE)" != x ]; then
case "$(DATABASEAUTHTYPE)" in
# Format: '--user=XXXX --password=YYYY'
userpass)
if [ x'$(DATABASEUSER)' != x ]; then
authopt="--user='$(DATABASEUSER)'"; fi
if [ x'$(DATABASEPASS)' != x ]; then
authopt="$$authopt --password='$(DATABASEPASS)'"; fi
;;
# Format: --post-data 'username=XXXX&password=YYYY'
postdata)
if [ x'$(DATABASEUSER)' != x ]; then
authopt="--post-data 'username=$(DATABASEUSER)"; fi
if [ x'$(DATABASEPASS)' != x ]; then
authopt="$$authopt""&password=$(DATABASEPASS)'";
else authopt="$$authopt'" # To close the single quote
fi
;;
# Unrecognized format.
*)
echo "Maneage: 'DATABASEAUTHTYPE' format not recognized! Please see the description of this variable in 'reproduce/software/config/LOCAL.conf' for the acceptable values."; exit 1;;
esac
fi
# Download (or make the link to) the input dataset. If the file
# exists in 'INDIR', it may be a symbolic link to some other place in
# the filesystem. To avoid too many links when using these files
# during processing, we'll use 'readlink -f' so the link we make here
# points to the final file directly (note that 'readlink' is part of
# GNU Coreutils). If its not a link, the 'readlink' part has no
# effect.
unchecked=$@.unchecked
if [ -f $(INDIR)/$* ]; then
ln -fs $$(readlink -f $(INDIR)/$*) $$unchecked
else
touch $(lockdir)/download
$(downloadwrapper) "wget $$authopt --no-use-server-timestamps -O" \
$(lockdir)/download "$(INPUT-$*-url)" $$unchecked
fi
# Set the checksum related variables.
if [ x"$(INPUT-$*-sha256)" != x ]; then
suffix=sha256
sumin=$(INPUT-$*-sha256)
verifname="SHA256 checksum"
sum=$$(sha256sum $$unchecked | awk '{print $$1}')
elif [ x"$(INPUT-$*-fitsdatasum)" != x ]; then
suffix=fitsdatasum
sumin=$(INPUT-$*-fitsdatasum)
verifname="FITS standard DATASUM"
if [ x"$(INPUT-$*-fitshdu)" = x ]; then hdu=1;
else hdu="$(INPUT-$*-fitshdu)"; fi
sum=$$(astfits $$unchecked -h$$hdu --datasum | awk '{print $$1}')
else
echo "$@: checksum for verifyication not recognized!"; exit 1
fi
# Verify the input.
if [ $$sum = $$sumin ]; then
mv $$unchecked $@
echo "Integrity confirmed, using $@ in this project."
# Checksums didn't match.
else
# The user has asked to update the checksum in 'INPUTS.conf'.
if [ $$sumin = "--auto-replace--" ]; then
# Put the updated 'INPUTS.conf' in a temporary file.
inputstmp=$@.inputs
awk '{if($$1 == "INPUT-$*-'$$suffix'") \
$$3="'$$sum'"; print}' \
$(pconfdir)/INPUTS.conf > $$inputstmp
# Update the INPUTS.conf, but not in parallel (using the
# file-lock feature of 'flock').
touch $(lockdir)/inputs-update
flock $(lockdir)/inputs-update \
sh -c "mv $$inputstmp $(pconfdir)/INPUTS.conf"
mv $$unchecked $@
# Error on non-matching checksums.
else
echo; echo;
echo "Wrong $$verifname for input file '$*':"
echo " File location: $$unchecked"; \
echo " Expected $$verifname: $$sumin"; \
echo " Calculated $$verifname: $$sum"; \
echo; exit 1
fi
fi
# Directory containing to-be-published datasets
# ---------------------------------------------
#
# Its good practice (so you don't forget in the last moment!) to have all
# the plot/figure/table data that you ultimately want to publish in a
# single directory.
#
# There are two types of to-publish data in the project.
#
# 1. Those data that also go into LaTeX (for example to give to LateX's
# PGFPlots package to create the plot internally) should be under the
# '$(texdir)' directory (because other LaTeX producers may also need it
# for example when using './project make dist', or you may want to
# publish the raw data behind the plots, like:
# https://zenodo.org/record/4291207/files/tools-per-year.txt). The
# contents of this directory are also directly taken into the tarball.
#
# 2. The data that aren't included directly in the LaTeX run of the paper,
# can be seen as supplements. A good place to keep them is under your
# build-directory.
#
# RECOMMENDATION: don't put the figure/plot/table number in the names of
# your to-be-published datasets! Given them a descriptive/short name that
# would be clear to anyone who has read the paper. Later, in the caption
# (or paper's tex/appendix), you will put links to the dataset on servers
# like Zenodo (see the "Publication checklist" in 'README-hacking.md').
tex-publish-dir = $(texdir)/to-publish
data-publish-dir = $(badir)/data-to-publish
$(tex-publish-dir):; mkdir $@
$(data-publish-dir):; mkdir $@
# Print Copyright statement
# -------------------------
#
# The 'print-general-metadata' can be used to print the general metadata in
# published datasets that are in plain-text format. It should be called
# with make's 'call' function like this (where 'FILENAME' is the name of
# the file it will append this content to):
#
# $(call print-general-metadata, FILENAME)
#
# See 'reproduce/analysis/make/delete-me.mk' (in the Maneage branch) for a
# real-world usage of this variable.
doi-prefix-url = https://doi.org
arxiv-prefix-url = https://arxiv.org/abs
print-general-metadata = \
echo "\# Project title: $(metadata-title)" >> $(1); \
echo "\# Git commit (that produced this dataset): $(project-commit-hash)" >> $(1); \
echo "\# Git repository: $(metadata-git-repository)" >> $(1); \
if [ x$(metadata-arxiv) != x ]; then \
echo "\# Pre-print: $(arxiv-prefix-url)/abs/$(metadata-arxiv)" >> $(1); fi; \
if [ x$(metadata-doi-journal) != x ]; then \
echo "\# DOI (Journal): $(doi-prefix-url)/$(metadata-doi-journal)" >> $(1); fi; \
if [ x$(metadata-doi-zenodo) != x ]; then \
echo "\# DOI (Zenodo): $(doi-prefix-url)/$(metadata-doi-zenodo)" >> $(1); fi; \
echo "\#" >> $(1); \
echo "\# Copyright (C) $$(date +%Y) $(metadata-copyright-owner)" >> $(1); \
echo "\# Dataset is available under $(metadata-copyright)." >> $(1); \
echo "\# License URL: $(metadata-copyright-url)" >> $(1);
# Project initialization results
# ------------------------------
#
# This file will store some basic info about the project that is necessary
# for the final PDF. Since these are not version controlled, it must be
# calculated everytime the project is run. So even though this file
# actually exists, it is also aded as a '.PHONY' target above.
$(mtexdir)/initialize.tex:
# Version and title of project. About the starting '@': since these
# commands are run every time with './project make', it is annoying
# to print them on the standard output every time. With the '@', make
# will not print the commands that it runs in this recipe.
@d=$$(git show -s --format=%aD HEAD | awk '{print $$2, $$3, $$4}')
echo "\newcommand{\projectdate}{$$d}" > $@
echo "\newcommand{\projecttitle}{$(metadata-title)}" >> $@
echo "\newcommand{\projectversion}{$(project-commit-hash)}" >> $@
echo "\newcommand{\projectgitrepo}{$(metadata-git-repository)}" >> $@
echo "\newcommand{\projectcopyrightowner}{$(metadata-copyright-owner)}" >> $@
# Calculate the latest Maneage commit used to build this project:
# - The project may not have the 'maneage' branch (for example
# after cloning from a fork that didn't include it!). In this
# case, we'll print a descriptive warning, telling the user what
# should be done (reporting the last merged commit and its date
# is very useful for the future).
# - The '--dirty' option (used in 'project-commit-hash') isn't
# applicable to "commit-ishes" (direct quote from Git's error
# message!).
if git log maneage -1 &> /dev/null; then
c=$$(git merge-base HEAD maneage)
v=$$(git describe --always --long $$c)
d=$$(git show -s --format=%aD $$v | awk '{print $$2, $$3, $$4}')
else
echo
echo "WARNING: no 'maneage' branch found! Without it, the latest merge of "
echo "this project with Maneage can't be reported in the paper (which is bad "
echo "for your readers; that includes yourself in a few years). Please run "
echo "the commands below to fetch the 'maneage' branch from its own server "
echo "and remove this warning (these commands will not affect your project):"
echo " $ git remote add origin-maneage http://git.maneage.org/project.git"
echo " $ git fetch origin-maneage"
echo " $ git branch maneage --track origin-maneage/maneage"
echo
v="\textcolor{red}{NO-MANEAGE-BRANCH (see printed warning to fix this)}"
d="\textcolor{red}{NO-MANEAGE-DATE}"
fi
echo "\newcommand{\maneagedate}{$$d}" >> $@
echo "\newcommand{\maneageversion}{$$v}" >> $@
# ----------------- delete the lines below this -------------------
# These lines are only intended for the default template's output, to
# demonstrate that is it important to put links in the PDF (for
# showing where your input data came from). Remove these lines as
# part of the initial customization of Maneage for your project.
echo "\\newcommand{\\wfpctwourl}{$(INPUT-wfpc2.fits-url)}" >> $@
# ----------------- delete the lines above this -------------------