← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Robert Collins
  • Date: 2006-07-20 13:00:31 UTC
  • mto: (1852.9.1 Tree.compare().)
  • mto: This revision was merged to the branch mainline in revision 1890.
  • Revision ID: robertc@robertcollins.net-20060720130031-d26103a427ea10f3
Start tree implementation tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
 
# building documentation, etc.
19
 
 
20
 
 
21
 
### Core Stuff ###
22
 
 
23
 
PYTHON=python
24
 
PYTHON24=python24
25
 
PYTHON25=python25
26
 
PYTHON26=python26
27
 
BZR_TARGET=release
28
 
PLUGIN_TARGET=plugin-release
29
 
PYTHON_BUILDFLAGS=
30
 
 
31
 
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
32
 
 
33
 
all: extensions
34
 
 
35
 
extensions:
36
 
        @echo "building extension modules."
37
 
        $(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
38
 
 
39
 
check: docs check-nodocs
40
 
 
41
 
check-nodocs: extensions
42
 
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
 
1
all:
 
2
 
 
3
check:
 
4
        ./bzr selftest -v $(tests)
 
5
        @echo "Running all tests with no locale."
 
6
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
 
7
 
 
8
check-msgeditor:
 
9
        ./bzr --no-plugins selftest -v msgeditor
43
10
 
44
11
# Run Python style checker (apt-get install pyflakes)
45
 
#
46
 
# Note that at present this gives many false warnings, because it doesn't
47
 
# know about identifiers loaded through lazy_import.
48
12
pyflakes:
49
13
        pyflakes bzrlib
50
14
 
54
18
        pyflakes bzrlib | grep -v ' imported but unused'
55
19
 
56
20
clean:
57
 
        $(PYTHON) setup.py clean
58
 
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
59
 
 
60
 
# Build API documentation
61
 
docfiles = bzr bzrlib
62
 
api-docs:
63
 
        mkdir -p api/html
64
 
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
65
 
check-api-docs:
66
 
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
67
 
 
68
 
# build tags for emacs and vim
69
 
TAGS:
70
 
        ctags -R -e bzrlib
71
 
 
72
 
tags:
73
 
        ctags -R bzrlib
74
 
 
75
 
# these are treated as phony so they'll always be rebuilt - it's pretty quick
76
 
.PHONY: TAGS tags
77
 
 
78
 
 
79
 
### Documentation ###
80
 
 
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
199
 
 
200
 
# translate txt docs to html
201
 
derived_txt_files = \
202
 
        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 \
215
 
        $(wildcard doc/es/guia-usario/*.txt) \
216
 
        $(derived_txt_files) \
217
 
        doc/en/upgrade-guide/index.txt \
218
 
        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 = \
230
 
       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 $@
285
 
 
286
 
doc/developers/%.html: doc/developers/%.txt
287
 
        $(rst2html) --stylesheet=../default.css $< $@
288
 
 
289
 
doc/index.html: doc/index.txt
290
 
        $(rst2html) --stylesheet=default.css $< $@
291
 
 
292
 
doc/index.%.html: doc/index.%.txt
293
 
        $(rst2html) --stylesheet=default.css $< $@
294
 
 
295
 
%.html: %.txt
296
 
        $(rst2html) --stylesheet=../../default.css $< $@
297
 
 
298
 
doc/en/release-notes/NEWS.txt: NEWS
299
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
300
 
 
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) 
307
 
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
308
 
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
309
 
 
310
 
# the main target to build all the docs
311
 
docs-plain: $(ALL_DOCS)
312
 
 
313
 
# produce a tree containing just the final docs, ready for uploading to the web
314
 
HTMLDIR = html_docs
315
 
html-plain: docs-plain
316
 
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
317
 
 
318
 
# clean produced docs
319
 
clean-plain:
320
 
        $(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 $@"
331
 
 
332
 
 
333
 
### Windows Support ###
334
 
 
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
 
# make bzr.exe for win32 with py2exe
364
 
exe:
365
 
        @echo *** Make bzr.exe
366
 
        $(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
367
 
        $(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
368
 
        $(PYTHON) setup.py py2exe > py2exe.log
369
 
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
370
 
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
371
 
 
372
 
# win32 installer for bzr.exe
373
 
installer: exe copy-docs
374
 
        @echo *** Make Windows installer
375
 
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
376
 
        iscc /Q tools/win32/bzr.iss
377
 
 
378
 
# win32 Python's distutils-based installer
379
 
# require to have Python interpreter installed on win32
380
 
py-inst-24: docs
381
 
        $(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
382
 
 
383
 
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
390
 
 
391
 
 
392
 
copy-docs: docs
393
 
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
394
 
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
395
 
 
396
 
# clean on win32 all installer-related files and directories
397
 
clean-win32: clean-docs
398
 
        $(PYTHON) tools/win32/ostools.py remove build
399
 
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
400
 
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
401
 
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
402
 
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
403
 
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
404
 
        $(PYTHON) tools/win32/ostools.py remove dist
405
 
 
406
 
 
407
 
### Packaging Targets ###
408
 
 
409
 
.PHONY: dist check-dist-tarball
410
 
 
411
 
# build a distribution source tarball
412
 
#
413
 
# this method of copying the pyrex generated files is a bit ugly; it would be
414
 
# nicer to generate it from distutils.
415
 
dist: 
416
 
        version=`./bzr version --short` && \
417
 
        echo Building distribution of bzr $$version && \
418
 
        expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
419
 
        expdir=$$expbasedir/bzr-$$version && \
420
 
        tarball=$$PWD/../bzr-$$version.tar.gz && \
421
 
        $(MAKE) clean && \
422
 
        $(MAKE) && \
423
 
        bzr export $$expdir && \
424
 
        cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
425
 
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
426
 
        gpg --detach-sign $$tarball && \
427
 
        rm -rf $$expbasedir
428
 
 
429
 
# run all tests in a previously built tarball
430
 
check-dist-tarball:
431
 
        tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
432
 
        version=`./bzr version --short` && \
433
 
        tarball=$$PWD/../bzr-$$version.tar.gz && \
434
 
        tar Cxz $$tmpdir -f $$tarball && \
435
 
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
436
 
        rm -rf $$tmpdir
 
21
        ./setup.py clean
 
22
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
 
23
        rm -rf test????.tmp
 
24
 
 
25
.PHONY: all
 
26
 
 
27
 
 
28
# build emacs cross-reference
 
29
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
 
30
TAGS: $(tag_files)
 
31
        ctags-exuberant -e $(tag_files)
 
32
 
 
33
tutorial.html: tutorial.txt
 
34
        rest2html tutorial.txt > tutorial.html