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