Add a link to the GHC API docs from the library haddock index
[ghc.git] / libraries / Makefile
1
2 # To do a fresh build:
3 #
4 # make clean
5 # make boot
6 # make
7 #
8 # To rebuild a particular library <package>:
9 #
10 # make clean.library.<package>
11 # make make.library.<package>
12 #
13 # or the following is equivalent:
14 #
15 # make remake.library.<package>
16 #
17 # To add a new library to the tree, do
18 #
19 # darcs get http://darcs.haskell.org/packages/foo
20 # [ -f foo/configure.ac ] && ( cd foo && autoreconf )
21 # make make.library.foo
22
23 .PHONY: default_target
24
25 default_target: all
26
27 # make doesn't give us an easy way to get the libraries built in
28 # dependency order the first time, but not rebuild base (for example)
29 # when we want to rebuild another library later.
30 # So for now we just don't do anything in parallel in here.
31 .NOTPARALLEL:
32
33 # Ideally we'd just include something to give us variables
34 # for paths and arguments to tools etc, and those set in mk/build.mk.
35 TOP=..
36 include $(TOP)/mk/boilerplate.mk
37 include $(TOP)/mk/cabal-flags.mk
38
39 # Any libraries listed here should also be in ../packages
40
41 SUBDIRS = ghc-prim $(INTEGER_LIBRARY) base syb base3-compat array packedstring
42 SUBDIRS += containers bytestring old-locale old-time filepath
43 ifeq "$(GhcLibsWithUnix)" "YES"
44 SUBDIRS += unix
45 endif
46 ifeq "$(Windows)" "YES"
47 SUBDIRS += $(wildcard Win32)
48 endif
49 SUBDIRS += directory process pretty hpc template-haskell editline Cabal random haskell98
50
51 # Set GhcBootLibs=YES from the command line to work with just the libraries
52 # needed to bootstrap GHC.
53 ifneq "$(GhcBootLibs)" "YES"
54 SUBDIRS += $(wildcard regex-base)
55 SUBDIRS += $(wildcard regex-posix)
56 SUBDIRS += $(wildcard regex-compat)
57 SUBDIRS += $(wildcard parsec)
58 SUBDIRS += $(wildcard haskell-src)
59 SUBDIRS += $(wildcard html)
60 SUBDIRS += $(wildcard network)
61 SUBDIRS += $(wildcard QuickCheck)
62 SUBDIRS += $(wildcard HUnit)
63 SUBDIRS += $(wildcard mtl)
64 SUBDIRS += $(wildcard time)
65 SUBDIRS += $(wildcard stm)
66 SUBDIRS += $(wildcard xhtml)
67 SUBDIRS += $(wildcard parallel)
68 ifneq "$(wildcard dph)" ""
69 SUBDIRS += dph/dph-base
70 SUBDIRS += dph/dph-prim-interface
71 SUBDIRS += dph/dph-prim-seq
72 SUBDIRS += dph/dph-prim-par
73 SUBDIRS += dph/dph-seq
74 SUBDIRS += dph/dph-par
75 endif
76 endif
77
78 # -----------------------------------------------------------------------------
79
80 empty=
81 space=$(empty) $(empty)
82
83 # -----------------------------------------------------------------------------
84
85 ifeq "$(ghc_ge_609)" "YES"
86 GhcLibHcOpts += -fno-warn-deprecated-flags
87 endif
88
89 IFBUILDABLE=ifBuildable/ifBuildable $(FPTOOLS_TOP_ABS)/packages
90
91 ifneq "$(DOING_BIN_DIST)" "YES"
92
93 CONFIGURE_OPTS =
94 CONFIGURE_STAMP_EXTRAS :=
95
96 ifneq "$(findstring $(space)p$(space), $(space)$(GhcLibWays)$(space))" ""
97 CONFIGURE_OPTS += --enable-library-profiling
98 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-profiling
99 endif
100
101 ifeq "$(BuildSharedLibs)" "YES"
102 CONFIGURE_OPTS += --enable-shared
103 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-shared
104 endif
105
106 ifeq "$(SplitObjs)" "YES"
107 CONFIGURE_OPTS += --enable-split-objs
108 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-splitting
109 endif
110
111 .PHONY: subdirs
112
113 subdirs:
114 @echo $(SUBDIRS)
115
116 HERE_ABS=$(FPTOOLS_TOP_ABS)/libraries
117
118 CABAL_GHC_FLAGS = -Wall
119 ifeq "$(ghc_ge_605)" "NO"
120 CABAL_GHC_FLAGS += -cpp
121 endif
122
123 # Euch, hideous hack:
124 CABAL_VERSION = $(shell grep "^Version:" Cabal/Cabal.cabal | sed -e "s/^Version: //" -e 's/\./,/g')
125
126 BOOTSTRAPPING_FLAGS = $(CABAL_GHC_FLAGS) -DCABAL_VERSION=$(CABAL_VERSION) -odir $(HERE_ABS)/bootstrapping -hidir $(HERE_ABS)/bootstrapping -i$(HERE_ABS)/Cabal -i$(HERE_ABS)/filepath -i$(HERE_ABS)/hpc
127
128 .PHONY: boot
129
130 boot: ifBuildable/ifBuildable cabal-bin bootstrapping.conf
131
132 cabal-bin: cabal-bin.hs
133 -mkdir bootstrapping
134 $(GHC) $(BOOTSTRAPPING_FLAGS) --make cabal-bin -o cabal-bin
135
136 bootstrapping.conf: cabal-bin
137 echo "[]" > $@.tmp
138 -cd extensible-exceptions && $(CABAL) clean --distpref=dist-bootstrapping
139 cd extensible-exceptions && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
140 cd extensible-exceptions && $(CABAL) build --distpref=dist-bootstrapping
141 cd extensible-exceptions && $(CABAL) install --distpref=dist-bootstrapping --inplace
142 -cd filepath && $(CABAL) clean --distpref=dist-bootstrapping
143 cd filepath && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
144 cd filepath && $(CABAL) build --distpref=dist-bootstrapping
145 cd filepath && $(CABAL) install --distpref=dist-bootstrapping --inplace
146 -cd Cabal && $(CABAL) clean --distpref=dist-bootstrapping
147 cd Cabal && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
148 cd Cabal && $(CABAL) build --distpref=dist-bootstrapping
149 cd Cabal && $(CABAL) install --distpref=dist-bootstrapping --inplace
150 -cd hpc && $(CABAL) clean --distpref=dist-bootstrapping
151 cd hpc && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
152 cd hpc && $(CABAL) build --distpref=dist-bootstrapping
153 cd hpc && $(CABAL) install --distpref=dist-bootstrapping --inplace
154 mv $@.tmp $@
155
156 ifBuildable/ifBuildable: ifBuildable.hs
157 -$(RM) -rf ifBuildable
158 mkdir ifBuildable
159 $(CP) ifBuildable.hs ifBuildable/
160 ifeq "$(stage)" "2"
161 cd ifBuildable && ../$(HC) -Wall --make ifBuildable -o ifBuildable
162 else
163 cd ifBuildable && $(GHC) -Wall --make ifBuildable -o ifBuildable
164 endif
165
166 .PHONY: all build configure
167
168 all: build
169
170 .PHONY: rebuild.library.%
171 .PHONY: remake.library.%
172
173 $(foreach SUBDIR,$(SUBDIRS),rebuild.library.$(SUBDIR)):\
174 rebuild.library.%: clean.library.% build.library.%
175
176 $(foreach SUBDIR,$(SUBDIRS),remake.library.$(SUBDIR)):\
177 remake.library.%: clean.library.% make.library.%
178
179 # NB. we're depending on make chasing dependencies from left to right here.
180 # This bit goes wrong with 'make -j'.
181 build: $(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR))
182
183 configure: $(foreach SUBDIR,$(SUBDIRS), \
184 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR))
185
186 .PHONY: build.library.%
187 .PHONY: make.library.%
188
189 # We should depend on %/%.cabal here (and in other rules), but make
190 # makes that difficult.
191
192 ALL_CONFIGURE_FLAGS = \
193 $(INSTALL_DIRS_CONFIGURE_FLAGS) \
194 $(USE_STAGE1_CONFIGURE_FLAGS) \
195 $(COMMON_CONFIGURE_FLAGS) \
196 --haddock-options="--use-contents=../index.html \
197 --use-index=../doc-index.html" \
198 $(CONFIGURE_OPTS)
199
200 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).dph/dph-par: \
201 dph/dph-par
202
203 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).dph/dph-seq: \
204 dph/dph-seq
205
206 dph/%:
207 $(MAKE) -C dph $*
208
209 $(foreach SUBDIR,$(SUBDIRS), \
210 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
211 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: cabal-bin
212 -$(RM) -f stamp/configure.library.*.$* $*/unbuildable
213 $(MKDIRHIER) `dirname $@`
214 ( cd $* && $(CABAL) configure $(ALL_CONFIGURE_FLAGS) ) \
215 && touch $@ || touch $*/unbuildable
216 # We don't touch $@ if configure failed as we would prefer to try
217 # configuring it next time round, rather than assuming it'll still fail.
218 # This is particularly important for bootlibs, where failure means the
219 # build dies!
220
221 # Build the library using 'make'
222 # We re-run 'setup makefile' each time, just in case any preprocessing
223 # needs to be done. However, we're careful not to overwrite GNUmakefile
224 # if it hasn't changed, so that dependency-generation isn't forced
225 # every time.
226 $(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR)):\
227 make.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
228 cabal-bin ifBuildable/ifBuildable
229 if $(IFBUILDABLE) $*; then \
230 cd $* && \
231 cmp -s $(MAKEFILE_LOCAL) Makefile.local || cp $(MAKEFILE_LOCAL) .; \
232 mv GNUmakefile GNUmakefile.tmp; \
233 $(CABAL) makefile -f GNUmakefile; \
234 cmp -s GNUmakefile GNUmakefile.tmp && mv GNUmakefile.tmp GNUmakefile; \
235 $(MAKE) $(MFLAGS) && \
236 $(CABAL) register --inplace; \
237 fi
238
239 MAKEFILE_LOCAL = $(FPTOOLS_TOP_ABS)/libraries/Makefile.local
240
241 # Build the library using 'setup build' (not the default)
242 $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
243 build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
244 cabal-bin ifBuildable/ifBuildable
245 if $(IFBUILDABLE) $*; then \
246 cd $* && \
247 $(CABAL) build $(BUILD_FLAGS); \
248 $(CABAL) register --inplace; \
249 fi
250
251 .PHONY: doc html
252
253 html: doc
254
255 # No docs for compat libraries for now.
256 DOC_SUBDIRS = $(filter-out %-compat, $(SUBDIRS))
257
258 doc: $(foreach SUBDIR,$(DOC_SUBDIRS),doc.library.$(SUBDIR))
259 sh gen_contents_index --inplace
260
261 # Making hyperlinked source only works if we have hscolour
262 ifneq "$(HSCOLOUR)" ""
263 CABAL_HADDOCK_FLAGS += --hyperlink-source
264 endif
265 CABAL_HADDOCK_FLAGS += --with-haddock=$(FPTOOLS_TOP_ABS)/utils/haddock/install-inplace/bin/haddock
266
267 $(foreach SUBDIR,$(DOC_SUBDIRS),doc.library.$(SUBDIR)):\
268 doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
269 cabal-bin ifBuildable/ifBuildable
270 if $(IFBUILDABLE) $*; then \
271 cd $* && $(CABAL) haddock --html-location='../$$pkg' \
272 $(CABAL_HADDOCK_FLAGS); \
273 fi
274 ifneq "$(HSCOLOUR)" ""
275 # We use */src rather than $*/src due to the $(INTEGER_LIBRARY)/integer
276 # mismatch
277 # XXX We also need to check that the directory exists, as e.g. dph disables
278 # haddock, so the directory doesn't get made. We should remove this once
279 # we can always haddock everything.
280 if $(IFBUILDABLE) $* && [ -d $*/dist/doc/html/*/src/ ]; then cp hscolour.css $*/dist/doc/html/*/src/; fi
281 endif
282
283 .PHONY: maintainer-clean distclean clean clean.library.%
284
285 maintainer-clean: clean
286 distclean: clean
287
288 clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
289 -cd filepath && $(CABAL) clean --distpref=dist-bootstrapping
290 -cd Cabal && $(CABAL) clean --distpref=dist-bootstrapping
291 -cd hpc && $(CABAL) clean --distpref=dist-bootstrapping
292 $(RM) -rf bootstrapping
293 $(RM) -f bootstrapping.conf bootstrapping.conf.old
294 $(RM) -f bootstrapping.conf.tmp bootstrapping.conf.tmp.old
295 $(RM) -f cabal-bin cabal-bin.exe
296 $(RM) -rf ifBuildable
297 $(RM) -f libraries.txt index.html doc-index.html doc-index*.html
298 $(RM) -f haddock* *.gif
299 $(RM) -rf stamp/*
300 ifneq "$(wildcard dph)" ""
301 $(MAKE) -C dph clean
302 endif
303
304 maintainer-clean distclean:
305 $(RM) $(foreach lib, $(SUBDIRS), $(lib)/.depend $(lib)/.depend.bak)
306
307 $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
308 clean.library.%:
309 $(RM) -f stamp/configure.library.*.$* $*/unbuildable
310 -cd $* && $(CABAL) clean
311 $(RM) -f $*/Setup $*/Setup.exe $*/Setup.hi $*/Setup.o
312 $(RM) $*/GNUmakefile $*/Makefile.local
313 endif
314
315 # -----------------------------------------------------------------------------
316
317 .PHONY: install install-docs install.library.%
318
319 install: $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR))
320 ifeq "$(HADDOCK_DOCS)" "YES"
321 $(INSTALL_DIR) $(DESTDIR)$(html_installed_root)
322 $(INSTALL_DATA) index.html doc-index*.html $(DESTDIR)$(html_installed_root)
323 $(INSTALL_SCRIPT) gen_contents_index $(DESTDIR)$(html_installed_root)
324 $(INSTALL_DATA) prologue.txt $(DESTDIR)$(html_installed_root)
325 # Hacks:
326 $(INSTALL_DATA) base/dist/doc/html/*/*.css $(DESTDIR)$(html_installed_root)
327 $(INSTALL_DATA) base/dist/doc/html/*/*.js $(DESTDIR)$(html_installed_root)
328 $(INSTALL_DATA) base/dist/doc/html/*/*.gif $(DESTDIR)$(html_installed_root)
329 endif
330
331 # Cabal doesn't let us ask to install docs only, so do nothing here
332 install-docs:
333 @:
334
335 # Ideally this would depend on a stamp/build.library.%, but if it does
336 # then we can't change the libraries and then just rerun make.
337 # Thus if you install without building then it will just break.
338
339 # prefix and (on Windows) htmldir use $topdir when configuring, so we
340 # need to tell installPackage the real path to use when installing.
341
342 # We also need to pass all the other directories in, as they can be
343 # overridden when installing a bindist.
344
345 $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
346 install.library.%: ifBuildable/ifBuildable
347 if $(IFBUILDABLE) $*; then \
348 cd $* && \
349 $(INSTALL_PACKAGE) install '$(GHC_PKG_INSTALL_PROG)' '$(DESTDIR)$(datadir)/package.conf' '$(DESTDIR)' '$(prefix)' '$(iprefix)' '$(ibindir)' '$(ilibdir)' '$(ilibexecdir)' '$(idynlibdir)' '$(idatadir)' '$(idocdir)' '$(ihtmldir)' '$(ihaddockdir)' ; \
350 fi
351
352 .PHONY: binary-dist binary-dist.library.%
353
354 BIN_DIST_LIBDIR=$(BIN_DIST_DIR)/libraries
355
356 binary-dist: $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR))
357 ifeq "$(WHERE_AM_I)" ""
358 echo "I don't know where I am" >&2
359 exit 1
360 endif
361 echo $(WHERE_AM_I)/Makefile >> $(BIN_DIST_LIST)
362 # XXX This needs to be changed: This ifBuildable is built with the
363 # bootstrapping compiler, so isn't OS X friendly. It should be made into
364 # a Cabal package if we keep it. However, once we drop extralibs we can
365 # probably remove it anyway.
366 echo $(WHERE_AM_I)/ifBuildable/ifBuildable >> $(BIN_DIST_LIST)
367 for FILE in dph/dph-prim-interface/interface/*.h dph/dph/LICENSE; do if [ -f $$FILE ]; then echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); fi; done
368 ifeq "$(HADDOCK_DOCS)" "YES"
369 for FILE in gen_contents_index prologue index.html doc-index*.html; do echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); done
370 endif
371
372 $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \
373 binary-dist.library.%:
374 if $(IFBUILDABLE) $*; then \
375 $(MAKE) -C $* -f Makefile.local binary-dist BINDIST_EXTRAS="$*.cabal LICENSE $*.buildinfo unbuildable" WHERE_AM_I=$(WHERE_AM_I)/$*; \
376 fi
377
378 # Ignore some doc targets that we don't support
379 # The root recurses into us when these targets are made
380 .PHONY: html-no-chunks chm HxS fo dvi ps pdf
381 html-no-chunks chm HxS fo dvi ps pdf:
382 @:
383