Add instructions for adding a library to a build tree
[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 build.library.<package>
12 #
13 # or the following is equivalent:
14 #
15 #   make rebuild.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 build.library.foo
22
23 .PHONY: default_target
24
25 default_target: build
26
27 ifeq "$(IN_BIN_DIST)" "1"
28 include ../Makefile-vars
29 else
30 # Ideally we'd just include something to give us variables
31 # for paths and arguments to tools etc, and those set in mk/build.mk.
32 TOP=.
33 include $(TOP)/mk/boilerplate.mk
34 endif
35
36 SUBDIRS = base old-locale old-time directory process filepath pretty \
37           template-haskell readline Cabal random haskell98
38
39 ifeq "$(GhcLibsWithUnix)" "YES"
40 SUBDIRS += unix
41 endif
42 ifeq "$(Windows)" "YES"
43 SUBDIRS += $(wildcard Win32)
44 endif
45
46 # Set GhcBootLibs=YES from the command line to work with just the libraries
47 # needed to bootstrap GHC.
48 ifneq "$(GhcBootLibs)" "YES"
49 SUBDIRS += $(wildcard regex-base)
50 SUBDIRS += $(wildcard regex-posix)
51 SUBDIRS += $(wildcard regex-compat)
52 SUBDIRS += $(wildcard parsec)
53 SUBDIRS += $(wildcard haskell-src)
54 SUBDIRS += $(wildcard html)
55 SUBDIRS += $(wildcard network)
56 SUBDIRS += $(wildcard QuickCheck)
57 SUBDIRS += $(wildcard HUnit)
58 SUBDIRS += $(wildcard mtl)
59 SUBDIRS += $(wildcard fgl)
60 SUBDIRS += $(wildcard X11)
61 SUBDIRS += $(wildcard time)
62 ifeq "$(Windows)" "NO"
63 # HGL is not working on Win32, so omit it for now.  Better not to ship it
64 # at all than to ship a broken version.
65 SUBDIRS += $(wildcard HGL)
66 endif
67 SUBDIRS += $(wildcard OpenGL)
68 SUBDIRS += $(wildcard GLUT)
69 SUBDIRS += $(wildcard OpenAL)
70 SUBDIRS += $(wildcard ALUT)
71 SUBDIRS += $(wildcard stm)
72 SUBDIRS += $(wildcard xhtml)
73 SUBDIRS += $(wildcard cgi)
74 SUBDIRS += $(wildcard arrows)
75 ifeq "$(GhcLibsWithObjectIO)" "YES"
76 SUBDIRS += $(wildcard ObjectIO)
77 endif
78 SUBDIRS += $(wildcard parallel)
79 endif
80
81 # -----------------------------------------------------------------------------
82
83 empty=
84 space=$(empty) $(empty)
85
86 ifeq "$(Windows)" "YES"
87 dot_bat=.bat
88 else
89 dot_bat=
90 endif
91
92 CONFIGURE_OPTS =
93 CONFIGURE_STAMP_EXTRAS :=
94
95 ifneq "$(findstring $(space)p$(space), $(space)$(GhcLibWays)$(space))" ""
96 CONFIGURE_OPTS += --enable-library-profiling
97 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-profiling
98 endif
99
100 ifeq "$(SplitObjs)" "YES"
101 CONFIGURE_OPTS += --enable-split-objs
102 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-splitting
103 endif
104
105 BOOTSTRAP_LIBS = Cabal filepath
106 BOOTSTRAP_STAMPS = $(addprefix stamp/bootstrapping.,$(BOOTSTRAP_LIBS))
107 BOOTSTRAP_INC_1_UP = $(addprefix -i../bootstrapping.,$(BOOTSTRAP_LIBS))
108 BOOTSTRAP_INC_2_UP = $(addprefix -i../../bootstrapping.,$(BOOTSTRAP_LIBS))
109
110 .PHONY: subdirs
111
112 subdirs:
113         @echo $(SUBDIRS)
114
115 .PHONY: boot
116
117 boot: $(BOOTSTRAP_STAMPS) ifBuildable/ifBuildable \
118           $(foreach SUBDIR,$(SUBDIRS),$(SUBDIR)/setup/Setup) \
119           installPackage/installPackage
120
121 # We build the Setup program in a setup subdirectory to stop it trying
122 # to use bits of base and Cabal when we build those packages.
123 # This also makes it slightly easier to clean.
124
125 # We ought to be depending on %/Setup.*hs, but make makes that difficult.
126
127 $(foreach SUBDIR,$(SUBDIRS),$(SUBDIR)/setup/Setup): \
128 %/setup/Setup: $(BOOTSTRAP_STAMPS)
129         -$(RM) -rf $*/setup
130         mkdir $*/setup
131         $(CP) $*/Setup.*hs $*/setup
132         cd $*/setup && $(GHC) -Wall -cpp --make Setup.*hs -o Setup \
133                               $(BOOTSTRAP_INC_2_UP)
134
135 installPackage/installPackage: installPackage.hs $(BOOTSTRAP_STAMPS)
136         -$(RM) -rf installPackage
137         mkdir installPackage
138         $(CP) installPackage.hs installPackage/
139         cd installPackage && $(GHC) -Wall -cpp \
140                                     --make installPackage -o installPackage \
141                                     $(BOOTSTRAP_INC_1_UP)
142
143 ifBuildable/ifBuildable: ifBuildable.hs
144         -$(RM) -rf ifBuildable
145         mkdir ifBuildable
146         $(CP) ifBuildable.hs ifBuildable/
147         cd ifBuildable && $(GHC) -Wall --make ifBuildable -o ifBuildable
148
149 $(BOOTSTRAP_STAMPS): stamp/bootstrapping.%:
150         $(RM) -rf bootstrapping.$*
151         $(CP) -R $* bootstrapping.$*
152         $(FIND) bootstrapping.$* \( -name "*.o" -o -name "*.hi" \) \
153                                  -exec $(RM) -f {} \;
154         touch $@
155
156 .PHONY: all build configure
157
158 all: build
159
160 ifneq "$(NO_HADDOCK_DOCS)" "YES"
161 all: doc
162 endif
163
164 .PHONY: rebuild.library.%
165
166 $(foreach SUBDIR,$(SUBDIRS),rebuild.library.$(SUBDIR)):\
167 rebuild.library.%: clean.library.% build.library.%
168
169 build: $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR))
170 build: installPackage/installPackage
171
172 configure: $(foreach SUBDIR,$(SUBDIRS), \
173              stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR))
174
175 .PHONY: build.library.%
176
177 # We should depend on %/%.cabal here (and in other rules), but make
178 # makes that difficult.
179
180 $(foreach SUBDIR,$(SUBDIRS), \
181                   stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
182 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: %/setup/Setup
183         -$(RM) -f stamp/configure.library.*.$* $*/unbuildable
184         ( cd $* && setup/Setup configure \
185                    $(CONFIGURE_OPTS) \
186                    --prefix=$(prefix) \
187                    --with-compiler=../../compiler/ghc-inplace$(dot_bat) \
188                    --with-hc-pkg=../../utils/ghc-pkg/ghc-pkg-inplace$(dot_bat) \
189                    --with-hsc2hs=../../utils/hsc2hs/hsc2hs-inplace$(dot_bat) \
190                    --with-ld=$(LD) \
191                    --datasubdir=ghc \
192                    --haddock-args="--use-contents=../index.html \
193                                    --use-index=../doc-index.html" \
194                    $(addprefix --configure-option=,$(CONFIGURE_ARGS)) \
195                    --configure-option=--with-cc=$(CC) ) \
196               && touch $@ || touch $*/unbuildable
197 # We don't touch $@ if configure failed as we would prefer to try
198 # configuring it next time round, rather than assuming it'll still fail.
199 # This is particularly important for corelibs, where failure means the
200 # build dies!
201
202 $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
203 build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
204                  %/setup/Setup ifBuildable/ifBuildable
205         ifBuildable/ifBuildable $* setup/Setup build \
206                                         $(addprefix --ghc-option=,$(GhcLibHcOpts))
207         ifBuildable/ifBuildable $* setup/Setup register --inplace
208
209 $(foreach SUBDIR,$(SUBDIRS),$(SUBDIR)/CabalMakefile):\
210 %/CabalMakefile: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
211                  %/setup/Setup ifBuildable/ifBuildable
212         $(RM) $*/CabalMakefile
213         ifBuildable/ifBuildable $* setup/Setup makefile -f CabalMakefile \
214                                      $(addprefix --ghc-option=,$(GhcLibHcOpts))
215
216 .PHONY: doc
217
218 DOC_SUBDIRS = $(filter-out haskell98,$(SUBDIRS))
219
220 doc: $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR))
221         sh gen_contents_index
222
223 $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR)):\
224 doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
225                %/setup/Setup ifBuildable/ifBuildable
226         ifBuildable/ifBuildable $* setup/Setup haddock
227
228 .PHONY: install install-docs install.library.%
229
230 INSTALL_DIR=$(prefix)/share/ghc/doc/html/
231
232 install: $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR))
233 ifneq "$(NO_HADDOCK_DOCS)" "YES"
234         $(INSTALL_DATA)   index.html doc-index.html                       $(INSTALL_DIR)
235         $(INSTALL_SCRIPT) gen_contents_index                                      $(INSTALL_DIR)
236         # Hacks:
237         $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.css $(INSTALL_DIR)
238         $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.js  $(INSTALL_DIR)
239         $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.gif $(INSTALL_DIR)
240 endif
241
242 # Cabal doesn't let us ask to install docs only, so do nothing here
243 install-docs:
244         @:
245
246 # Ideally this would depend on a stamp/build.library.%, but if it does
247 # then we can't change the libraries and then just rerun make.
248 # Thus if you install without building then it will just break.
249 $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
250 install.library.%: installPackage/installPackage ifBuildable/ifBuildable
251         ifBuildable/ifBuildable $* ../installPackage/installPackage
252
253 .PHONY: binary-dist binary-dist.library.%
254
255 BIN_DIST_LIBDIR=$(BIN_DIST_DIR)/libraries
256
257 binary-dist: $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR))
258         mkdir                               $(BIN_DIST_LIBDIR)/installPackage
259         cp        installPackage/installPackage $(BIN_DIST_LIBDIR)/installPackage
260         cp    Makefile                      $(BIN_DIST_LIBDIR)
261         cp    gen_contents_index            $(BIN_DIST_LIBDIR)
262         cp    index.html                    $(BIN_DIST_LIBDIR)
263         cp    doc-index.html                $(BIN_DIST_LIBDIR)
264         cp -a stamp                         $(BIN_DIST_LIBDIR)
265
266 $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \
267 binary-dist.library.%:
268         $(MKDIRHIER) $(BIN_DIST_LIBDIR)/$*
269         ifBuildable/ifBuildable $* cp    $*.cabal      $(BIN_DIST_LIBDIR)/$*
270         ifBuildable/ifBuildable $* cp -a dist          $(BIN_DIST_LIBDIR)/$*
271         ifBuildable/ifBuildable $* $(FIND) $(BIN_DIST_LIBDIR)/$*/dist \
272              \( -name "*_split" -o -name "autogen" \) | xargs rm -rf
273         ifBuildable/ifBuildable $* $(FIND) $(BIN_DIST_LIBDIR)/$*/dist \
274              \( \( -name "*.o" -o -name "*.p_o" \) -a ! -name "HS*" \) \
275              -exec rm {} \;
276
277 .PHONY: distclean clean clean.library.%
278
279 distclean: clean
280
281 clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
282         $(RM) -f stamp/bootstrapping.*
283         $(RM) -rf bootstrapping.*
284         $(RM) -rf ifBuildable
285         $(RM) -f libraries.txt index.html doc-index.html
286
287 $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
288 clean.library.%:
289         $(RM) -f stamp/configure.library.*.$* $*/unbuildable
290         -cd $* && setup/Setup clean
291         $(RM) -rf $*/setup
292