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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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)
38
@echo "Running all tests with no locale."
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/developer-guide/HACKING.txt \
88
doc/en/release-notes/NEWS.txt
89
txt_files := $(wildcard doc/en/tutorials/*.txt) \
90
$(derived_txt_files) \
91
doc/en/user-guide/index.txt \
92
doc/en/mini-tutorial/index.txt \
93
$(wildcard doc/es/guia-usario/*.txt) \
94
doc/es/mini-tutorial/index.txt \
99
doc/en/quick-reference/quick-start-summary.svg \
100
doc/en/quick-reference/quick-start-summary.png \
101
doc/en/quick-reference/quick-start-summary.pdf \
102
$(wildcard doc/en/user-guide/images/*.png) \
103
doc/es/referencia-rapida/referencia-rapida.svg \
104
doc/es/referencia-rapida/referencia-rapida.png \
105
doc/es/referencia-rapida/referencia-rapida.pdf \
106
$(wildcard doc/es/guia-usuario/images/*.png)
107
htm_files := $(patsubst %.txt, %.html, $(txt_files))
108
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
109
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
111
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
112
$(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
114
doc/developers/%.html: doc/developers/%.txt
115
$(rst2html) --stylesheet=../default.css $< $@
117
doc/index.html: doc/index.txt
118
$(rst2html) --stylesheet=default.css $< $@
121
$(rst2html) --stylesheet=../../default.css $< $@
123
MAN_DEPENDENCIES = bzrlib/builtins.py \
124
bzrlib/bundle/commands.py \
125
bzrlib/conflicts.py \
126
bzrlib/help_topics/__init__.py \
127
bzrlib/sign_my_commits.py \
128
bzrlib/bugtracker.py \
130
tools/doc_generate/__init__.py \
131
tools/doc_generate/autodoc_man.py \
132
tools/doc_generate/autodoc_rstx.py \
133
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
135
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
136
$(PYTHON) generate_docs.py -o $@ rstx
138
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
139
$(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
141
doc/en/release-notes/NEWS.txt: NEWS
142
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
144
MAN_PAGES = man1/bzr.1
145
man1/bzr.1: $(MAN_DEPENDENCIES)
146
$(PYTHON) generate_docs.py -o $@ man
148
# build a png of our performance task list
149
doc/developers/performance.png: doc/developers/performance.dot
151
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
153
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
154
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
155
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
157
# the main target to build all the docs
160
# produce a tree containing just the final docs, ready for uploading to the web
163
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
165
# clean produced docs
167
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
168
$(HTMLDIR) $(derived_txt_files)
171
### Windows Support ###
173
# make bzr.exe for win32 with py2exe
175
@echo *** Make bzr.exe
176
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
177
$(PYTHON) setup.py py2exe > py2exe.log
178
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
179
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
181
# win32 installer for bzr.exe
182
installer: exe copy-docs
183
@echo *** Make windows installer
184
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
185
iscc /Q tools/win32/bzr.iss
187
# win32 Python's distutils-based installer
188
# require to have Python interpreter installed on win32
190
python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
193
python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
195
python-installer: py-inst-24 py-inst-25
199
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
200
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
202
# clean on win32 all installer-related files and directories
203
clean-win32: clean-docs
204
$(PYTHON) tools/win32/ostools.py remove build
205
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
206
$(PYTHON) tools/win32/ostools.py remove py2exe.log
207
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
208
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
209
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
210
$(PYTHON) tools/win32/ostools.py remove dist
212
.PHONY: dist dist-upload-escudero check-dist-tarball
214
# build a distribution tarball and zip file.
216
# this method of copying the pyrex generated files is a bit ugly; it would be
217
# nicer to generate it from distutils.
219
version=`./bzr version --short` && \
220
echo Building distribution of bzr $$version && \
221
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
222
expdir=$$expbasedir/bzr-$$version && \
223
tarball=$$PWD/../bzr-$$version.tar.gz && \
224
zipball=$$PWD/../bzr-$$version.zip && \
227
bzr export $$expdir && \
228
cp bzrlib/*.c $$expdir/bzrlib/. && \
229
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
230
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
231
gpg --detach-sign $$tarball && \
232
gpg --detach-sign $$zipball && \
235
# run all tests in a previously built tarball
237
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
238
version=`./bzr version --short` && \
239
tarball=$$PWD/../bzr-$$version.tar.gz && \
240
tar Cxz $$tmpdir -f $$tarball && \
241
$(MAKE) -C $$tmpdir/bzr-$$version check && \
245
# upload previously built tarball to the download directory on bazaar-vcs.org,
246
# and verify that it can be downloaded ok.
247
dist-upload-escudero:
248
version=`./bzr version --short` && \
249
tarball=../bzr-$$version.tar.gz && \
250
zipball=../bzr-$$version.zip && \
251
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
252
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
254
echo verifying over http... && \
255
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
256
| diff -s - $$zipball && \
257
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
258
| diff -s - $$zipball.sig
259
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
260
| diff -s - $$tarball && \
261
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
262
| diff -s - $$tarball.sig