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)
44
# Run Python style checker (apt-get install pyflakes)
46
# Note that at present this gives many false warnings, because it doesn't
47
# know about identifiers loaded through lazy_import.
52
# There are many of these warnings at the moment and they're not a
53
# high priority to fix
54
pyflakes bzrlib | grep -v ' imported but unused'
57
$(PYTHON) setup.py clean
58
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
60
# Build API documentation
64
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
66
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
68
# build tags for emacs and vim
75
# these are treated as phony so they'll always be rebuilt - it's pretty quick
80
# set PRETTY to get docs that look like the Bazaar web site
82
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
84
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
87
# translate txt docs to html
88
derived_txt_files := \
89
doc/en/user-reference/bzr_man.txt \
90
doc/en/release-notes/NEWS.txt
92
doc/en/tutorials/tutorial.txt \
93
doc/en/tutorials/using_bazaar_with_launchpad.txt \
94
doc/en/tutorials/centralized_workflow.txt \
95
$(wildcard doc/ru/tutorials/*.txt) \
96
$(wildcard doc/*/mini-tutorial/index.txt) \
97
$(wildcard doc/*/user-guide/index.txt) \
98
$(derived_txt_files) \
99
doc/en/developer-guide/HACKING.txt \
100
doc/en/upgrade-guide/index.txt \
101
$(wildcard doc/es/guia-usario/*.txt) \
102
doc/es/mini-tutorial/index.txt \
104
$(wildcard doc/index.*.txt)
107
$(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
108
$(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
109
$(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
110
$(wildcard doc/*/user-guide/images/*.png)
111
htm_files := $(patsubst %.txt, %.html, $(txt_files))
113
# doc/developers/*.txt files that should *not* be individually
116
doc/developers/add.txt \
117
doc/developers/annotate.txt \
118
doc/developers/bundle-creation.txt \
119
doc/developers/commit.txt \
120
doc/developers/diff.txt \
121
doc/developers/directory-fingerprints.txt \
122
doc/developers/gc.txt \
123
doc/developers/incremental-push-pull.txt \
124
doc/developers/initial-push-pull.txt \
125
doc/developers/merge-scaling.txt \
126
doc/developers/missing.txt \
127
doc/developers/performance-roadmap-rationale.txt \
128
doc/developers/performance-use-case-analysis.txt \
129
doc/developers/planned-change-integration.txt \
130
doc/developers/planned-performance-changes.txt \
131
doc/developers/revert.txt \
132
doc/developers/status.txt \
133
doc/developers/uncommit.txt
135
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
136
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
137
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
139
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
140
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
142
# Set the paper size for PDF files.
143
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
145
# TODO: Add generation for Russian PDF
146
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
148
# Copy and modify the RST sources, and convert SVG images to PDF
149
# files for use a images in the LaTeX-generated PDF.
150
# Then generate the PDF output from the modified RST sources.
151
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
152
mkdir -p doc/en/user-guide/latex_prepared
153
$(PYTHON) tools/prepare_for_latex.py \
154
--out-dir=doc/en/user-guide/latex_prepared \
155
--in-dir=doc/en/user-guide
156
cd doc/en/user-guide/latex_prepared && \
157
$(PYTHON) ../../../../tools/rst2pdf.py \
158
--documentoptions=10pt,$(PAPERSIZE)paper \
159
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
160
--strict --title="Bazaar User Guide" \
161
index.txt ../user-guide.$(PAPERSIZE).pdf
163
doc/developers/%.html: doc/developers/%.txt
164
$(rst2html) --stylesheet=../default.css $< $@
166
doc/index.html: doc/index.txt
167
$(rst2html) --stylesheet=default.css $< $@
169
doc/index.%.html: doc/index.%.txt
170
$(rst2html) --stylesheet=default.css $< $@
173
$(rst2html) --stylesheet=../../default.css $< $@
175
MAN_DEPENDENCIES = bzrlib/builtins.py \
176
$(wildcard bzrlib/*.py) \
177
$(wildcard bzrlib/*/*.py) \
178
tools/generate_docs.py \
179
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
181
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
182
$(PYTHON) tools/generate_docs.py -o $@ rstx
184
doc/en/release-notes/NEWS.txt: NEWS
185
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
187
MAN_PAGES = man1/bzr.1
188
man1/bzr.1: $(MAN_DEPENDENCIES)
189
$(PYTHON) tools/generate_docs.py -o $@ man
191
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
193
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
194
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
196
# build a png of our performance task list
198
# this is no longer built by default; you can build it if you want to look at it
199
doc/developers/performance.png: doc/developers/performance.dot
201
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
203
derived_web_docs = $(htm_files) $(dev_htm_files)
204
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
205
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
207
# the main target to build all the docs
210
# produce a tree containing just the final docs, ready for uploading to the web
213
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
215
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
216
pdf-docs: $(PDF_DOCS)
218
# clean produced docs
220
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
221
$(HTMLDIR) $(derived_txt_files)
222
rm -f doc/*/user-guide/*.pdf
223
rm -rf doc/*/user-guide/latex_prepared
226
### Windows Support ###
228
# make all the installers completely from scratch, using zc.buildout
229
# to fetch the dependencies
230
# These are files that need to be copied into the build location to boostrap
232
# Note that the path is relative to tools/win32
233
BUILDOUT_FILES := buildout.cfg \
234
buildout-templates/bin/build-installer.bat.in \
235
ostools.py bootstrap.py
238
@echo Make all the installers from scratch
239
@# Build everything in a separate directory, to avoid cluttering the WT
240
$(PYTHON) tools/win32/ostools.py makedir build-win32
241
@# cd to tools/win32 so that the relative paths are copied correctly
242
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
243
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
244
@# existing release directories, so delete them manually before building
245
@# It means things may be rebuilt that don't need to be, but at least
246
@# it will be correct when they do.
247
cd build-win32 && $(PYTHON) ostools.py remove release */release
248
cd build-win32 && $(PYTHON) bootstrap.py
249
cd build-win32 && bin/buildout
250
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
254
$(PYTHON) tools/win32/ostools.py remove build-win32
256
# make bzr.exe for win32 with py2exe
258
@echo *** Make bzr.exe
259
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
260
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
261
$(PYTHON) setup.py py2exe > py2exe.log
262
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
263
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
265
# win32 installer for bzr.exe
266
installer: exe copy-docs
267
@echo *** Make Windows installer
268
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
269
iscc /Q tools/win32/bzr.iss
271
# win32 Python's distutils-based installer
272
# require to have Python interpreter installed on win32
274
$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
277
$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
280
$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
282
python-installer: py-inst-24 py-inst-25 py-inst-26
286
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
287
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
289
# clean on win32 all installer-related files and directories
290
clean-win32: clean-docs
291
$(PYTHON) tools/win32/ostools.py remove build
292
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
293
$(PYTHON) tools/win32/ostools.py remove py2exe.log
294
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
295
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
296
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
297
$(PYTHON) tools/win32/ostools.py remove dist
299
.PHONY: dist dist-upload-escudero check-dist-tarball
301
# build a distribution tarball and zip file.
303
# this method of copying the pyrex generated files is a bit ugly; it would be
304
# nicer to generate it from distutils.
306
version=`./bzr version --short` && \
307
echo Building distribution of bzr $$version && \
308
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
309
expdir=$$expbasedir/bzr-$$version && \
310
tarball=$$PWD/../bzr-$$version.tar.gz && \
311
zipball=$$PWD/../bzr-$$version.zip && \
314
bzr export $$expdir && \
315
cp bzrlib/*.c $$expdir/bzrlib/. && \
316
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
317
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
318
gpg --detach-sign $$tarball && \
319
gpg --detach-sign $$zipball && \
322
# run all tests in a previously built tarball
324
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
325
version=`./bzr version --short` && \
326
tarball=$$PWD/../bzr-$$version.tar.gz && \
327
tar Cxz $$tmpdir -f $$tarball && \
328
$(MAKE) -C $$tmpdir/bzr-$$version check && \
332
# upload previously built tarball to the download directory on bazaar-vcs.org,
333
# and verify that it can be downloaded ok.
334
dist-upload-escudero:
335
version=`./bzr version --short` && \
336
tarball=../bzr-$$version.tar.gz && \
337
zipball=../bzr-$$version.zip && \
338
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
339
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
341
echo verifying over http... && \
342
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
343
| diff -s - $$zipball && \
344
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
345
| diff -s - $$zipball.sig
346
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
347
| diff -s - $$tarball && \
348
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
349
| diff -s - $$tarball.sig
added
removed
Makefile
