← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Mark Hammond
  • Date: 2008-08-10 11:16:39 UTC
  • mto: (3606.5.3 1.6)
  • mto: This revision was merged to the branch mainline in revision 3626.
  • Revision ID: mhammond@skippinet.com.au-20080810111639-9upz1wig1s8lvz62
install all files with 'restartreplace uninsrestartdelete' and close
tbzrcache at uninstall time.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
18
# building documentation, etc.
21
21
### Core Stuff ###
22
22
 
23
23
PYTHON=python
24
 
PYTHON24=python24
25
 
PYTHON25=python25
26
 
PYTHON26=python26
27
 
BZR_TARGET=release
28
 
PLUGIN_TARGET=plugin-release
29
24
PYTHON_BUILDFLAGS=
30
25
 
31
 
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
 
26
.PHONY: all clean extensions pyflakes api-docs
32
27
 
33
28
all: extensions
34
29
 
36
31
        @echo "building extension modules."
37
32
        $(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
38
33
 
39
 
check: docs check-nodocs
40
 
 
41
 
check-nodocs: extensions
 
34
check: docs extensions
42
35
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
 
36
        @echo "Running all tests with no locale."
 
37
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
43
38
 
44
39
# Run Python style checker (apt-get install pyflakes)
45
40
#
75
70
# these are treated as phony so they'll always be rebuilt - it's pretty quick
76
71
.PHONY: TAGS tags
77
72
 
78
 
 
79
73
### Documentation ###
80
74
 
81
 
# Default to plain documentation for maximum backwards compatibility.
82
 
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
83
 
 
84
 
docs: docs-plain
85
 
 
86
 
clean-docs: clean-plain
87
 
 
88
 
html-docs: html-plain
89
 
 
90
 
 
91
 
### Man-page Documentation ###
92
 
 
93
 
MAN_DEPENDENCIES = bzrlib/builtins.py \
94
 
        $(wildcard bzrlib/*.py) \
95
 
        $(wildcard bzrlib/*/*.py) \
96
 
        tools/generate_docs.py \
97
 
        $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
98
 
 
99
 
MAN_PAGES = man1/bzr.1
100
 
man1/bzr.1: $(MAN_DEPENDENCIES)
101
 
        $(PYTHON) tools/generate_docs.py -o $@ man
102
 
 
103
 
 
104
 
### Sphinx-style Documentation ###
105
 
 
106
 
# Build the documentation. To keep the dependencies down to a minimum
107
 
# for distro packagers, we only build the html documentation by default.
108
 
# Sphinx 0.6 or later is preferred for the best rendering, though
109
 
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
110
 
# for installation instructions.
111
 
docs-sphinx: html-sphinx
112
 
 
113
 
# Clean out generated documentation
114
 
clean-sphinx:
115
 
        cd doc/en && make clean
116
 
        cd doc/es && make clean
117
 
        cd doc/ja && make clean
118
 
        cd doc/ru && make clean
119
 
        cd doc/developers && make clean
120
 
 
121
 
SPHINX_DEPENDENCIES = \
122
 
        doc/en/release-notes/index.txt \
123
 
        doc/en/user-reference/index.txt \
124
 
        doc/es/Makefile \
125
 
        doc/es/make.bat \
126
 
        doc/ja/Makefile \
127
 
        doc/ja/make.bat \
128
 
        doc/ru/Makefile \
129
 
        doc/ru/make.bat \
130
 
        doc/developers/Makefile \
131
 
        doc/developers/make.bat
132
 
 
133
 
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
134
 
        $(PYTHON) tools/generate_docs.py -o $@ rstx
135
 
 
136
 
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
137
 
        $(PYTHON) tools/generate_release_notes.py NEWS $@
138
 
 
139
 
doc/%/Makefile: doc/en/Makefile
140
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
141
 
 
142
 
doc/%/make.bat: doc/en/make.bat
143
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
144
 
 
145
 
# Build the html docs using Sphinx.
146
 
html-sphinx: $(SPHINX_DEPENDENCIES)
147
 
        cd doc/en && make html
148
 
        cd doc/es && make html
149
 
        cd doc/ru && make html
150
 
        cd doc/ja && make html
151
 
        cd doc/developers && make html
152
 
 
153
 
# Build the PDF docs using Sphinx. This requires numerous LaTeX
154
 
# packages. See http://sphinx.pocoo.org/builders.html for details.
155
 
# Note: We don't currently build PDFs for the Russian docs because
156
 
# they require additional packages to be installed (to handle
157
 
# Russian hyphenation rules, etc.)
158
 
pdf-sphinx: $(SPHINX_DEPENDENCIES)
159
 
        cd doc/en && make latex
160
 
        cd doc/es && make latex
161
 
        cd doc/ja && make latex
162
 
        cd doc/developers && make latex
163
 
        cd doc/en/_build/latex && make all-pdf
164
 
        cd doc/es/_build/latex && make all-pdf
165
 
        cd doc/developers/_build/latex && make all-pdf
166
 
 
167
 
# Build the CHM (Windows Help) docs using Sphinx.
168
 
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
169
 
# to generate the final chm files.
170
 
chm-sphinx: $(SPHINX_DEPENDENCIES)
171
 
        cd doc/en && make htmlhelp
172
 
        cd doc/es && make htmlhelp
173
 
        cd doc/ru && make htmlhelp
174
 
        cd doc/ja && make htmlhelp
175
 
        cd doc/developers && make htmlhelp
176
 
 
177
 
 
178
 
### Documentation Website ###
179
 
 
180
 
# Where to build the website
181
 
DOC_WEBSITE_BUILD = build_doc_website
182
 
 
183
 
# Build and package docs into a website, complete with downloads.
184
 
doc-website: html-sphinx pdf-sphinx
185
 
        $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
186
 
        $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
187
 
        $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
188
 
        $(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
189
 
        $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
190
 
 
191
 
 
192
 
### Plain Documentation ###
193
 
 
194
 
# While Sphinx is the preferred tool for building documentation, we still
195
 
# support our "plain" html documentation so that Sphinx is not a hard
196
 
# dependency for packagers on older platforms.
197
 
 
198
 
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
75
# set PRETTY to get docs that look like the Bazaar web site
 
76
ifdef PRETTY
 
77
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
78
else
 
79
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
80
endif
199
81
 
200
82
# translate txt docs to html
201
 
derived_txt_files = \
 
83
derived_txt_files := \
 
84
        doc/en/user-reference/bzr_man.txt \
 
85
        doc/en/developer-guide/HACKING.txt \
202
86
        doc/en/release-notes/NEWS.txt
203
 
txt_all = \
204
 
        doc/en/tutorials/tutorial.txt \
205
 
        doc/en/tutorials/using_bazaar_with_launchpad.txt \
206
 
        doc/en/tutorials/centralized_workflow.txt \
207
 
        $(wildcard doc/es/tutorials/*.txt) \
208
 
                $(wildcard doc/ru/tutorials/*.txt) \
209
 
        doc/ja/tutorials/tutorial.txt \
210
 
        doc/ja/tutorials/using_bazaar_with_launchpad.txt \
211
 
        doc/ja/tutorials/centralized_workflow.txt \
212
 
        $(wildcard doc/*/mini-tutorial/index.txt) \
213
 
        $(wildcard doc/*/user-guide/index-plain.txt) \
214
 
        doc/en/admin-guide/index-plain.txt \
 
87
txt_files := $(wildcard doc/en/tutorials/*.txt) \
 
88
        $(derived_txt_files) \
 
89
        doc/en/user-guide/index.txt \
 
90
        doc/en/mini-tutorial/index.txt \
215
91
        $(wildcard doc/es/guia-usario/*.txt) \
216
 
        $(derived_txt_files) \
217
 
        doc/en/upgrade-guide/index.txt \
 
92
        doc/es/mini-tutorial/index.txt \
218
93
        doc/index.txt \
219
 
        $(wildcard doc/index.*.txt)
220
 
txt_nohtml = \
221
 
        doc/en/user-guide/index.txt \
222
 
        doc/es/user-guide/index.txt \
223
 
        doc/ja/user-guide/index.txt \
224
 
        doc/ru/user-guide/index.txt \
225
 
        doc/en/admin-guide/index.txt
226
 
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
227
 
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
228
 
 
229
 
non_txt_files = \
 
94
        doc/index.es.txt
 
95
non_txt_files := \
230
96
       doc/default.css \
231
 
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
232
 
       $(wildcard doc/*/bzr-en-quick-reference.png) \
233
 
       $(wildcard doc/*/bzr-en-quick-reference.pdf) \
234
 
       $(wildcard doc/*/bzr-es-quick-reference.svg) \
235
 
       $(wildcard doc/*/bzr-es-quick-reference.png) \
236
 
       $(wildcard doc/*/bzr-es-quick-reference.pdf) \
237
 
       $(wildcard doc/*/bzr-ru-quick-reference.svg) \
238
 
       $(wildcard doc/*/bzr-ru-quick-reference.png) \
239
 
       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \
240
 
       $(wildcard doc/*/user-guide/images/*.png)
241
 
 
242
 
# doc/developers/*.txt files that should *not* be individually
243
 
# converted to HTML
244
 
dev_txt_nohtml = \
245
 
        doc/developers/add.txt \
246
 
        doc/developers/annotate.txt \
247
 
        doc/developers/bundle-creation.txt \
248
 
        doc/developers/commit.txt \
249
 
        doc/developers/diff.txt \
250
 
        doc/developers/directory-fingerprints.txt \
251
 
        doc/developers/gc.txt \
252
 
        doc/developers/implementation-notes.txt \
253
 
        doc/developers/incremental-push-pull.txt \
254
 
        doc/developers/index.txt \
255
 
        doc/developers/initial-push-pull.txt \
256
 
        doc/developers/merge-scaling.txt \
257
 
        doc/developers/miscellaneous-notes.txt \
258
 
        doc/developers/missing.txt \
259
 
        doc/developers/performance-roadmap-rationale.txt \
260
 
        doc/developers/performance-use-case-analysis.txt \
261
 
        doc/developers/planned-change-integration.txt \
262
 
        doc/developers/planned-performance-changes.txt \
263
 
        doc/developers/plans.txt \
264
 
        doc/developers/process.txt \
265
 
        doc/developers/revert.txt \
266
 
        doc/developers/specifications.txt \
267
 
        doc/developers/status.txt \
268
 
        doc/developers/uncommit.txt
269
 
 
270
 
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
271
 
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
272
 
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
273
 
 
274
 
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
275
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
276
 
 
277
 
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 
278
 
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
279
 
#
280
 
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
281
 
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
282
 
#
283
 
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide)) 
284
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
 
97
       doc/en/quick-reference/quick-start-summary.svg \
 
98
       doc/en/quick-reference/quick-start-summary.png \
 
99
       doc/en/quick-reference/quick-start-summary.pdf \
 
100
       $(wildcard doc/en/user-guide/images/*.png) \
 
101
       doc/es/referencia-rapida/referencia-rapida.svg \
 
102
       doc/es/referencia-rapida/referencia-rapida.png \
 
103
       doc/es/referencia-rapida/referencia-rapida.pdf \
 
104
       $(wildcard doc/es/guia-usuario/images/*.png)
 
105
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
 
106
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
 
107
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
108
 
 
109
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
 
110
        $(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
285
111
 
286
112
doc/developers/%.html: doc/developers/%.txt
287
113
        $(rst2html) --stylesheet=../default.css $< $@
289
115
doc/index.html: doc/index.txt
290
116
        $(rst2html) --stylesheet=default.css $< $@
291
117
 
292
 
doc/index.%.html: doc/index.%.txt
293
 
        $(rst2html) --stylesheet=default.css $< $@
294
 
 
295
118
%.html: %.txt
296
119
        $(rst2html) --stylesheet=../../default.css $< $@
297
120
 
 
121
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
122
                 bzrlib/bundle/commands.py \
 
123
                 bzrlib/conflicts.py \
 
124
                 bzrlib/help_topics/__init__.py \
 
125
                 bzrlib/sign_my_commits.py \
 
126
                 bzrlib/bugtracker.py \
 
127
                 generate_docs.py \
 
128
                 tools/doc_generate/__init__.py \
 
129
                 tools/doc_generate/autodoc_man.py \
 
130
                 tools/doc_generate/autodoc_rstx.py \
 
131
                 $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
132
 
 
133
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
134
        $(PYTHON) generate_docs.py -o $@ rstx
 
135
 
 
136
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
137
        $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
138
 
298
139
doc/en/release-notes/NEWS.txt: NEWS
299
140
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
300
141
 
301
 
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
302
 
 
303
 
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
304
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
305
 
 
306
 
derived_web_docs = $(htm_files) $(dev_htm_files) 
 
142
MAN_PAGES = man1/bzr.1
 
143
man1/bzr.1: $(MAN_DEPENDENCIES)
 
144
        $(PYTHON) generate_docs.py -o $@ man
 
145
 
 
146
# build a png of our performance task list
 
147
doc/developers/performance.png: doc/developers/performance.dot
 
148
        @echo Generating $@
 
149
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
150
 
 
151
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
307
152
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
308
153
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
309
154
 
310
155
# the main target to build all the docs
311
 
docs-plain: $(ALL_DOCS)
 
156
docs: $(ALL_DOCS)
312
157
 
313
158
# produce a tree containing just the final docs, ready for uploading to the web
314
 
HTMLDIR = html_docs
315
 
html-plain: docs-plain
 
159
HTMLDIR := html_docs
 
160
html-docs: docs
316
161
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
317
162
 
318
163
# clean produced docs
319
 
clean-plain:
 
164
clean-docs:
320
165
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
321
 
            $(HTMLDIR) $(derived_txt_files)
322
 
 
323
 
 
324
 
### Miscellaneous Documentation Targets ###
325
 
 
326
 
# build a png of our performance task list
327
 
# this is no longer built by default; you can build it if you want to look at it
328
 
doc/developers/performance.png: doc/developers/performance.dot
329
 
        @echo Generating $@
330
 
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
166
        $(HTMLDIR) $(derived_txt_files)
331
167
 
332
168
 
333
169
### Windows Support ###
334
170
 
335
 
# make all the installers completely from scratch, using zc.buildout
336
 
# to fetch the dependencies
337
 
# These are files that need to be copied into the build location to boostrap
338
 
# the build process.
339
 
# Note that the path is relative to tools/win32
340
 
BUILDOUT_FILES = buildout.cfg \
341
 
        buildout-templates/bin/build-installer.bat.in \
342
 
        ostools.py bootstrap.py
343
 
 
344
 
installer-all:
345
 
        @echo Make all the installers from scratch
346
 
        @# Build everything in a separate directory, to avoid cluttering the WT
347
 
        $(PYTHON) tools/win32/ostools.py makedir build-win32
348
 
        @# cd to tools/win32 so that the relative paths are copied correctly
349
 
        cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
350
 
        @# There seems to be a bug in gf.release.bzr, It doesn't correctly update
351
 
        @# existing release directories, so delete them manually before building
352
 
        @# It means things may be rebuilt that don't need to be, but at least
353
 
        @# it will be correct when they do.
354
 
        cd build-win32 && $(PYTHON) ostools.py remove release */release
355
 
        cd build-win32 && $(PYTHON) bootstrap.py
356
 
        cd build-win32 && bin/buildout
357
 
        cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
358
 
 
359
 
 
360
 
clean-installer-all:
361
 
        $(PYTHON) tools/win32/ostools.py remove build-win32
362
 
 
363
171
# make bzr.exe for win32 with py2exe
364
172
exe:
365
173
        @echo *** Make bzr.exe
366
 
        $(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
367
174
        $(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
368
175
        $(PYTHON) setup.py py2exe > py2exe.log
369
176
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
371
178
 
372
179
# win32 installer for bzr.exe
373
180
installer: exe copy-docs
374
 
        @echo *** Make Windows installer
 
181
        @echo *** Make windows installer
375
182
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
376
183
        iscc /Q tools/win32/bzr.iss
377
184
 
378
185
# win32 Python's distutils-based installer
379
186
# require to have Python interpreter installed on win32
380
187
py-inst-24: docs
381
 
        $(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
188
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
382
189
 
383
190
py-inst-25: docs
384
 
        $(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
385
 
 
386
 
py-inst-26: docs
387
 
        $(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
388
 
 
389
 
python-installer: py-inst-24 py-inst-25 py-inst-26
 
191
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
192
 
 
193
python-installer: py-inst-24 py-inst-25
390
194
 
391
195
 
392
196
copy-docs: docs
403
207
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
404
208
        $(PYTHON) tools/win32/ostools.py remove dist
405
209
 
406
 
 
407
 
### Packaging Targets ###
408
 
 
409
210
.PHONY: dist dist-upload-escudero check-dist-tarball
410
211
 
411
 
# build a distribution source tarball
 
212
# build a distribution tarball.
412
213
#
413
214
# this method of copying the pyrex generated files is a bit ugly; it would be
414
215
# nicer to generate it from distutils.
 
216
#
 
217
# these are a bit ubuntu-specific.
415
218
dist: 
416
219
        version=`./bzr version --short` && \
417
220
        echo Building distribution of bzr $$version && \
421
224
        $(MAKE) clean && \
422
225
        $(MAKE) && \
423
226
        bzr export $$expdir && \
424
 
        cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
 
227
        cp bzrlib/*.c $$expdir/bzrlib/. && \
425
228
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
426
229
        gpg --detach-sign $$tarball && \
 
230
        echo $$tarball done. && \
427
231
        rm -rf $$expbasedir
428
232
 
429
233
# run all tests in a previously built tarball