summaryrefslogtreecommitdiffstats
path: root/doc/paper/Makefile
blob: 702d7c7cb1f6a6a36bbfa9baa94f3cc43f7fa907 (plain)
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
#
# Makefile
#
# This makefile helps you building the document and testing the sources.
#




##
## Commands
##


#
# The latex compiler
#
LATEX=$(shell which pdflatex)
export LATEX

#
# The output command
#
ECHO_CMD=$(shell which echo)

#
# The command to remove something
#
RM_CMD=$(shell which rm)


##
## Flags
##

#
# Flags for subdirectories
#
MAKE_FLAGS=--no-print-directory
export MAKE_FLAGS

#
# Flags for the latex compilre
#
LATEX_FLAGS=-halt-on-error
export LATEX_FLAGS

#
# Output flags
#
ECHO_FLAGS=-e
export ECHO_FLAGS

#
# The remove flags
#
RM_FLAGS=-f


##
## Standard commands
##

#
# The command for printing something
#
ECHO=$(ECHO_CMD) $(ECHO_FLAGS)
export ECHO

RM=$(RM_CMD) $(RM_FLAGS)
export RM


##
## Files
##


#
# The PDF file we want
#
PDF_FILE=main.pdf

#
# The latex source file
#
LATEX_MAIN_SOURCE=main.tex

#
# All latex sources
#
LATEX_SUB_SOURCES:=$(shell find src -iname '*.tex')

#
# The main.aux file
#
AUX_FILE=main.aux

#
# .ist file
#
IST_FILE=main.ist

#
# Destination of the log from the make files
#
MAKELOG=make.log
export MAKELOG




##
## Directories
##


#
# The directory where scripts are located
#
SCRIPTS=scripts
export SCRIPTS

#
# The directory where are the generator scripts
#
GEN_DIR=gen
export GEN_DIR




##
## Misc vars
##


# Avoid strange shell setups, as proposed by the GNU coding standards
SHELL = /bin/sh

#
# removeable latex temporary files
#
LATEX_TMPFILES_FLAT=log nav out snm toc vrb bbl blg idx lof lot glg glo gls ist glsdefs
LATEX_TMPFILES_RECURSIVE=aux



##
## High level tasks
##


#
# The standard task, compiling the latex source to a
# pdf document.
#
# We compile the sources three times, to be sure everything compiled correctly
#
all: $(PDF_FILE)

#
# Testing task. Not meant to produce a pdf but to check for flaws in the source
# files
#
test one_time: $(AUX_FILE)




gen_tex:
	@$(ECHO) "\t[MAKE] $(GEN_DIR)"
	@$(MAKE) $(MAKE_FLAGS) -C $(GEN_DIR)




##
## Generation tasks
##


#
# Generate main.aux from TeX sources
#
$(AUX_FILE): $(LATEX_MAIN_SOURCE) $(LATEX_SUB_SOURCES) gen_tex
	@$(ECHO) "\t[LATEX]"
	@$(LATEX) $(LATEX_FLAGS) -draftmode $< >> $(MAKELOG)


#
# "Generate" .ist and .glo file simply by depending on the auxilary file
#
$(IST_FILE): $(AUX_FILE)


#
# Generate the PDF TODO: use stamp file and [[ -nt ]] or [[ -ot ]] (maybe in script)
#
$(PDF_FILE): $(AUX_FILE)
	@$(ECHO) "\t[LATEX]"
	@$(LATEX) $(LATEX_FLAGS) $(LATEX_MAIN_SOURCE) >> $(MAKELOG)

	@$(ECHO) "\t[LATEX]"
	@$(LATEX) $(LATEX_FLAGS) $(LATEX_MAIN_SOURCE) >> $(MAKELOG)




##
## Clean tasks
##


#
# Clean everything
#
clean: nearly_clean
	@$(ECHO) "\t[RM] *.pdf"
	@$(RM) "*.pdf"

#
# Remove everything except the target pdf file
#
nearly_clean: clean_gen
	@for tmp in $(LATEX_TMPFILES_FLAT);do		\
		$(ECHO) "\t[RM]\t*.$$tmp";				\
		$(RM) *.$$tmp;							\
	done
	@for tmp in $(LATEX_TMPFILES_RECURSIVE);do	\
		$(ECHO) "\t[RM]\t*.$$tmp";				\
		$(RM) $$(find -name *.$$tmp -type f);	\
	done
	@$(ECHO) "\t[RM]\t$(MAKELOG)"
	@$(RM) $(MAKELOG)

#
# Clean gen
#
clean_gen:
	@$(ECHO) "\t[MAKE]\t$(GEN_DIR) clean"
	@$(MAKE) $(MAKE_FLAGS) -C $(GEN_DIR) clean