8
find . -name "*.pyc" | xargs rm
14
# build emacs cross-reference
15
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
17
ctags-exuberant -e $(tag_files)
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
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.
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.
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
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
# building documentation, etc.
28
PLUGIN_TARGET=plugin-release
31
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
36
@echo "building extension modules."
37
$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
39
check: docs check-nodocs
41
check-nodocs: extensions
42
$(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
43
@echo "Running all tests with no locale."
44
LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
46
# Run Python style checker (apt-get install pyflakes)
48
# Note that at present this gives many false warnings, because it doesn't
49
# know about identifiers loaded through lazy_import.
54
# There are many of these warnings at the moment and they're not a
55
# high priority to fix
56
pyflakes bzrlib | grep -v ' imported but unused'
59
$(PYTHON) setup.py clean
60
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
62
# Build API documentation
66
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
68
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
70
# build tags for emacs and vim
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
83
# Default to plain documentation for maximum backwards compatibility.
84
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
88
clean-docs: clean-plain
93
### Man-page Documentation ###
95
MAN_DEPENDENCIES = bzrlib/builtins.py \
96
$(wildcard bzrlib/*.py) \
97
$(wildcard bzrlib/*/*.py) \
98
tools/generate_docs.py \
99
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
101
MAN_PAGES = man1/bzr.1
102
man1/bzr.1: $(MAN_DEPENDENCIES)
103
$(PYTHON) tools/generate_docs.py -o $@ man
106
### Sphinx-style Documentation ###
108
# Build the documentation. To keep the dependencies down to a minimum
109
# for distro packagers, we only build the html documentation by default.
110
# Sphinx 0.6 or later is preferred for the best rendering, though
111
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
112
# for installation instructions.
113
docs-sphinx: html-sphinx
115
# Clean out generated documentation
117
cd doc/en && make clean
118
cd doc/es && make clean
119
cd doc/ru && make clean
120
cd doc/developers && make clean
122
SPHINX_DEPENDENCIES = \
123
doc/en/release-notes/index.txt \
124
doc/en/user-reference/index.txt \
129
doc/developers/Makefile \
130
doc/developers/make.bat
132
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
133
$(PYTHON) tools/generate_docs.py -o $@ rstx
135
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
136
$(PYTHON) tools/generate_release_notes.py NEWS $@
138
doc/%/Makefile: doc/en/Makefile
139
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
141
doc/%/make.bat: doc/en/make.bat
142
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
144
# Build the html docs using Sphinx.
145
html-sphinx: $(SPHINX_DEPENDENCIES)
146
cd doc/en && make html
147
cd doc/es && make html
148
cd doc/ru && make html
149
cd doc/developers && make html
151
# Build the PDF docs using Sphinx. This requires numerous LaTeX
152
# packages. See http://sphinx.pocoo.org/builders.html for details.
153
# Note: We don't currently build PDFs for the Russian docs because
154
# they require additional packages to be installed (to handle
155
# Russian hyphenation rules, etc.)
156
pdf-sphinx: $(SPHINX_DEPENDENCIES)
157
cd doc/en && make latex
158
cd doc/es && make latex
159
cd doc/developers && make latex
160
cd doc/en/_build/latex && make all-pdf
161
cd doc/es/_build/latex && make all-pdf
162
cd doc/developers/_build/latex && make all-pdf
164
# Build the CHM (Windows Help) docs using Sphinx.
165
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
166
# to generate the final chm files.
167
chm-sphinx: $(SPHINX_DEPENDENCIES)
168
cd doc/en && make htmlhelp
169
cd doc/es && make htmlhelp
170
cd doc/ru && make htmlhelp
171
cd doc/developers && make htmlhelp
174
### Documentation Website ###
176
# Where to build the website
177
DOC_WEBSITE_BUILD = build_doc_website
179
# Build and package docs into a website, complete with downloads.
180
doc-website: html-sphinx pdf-sphinx
181
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
182
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
183
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
184
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
187
### Plain Documentation ###
189
# While Sphinx is the preferred tool for building documentation, we still
190
# support our "plain" html documentation so that Sphinx is not a hard
191
# dependency for packagers on older platforms.
193
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
195
# translate txt docs to html
196
derived_txt_files = \
197
doc/en/user-reference/bzr_man.txt \
198
doc/en/release-notes/NEWS.txt
200
doc/en/tutorials/tutorial.txt \
201
doc/en/tutorials/using_bazaar_with_launchpad.txt \
202
doc/en/tutorials/centralized_workflow.txt \
203
$(wildcard doc/es/tutorials/*.txt) \
204
$(wildcard doc/ru/tutorials/*.txt) \
205
$(wildcard doc/*/mini-tutorial/index.txt) \
206
$(wildcard doc/*/user-guide/index-plain.txt) \
207
$(wildcard doc/es/guia-usario/*.txt) \
208
$(derived_txt_files) \
209
doc/en/upgrade-guide/index.txt \
211
$(wildcard doc/index.*.txt)
213
doc/en/user-guide/index.txt \
214
doc/es/user-guide/index.txt \
215
doc/ru/user-guide/index.txt
216
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
217
htm_files = $(patsubst %.txt, %.html, $(txt_files))
221
$(wildcard doc/*/bzr-en-quick-reference.svg) \
222
$(wildcard doc/*/bzr-en-quick-reference.png) \
223
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
224
$(wildcard doc/*/bzr-es-quick-reference.svg) \
225
$(wildcard doc/*/bzr-es-quick-reference.png) \
226
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
227
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
228
$(wildcard doc/*/bzr-ru-quick-reference.png) \
229
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
230
$(wildcard doc/*/user-guide/images/*.png)
232
# doc/developers/*.txt files that should *not* be individually
235
doc/developers/add.txt \
236
doc/developers/annotate.txt \
237
doc/developers/bundle-creation.txt \
238
doc/developers/commit.txt \
239
doc/developers/diff.txt \
240
doc/developers/directory-fingerprints.txt \
241
doc/developers/gc.txt \
242
doc/developers/implementation-notes.txt \
243
doc/developers/incremental-push-pull.txt \
244
doc/developers/index.txt \
245
doc/developers/initial-push-pull.txt \
246
doc/developers/merge-scaling.txt \
247
doc/developers/miscellaneous-notes.txt \
248
doc/developers/missing.txt \
249
doc/developers/performance-roadmap-rationale.txt \
250
doc/developers/performance-use-case-analysis.txt \
251
doc/developers/planned-change-integration.txt \
252
doc/developers/planned-performance-changes.txt \
253
doc/developers/plans.txt \
254
doc/developers/process.txt \
255
doc/developers/revert.txt \
256
doc/developers/specifications.txt \
257
doc/developers/status.txt \
258
doc/developers/uncommit.txt
260
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
261
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
262
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
264
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
265
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
267
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
268
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
270
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
271
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
273
doc/developers/%.html: doc/developers/%.txt
274
$(rst2html) --stylesheet=../default.css $< $@
276
doc/index.html: doc/index.txt
277
$(rst2html) --stylesheet=default.css $< $@
279
doc/index.%.html: doc/index.%.txt
280
$(rst2html) --stylesheet=default.css $< $@
283
$(rst2html) --stylesheet=../../default.css $< $@
285
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
286
$(PYTHON) tools/generate_docs.py -o $@ rstx
288
doc/en/release-notes/NEWS.txt: NEWS
289
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
291
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
293
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
294
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
296
derived_web_docs = $(htm_files) $(dev_htm_files)
297
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
298
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
300
# the main target to build all the docs
301
docs-plain: $(ALL_DOCS)
303
# produce a tree containing just the final docs, ready for uploading to the web
305
html-plain: docs-plain
306
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
308
# clean produced docs
310
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
311
$(HTMLDIR) $(derived_txt_files)
314
### Miscellaneous Documentation Targets ###
316
# build a png of our performance task list
317
# this is no longer built by default; you can build it if you want to look at it
318
doc/developers/performance.png: doc/developers/performance.dot
320
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
323
### Windows Support ###
325
# make all the installers completely from scratch, using zc.buildout
326
# to fetch the dependencies
327
# These are files that need to be copied into the build location to boostrap
329
# Note that the path is relative to tools/win32
330
BUILDOUT_FILES = buildout.cfg \
331
buildout-templates/bin/build-installer.bat.in \
332
ostools.py bootstrap.py
335
@echo Make all the installers from scratch
336
@# Build everything in a separate directory, to avoid cluttering the WT
337
$(PYTHON) tools/win32/ostools.py makedir build-win32
338
@# cd to tools/win32 so that the relative paths are copied correctly
339
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
340
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
341
@# existing release directories, so delete them manually before building
342
@# It means things may be rebuilt that don't need to be, but at least
343
@# it will be correct when they do.
344
cd build-win32 && $(PYTHON) ostools.py remove release */release
345
cd build-win32 && $(PYTHON) bootstrap.py
346
cd build-win32 && bin/buildout
347
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
351
$(PYTHON) tools/win32/ostools.py remove build-win32
353
# make bzr.exe for win32 with py2exe
355
@echo *** Make bzr.exe
356
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
357
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
358
$(PYTHON) setup.py py2exe > py2exe.log
359
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
360
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
362
# win32 installer for bzr.exe
363
installer: exe copy-docs
364
@echo *** Make Windows installer
365
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
366
iscc /Q tools/win32/bzr.iss
368
# win32 Python's distutils-based installer
369
# require to have Python interpreter installed on win32
371
$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
374
$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
377
$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
379
python-installer: py-inst-24 py-inst-25 py-inst-26
383
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
384
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
386
# clean on win32 all installer-related files and directories
387
clean-win32: clean-docs
388
$(PYTHON) tools/win32/ostools.py remove build
389
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
390
$(PYTHON) tools/win32/ostools.py remove py2exe.log
391
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
392
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
393
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
394
$(PYTHON) tools/win32/ostools.py remove dist
397
### Packaging Targets ###
399
.PHONY: dist dist-upload-escudero check-dist-tarball
401
# build a distribution tarball and zip file.
403
# this method of copying the pyrex generated files is a bit ugly; it would be
404
# nicer to generate it from distutils.
406
version=`./bzr version --short` && \
407
echo Building distribution of bzr $$version && \
408
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
409
expdir=$$expbasedir/bzr-$$version && \
410
tarball=$$PWD/../bzr-$$version.tar.gz && \
411
zipball=$$PWD/../bzr-$$version.zip && \
414
bzr export $$expdir && \
415
cp bzrlib/*.c $$expdir/bzrlib/. && \
416
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
417
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
418
gpg --detach-sign $$tarball && \
419
gpg --detach-sign $$zipball && \
422
# run all tests in a previously built tarball
424
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
425
version=`./bzr version --short` && \
426
tarball=$$PWD/../bzr-$$version.tar.gz && \
427
tar Cxz $$tmpdir -f $$tarball && \
428
$(MAKE) -C $$tmpdir/bzr-$$version check && \
432
# upload previously built tarball to the download directory on bazaar-vcs.org,
433
# and verify that it can be downloaded ok.
434
dist-upload-escudero:
435
version=`./bzr version --short` && \
436
tarball=../bzr-$$version.tar.gz && \
437
zipball=../bzr-$$version.zip && \
438
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
439
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
441
echo verifying over http... && \
442
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
443
| diff -s - $$zipball && \
444
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
445
| diff -s - $$zipball.sig
446
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
447
| diff -s - $$tarball && \
448
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
449
| diff -s - $$tarball.sig
added
removed
Makefile
