4
./bzr selftest $(tests)
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.
26
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
31
@echo "building extension modules."
32
$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
34
check: docs check-nodocs
36
check-nodocs: extensions
37
$(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
5
38
@echo "Running all tests with no locale."
6
LC_CTYPE= LANG=C LC_ALL= ./bzr selftest $(tests)
9
./bzr --no-plugins selftest -v msgeditor
13
-find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
19
# build emacs cross-reference
20
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
22
ctags-exuberant -e $(tag_files)
24
tutorial.html: tutorial.txt
25
rest2html tutorial.txt > tutorial.html
39
LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
41
# Run Python style checker (apt-get install pyflakes)
43
# Note that at present this gives many false warnings, because it doesn't
44
# know about identifiers loaded through lazy_import.
49
# There are many of these warnings at the moment and they're not a
50
# high priority to fix
51
pyflakes bzrlib | grep -v ' imported but unused'
54
$(PYTHON) setup.py clean
55
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
57
# Build API documentation
61
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
63
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
65
# build tags for emacs and vim
72
# these are treated as phony so they'll always be rebuilt - it's pretty quick
77
# set PRETTY to get docs that look like the Bazaar web site
79
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
81
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
84
# translate txt docs to html
85
derived_txt_files := \
86
doc/en/user-reference/bzr_man.txt \
87
doc/en/release-notes/NEWS.txt
88
txt_files := $(wildcard doc/*/tutorials/*.txt) \
89
$(wildcard doc/*/mini-tutorial/index.txt) \
90
$(wildcard doc/*/user-guide/index.txt) \
91
$(derived_txt_files) \
92
doc/en/developer-guide/HACKING.txt \
93
doc/en/upgrade-guide/index.txt \
94
$(wildcard doc/es/guia-usario/*.txt) \
95
doc/es/mini-tutorial/index.txt \
97
$(wildcard doc/index.*.txt)
100
$(wildcard doc/*/quick-reference/quick-start-summary.svg) \
101
$(wildcard doc/*/quick-reference/quick-start-summary.png) \
102
$(wildcard doc/*/quick-reference/quick-start-summary.pdf) \
103
$(wildcard doc/*/user-guide/images/*.png)
104
htm_files := $(patsubst %.txt, %.html, $(txt_files))
106
# doc/developers/*.txt files that should *not* be individually
109
doc/developers/add.txt \
110
doc/developers/annotate.txt \
111
doc/developers/bundle-creation.txt \
112
doc/developers/commit.txt \
113
doc/developers/diff.txt \
114
doc/developers/directory-fingerprints.txt \
115
doc/developers/gc.txt \
116
doc/developers/incremental-push-pull.txt \
117
doc/developers/initial-push-pull.txt \
118
doc/developers/merge-scaling.txt \
119
doc/developers/missing.txt \
120
doc/developers/performance-roadmap-rationale.txt \
121
doc/developers/performance-use-case-analysis.txt \
122
doc/developers/planned-change-integration.txt \
123
doc/developers/planned-performance-changes.txt \
124
doc/developers/revert.txt \
125
doc/developers/status.txt \
126
doc/developers/uncommit.txt
128
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
129
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
130
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
132
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
133
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
135
# Set the paper size for PDF files.
136
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
138
# TODO: Add generation for Russian PDF
139
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
141
# Copy and modify the RST sources, and convert SVG images to PDF
142
# files for use a images in the LaTeX-generated PDF.
143
# Then generate the PDF output from the modified RST sources.
144
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
145
mkdir -p doc/en/user-guide/latex_prepared
146
$(PYTHON) tools/prepare_for_latex.py \
147
--out-dir=doc/en/user-guide/latex_prepared \
148
--in-dir=doc/en/user-guide
149
cd doc/en/user-guide/latex_prepared && \
150
$(PYTHON) ../../../../tools/rst2pdf.py \
151
--documentoptions=10pt,$(PAPERSIZE)paper \
152
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
153
--strict --title="Bazaar User Guide" \
154
index.txt ../user-guide.$(PAPERSIZE).pdf
156
doc/developers/%.html: doc/developers/%.txt
157
$(rst2html) --stylesheet=../default.css $< $@
159
doc/index.html: doc/index.txt
160
$(rst2html) --stylesheet=default.css $< $@
162
doc/index.%.html: doc/index.%.txt
163
$(rst2html) --stylesheet=default.css $< $@
166
$(rst2html) --stylesheet=../../default.css $< $@
168
MAN_DEPENDENCIES = bzrlib/builtins.py \
169
$(wildcard bzrlib/*.py) \
170
$(wildcard bzrlib/*/*.py) \
171
tools/generate_docs.py \
172
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
174
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
175
PYTHONPATH=.:$$PYTHONPATH $(PYTHON) tools/generate_docs.py -o $@ rstx
177
doc/en/release-notes/NEWS.txt: NEWS
178
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
180
MAN_PAGES = man1/bzr.1
181
man1/bzr.1: $(MAN_DEPENDENCIES)
182
PYTHONPATH=.:$$PYTHONPATH $(PYTHON) tools/generate_docs.py -o $@ man
184
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
186
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
187
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
189
# build a png of our performance task list
191
# this is no longer built by default; you can build it if you want to look at it
192
doc/developers/performance.png: doc/developers/performance.dot
194
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
196
derived_web_docs = $(htm_files) $(dev_htm_files)
197
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
198
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
200
# the main target to build all the docs
203
# produce a tree containing just the final docs, ready for uploading to the web
206
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
208
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
209
pdf-docs: $(PDF_DOCS)
211
# clean produced docs
213
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
214
$(HTMLDIR) $(derived_txt_files)
215
rm -f doc/*/user-guide/*.pdf
216
rm -rf doc/*/user-guide/latex_prepared
219
### Windows Support ###
221
# make bzr.exe for win32 with py2exe
223
@echo *** Make bzr.exe
224
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
225
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
226
$(PYTHON) setup.py py2exe > py2exe.log
227
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
228
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
230
# win32 installer for bzr.exe
231
installer: exe copy-docs
232
@echo *** Make windows installer
233
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
234
iscc /Q tools/win32/bzr.iss
236
# win32 Python's distutils-based installer
237
# require to have Python interpreter installed on win32
239
python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
242
python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
245
python26 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
247
python-installer: py-inst-24 py-inst-25 py-inst-26
251
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
252
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
254
# clean on win32 all installer-related files and directories
255
clean-win32: clean-docs
256
$(PYTHON) tools/win32/ostools.py remove build
257
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
258
$(PYTHON) tools/win32/ostools.py remove py2exe.log
259
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
260
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
261
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
262
$(PYTHON) tools/win32/ostools.py remove dist
264
.PHONY: dist dist-upload-escudero check-dist-tarball
266
# build a distribution tarball and zip file.
268
# this method of copying the pyrex generated files is a bit ugly; it would be
269
# nicer to generate it from distutils.
271
version=`./bzr version --short` && \
272
echo Building distribution of bzr $$version && \
273
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
274
expdir=$$expbasedir/bzr-$$version && \
275
tarball=$$PWD/../bzr-$$version.tar.gz && \
276
zipball=$$PWD/../bzr-$$version.zip && \
279
bzr export $$expdir && \
280
cp bzrlib/*.c $$expdir/bzrlib/. && \
281
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
282
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
283
gpg --detach-sign $$tarball && \
284
gpg --detach-sign $$zipball && \
287
# run all tests in a previously built tarball
289
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
290
version=`./bzr version --short` && \
291
tarball=$$PWD/../bzr-$$version.tar.gz && \
292
tar Cxz $$tmpdir -f $$tarball && \
293
$(MAKE) -C $$tmpdir/bzr-$$version check && \
297
# upload previously built tarball to the download directory on bazaar-vcs.org,
298
# and verify that it can be downloaded ok.
299
dist-upload-escudero:
300
version=`./bzr version --short` && \
301
tarball=../bzr-$$version.tar.gz && \
302
zipball=../bzr-$$version.zip && \
303
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
304
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
306
echo verifying over http... && \
307
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
308
| diff -s - $$zipball && \
309
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
310
| diff -s - $$zipball.sig
311
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
312
| diff -s - $$tarball && \
313
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
314
| diff -s - $$tarball.sig
added
removed
Makefile
