1
# Copyright (C) 2005, 2006, 2007, 2008 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
82
# set PRETTY to get docs that look like the Bazaar web site
84
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
86
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
89
# translate txt docs to html
90
derived_txt_files := \
91
doc/en/user-reference/bzr_man.txt \
92
doc/en/release-notes/NEWS.txt
94
doc/en/tutorials/tutorial.txt \
95
doc/en/tutorials/using_bazaar_with_launchpad.txt \
96
doc/en/tutorials/centralized_workflow.txt \
97
$(wildcard doc/ru/tutorials/*.txt) \
98
$(wildcard doc/*/mini-tutorial/index.txt) \
99
$(wildcard doc/*/user-guide/index.txt) \
100
$(derived_txt_files) \
101
doc/en/developer-guide/HACKING.txt \
102
doc/en/upgrade-guide/index.txt \
103
$(wildcard doc/es/guia-usario/*.txt) \
104
doc/es/mini-tutorial/index.txt \
106
$(wildcard doc/index.*.txt)
109
$(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
110
$(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
111
$(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
112
$(wildcard doc/*/user-guide/images/*.png)
113
htm_files := $(patsubst %.txt, %.html, $(txt_files))
115
# doc/developers/*.txt files that should *not* be individually
118
doc/developers/add.txt \
119
doc/developers/annotate.txt \
120
doc/developers/bundle-creation.txt \
121
doc/developers/commit.txt \
122
doc/developers/diff.txt \
123
doc/developers/directory-fingerprints.txt \
124
doc/developers/gc.txt \
125
doc/developers/incremental-push-pull.txt \
126
doc/developers/initial-push-pull.txt \
127
doc/developers/merge-scaling.txt \
128
doc/developers/missing.txt \
129
doc/developers/performance-roadmap-rationale.txt \
130
doc/developers/performance-use-case-analysis.txt \
131
doc/developers/planned-change-integration.txt \
132
doc/developers/planned-performance-changes.txt \
133
doc/developers/revert.txt \
134
doc/developers/status.txt \
135
doc/developers/uncommit.txt
137
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
138
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
139
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
141
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
142
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
144
# Set the paper size for PDF files.
145
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
147
# TODO: Add generation for Russian PDF
148
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
150
# Copy and modify the RST sources, and convert SVG images to PDF
151
# files for use a images in the LaTeX-generated PDF.
152
# Then generate the PDF output from the modified RST sources.
153
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
154
mkdir -p doc/en/user-guide/latex_prepared
155
$(PYTHON) tools/prepare_for_latex.py \
156
--out-dir=doc/en/user-guide/latex_prepared \
157
--in-dir=doc/en/user-guide
158
cd doc/en/user-guide/latex_prepared && \
159
$(PYTHON) ../../../../tools/rst2pdf.py \
160
--documentoptions=10pt,$(PAPERSIZE)paper \
161
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
162
--strict --title="Bazaar User Guide" \
163
index.txt ../user-guide.$(PAPERSIZE).pdf
165
doc/developers/%.html: doc/developers/%.txt
166
$(rst2html) --stylesheet=../default.css $< $@
168
doc/index.html: doc/index.txt
169
$(rst2html) --stylesheet=default.css $< $@
171
doc/index.%.html: doc/index.%.txt
172
$(rst2html) --stylesheet=default.css $< $@
175
$(rst2html) --stylesheet=../../default.css $< $@
177
MAN_DEPENDENCIES = bzrlib/builtins.py \
178
$(wildcard bzrlib/*.py) \
179
$(wildcard bzrlib/*/*.py) \
180
tools/generate_docs.py \
181
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
183
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
184
$(PYTHON) tools/generate_docs.py -o $@ rstx
186
doc/en/release-notes/NEWS.txt: NEWS
187
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
189
MAN_PAGES = man1/bzr.1
190
man1/bzr.1: $(MAN_DEPENDENCIES)
191
$(PYTHON) tools/generate_docs.py -o $@ man
193
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
195
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
196
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
198
# build a png of our performance task list
200
# this is no longer built by default; you can build it if you want to look at it
201
doc/developers/performance.png: doc/developers/performance.dot
203
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
205
derived_web_docs = $(htm_files) $(dev_htm_files)
206
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
207
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
209
# the main target to build all the docs
212
# produce a tree containing just the final docs, ready for uploading to the web
215
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
217
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
218
pdf-docs: $(PDF_DOCS)
220
# clean produced docs
222
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
223
$(HTMLDIR) $(derived_txt_files)
224
rm -f doc/*/user-guide/*.pdf
225
rm -rf doc/*/user-guide/latex_prepared
228
### Windows Support ###
230
# make all the installers completely from scratch, using zc.buildout
231
# to fetch the dependencies
232
# These are files that need to be copied into the build location to boostrap
234
# Note that the path is relative to tools/win32
235
BUILDOUT_FILES := buildout.cfg \
236
buildout-templates/bin/build-installer.bat.in \
237
ostools.py bootstrap.py
240
@echo Make all the installers from scratch
241
@# Build everything in a separate directory, to avoid cluttering the WT
242
$(PYTHON) tools/win32/ostools.py makedir build-win32
243
@# cd to tools/win32 so that the relative paths are copied correctly
244
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
245
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
246
@# existing release directories, so delete them manually before building
247
@# It means things may be rebuilt that don't need to be, but at least
248
@# it will be correct when they do.
249
cd build-win32 && $(PYTHON) ostools.py remove release */release
250
cd build-win32 && $(PYTHON) bootstrap.py
251
cd build-win32 && bin/buildout
252
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
256
$(PYTHON) tools/win32/ostools.py remove build-win32
258
# make bzr.exe for win32 with py2exe
260
@echo *** Make bzr.exe
261
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
262
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
263
$(PYTHON) setup.py py2exe > py2exe.log
264
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
265
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
267
# win32 installer for bzr.exe
268
installer: exe copy-docs
269
@echo *** Make Windows installer
270
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
271
iscc /Q tools/win32/bzr.iss
273
# win32 Python's distutils-based installer
274
# require to have Python interpreter installed on win32
276
$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
279
$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
282
$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
284
python-installer: py-inst-24 py-inst-25 py-inst-26
288
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
289
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
291
# clean on win32 all installer-related files and directories
292
clean-win32: clean-docs
293
$(PYTHON) tools/win32/ostools.py remove build
294
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
295
$(PYTHON) tools/win32/ostools.py remove py2exe.log
296
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
297
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
298
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
299
$(PYTHON) tools/win32/ostools.py remove dist
301
.PHONY: dist dist-upload-escudero check-dist-tarball
303
# build a distribution tarball and zip file.
305
# this method of copying the pyrex generated files is a bit ugly; it would be
306
# nicer to generate it from distutils.
308
version=`./bzr version --short` && \
309
echo Building distribution of bzr $$version && \
310
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
311
expdir=$$expbasedir/bzr-$$version && \
312
tarball=$$PWD/../bzr-$$version.tar.gz && \
313
zipball=$$PWD/../bzr-$$version.zip && \
316
bzr export $$expdir && \
317
cp bzrlib/*.c $$expdir/bzrlib/. && \
318
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
319
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
320
gpg --detach-sign $$tarball && \
321
gpg --detach-sign $$zipball && \
324
# run all tests in a previously built tarball
326
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
327
version=`./bzr version --short` && \
328
tarball=$$PWD/../bzr-$$version.tar.gz && \
329
tar Cxz $$tmpdir -f $$tarball && \
330
$(MAKE) -C $$tmpdir/bzr-$$version check && \
334
# upload previously built tarball to the download directory on bazaar-vcs.org,
335
# and verify that it can be downloaded ok.
336
dist-upload-escudero:
337
version=`./bzr version --short` && \
338
tarball=../bzr-$$version.tar.gz && \
339
zipball=../bzr-$$version.zip && \
340
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
341
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
343
echo verifying over http... && \
344
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
345
| diff -s - $$zipball && \
346
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
347
| diff -s - $$zipball.sig
348
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
349
| diff -s - $$tarball && \
350
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
351
| diff -s - $$tarball.sig
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)
added
removed
Makefile
