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)
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/release-notes/NEWS.txt
88
txt_files := $(wildcard doc/en/tutorials/*.txt) \
89
$(derived_txt_files) \
90
doc/en/user-guide/index.txt \
91
doc/en/mini-tutorial/index.txt \
92
doc/en/developer-guide/HACKING.txt \
93
$(wildcard doc/es/guia-usario/*.txt) \
94
doc/es/mini-tutorial/index.txt \
98
doc/ru/user-guide/index.txt \
99
doc/ru/mini-tutorial/index.txt \
100
$(wildcard doc/ru/tutorials/*.txt)
103
doc/en/quick-reference/quick-start-summary.svg \
104
doc/en/quick-reference/quick-start-summary.png \
105
doc/en/quick-reference/quick-start-summary.pdf \
106
$(wildcard doc/en/user-guide/images/*.png) \
107
doc/es/referencia-rapida/referencia-rapida.svg \
108
doc/es/referencia-rapida/referencia-rapida.png \
109
doc/es/referencia-rapida/referencia-rapida.pdf \
110
$(wildcard doc/es/guia-usuario/images/*.png) \
111
doc/ru/quick-reference/quick-start-summary.svg \
112
doc/ru/quick-reference/quick-start-summary.png \
113
doc/ru/quick-reference/quick-start-summary.pdf \
114
$(wildcard doc/ru/user-guide/images/*.png)
115
htm_files := $(patsubst %.txt, %.html, $(txt_files))
117
# doc/developers/*.txt files that should *not* be individually
120
doc/developers/add.txt \
121
doc/developers/annotate.txt \
122
doc/developers/bundle-creation.txt \
123
doc/developers/commit.txt \
124
doc/developers/diff.txt \
125
doc/developers/directory-fingerprints.txt \
126
doc/developers/gc.txt \
127
doc/developers/incremental-push-pull.txt \
128
doc/developers/initial-push-pull.txt \
129
doc/developers/merge-scaling.txt \
130
doc/developers/missing.txt \
131
doc/developers/performance-roadmap-rationale.txt \
132
doc/developers/performance-use-case-analysis.txt \
133
doc/developers/planned-change-integration.txt \
134
doc/developers/planned-performance-changes.txt \
135
doc/developers/revert.txt \
136
doc/developers/status.txt \
137
doc/developers/uncommit.txt
139
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
140
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
141
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
143
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
144
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
146
# Set the paper size for PDF files.
147
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
149
# TODO: Add generation for Russian PDF
150
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
152
# Copy and modify the RST sources, and convert SVG images to PDF
153
# files for use a images in the LaTeX-generated PDF.
154
# Then generate the PDF output from the modified RST sources.
155
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
156
mkdir -p doc/en/user-guide/latex_prepared
157
$(PYTHON) tools/prepare_for_latex.py \
158
--out-dir=doc/en/user-guide/latex_prepared \
159
--in-dir=doc/en/user-guide
160
cd doc/en/user-guide/latex_prepared && \
161
$(PYTHON) ../../../../tools/rst2pdf.py \
162
--documentoptions=10pt,$(PAPERSIZE)paper \
163
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
164
--strict --title="Bazaar User Guide" \
165
index.txt ../user-guide.$(PAPERSIZE).pdf
167
doc/developers/%.html: doc/developers/%.txt
168
$(rst2html) --stylesheet=../default.css $< $@
170
doc/index.html: doc/index.txt
171
$(rst2html) --stylesheet=default.css $< $@
173
doc/index.%.html: doc/index.%.txt
174
$(rst2html) --stylesheet=default.css $< $@
177
$(rst2html) --stylesheet=../../default.css $< $@
179
MAN_DEPENDENCIES = bzrlib/builtins.py \
180
bzrlib/bundle/commands.py \
181
bzrlib/conflicts.py \
182
bzrlib/help_topics/__init__.py \
184
bzrlib/sign_my_commits.py \
185
bzrlib/bugtracker.py \
187
tools/doc_generate/__init__.py \
188
tools/doc_generate/autodoc_man.py \
189
tools/doc_generate/autodoc_rstx.py \
190
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
192
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
193
$(PYTHON) generate_docs.py -o $@ rstx
195
doc/en/release-notes/NEWS.txt: NEWS
196
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
198
MAN_PAGES = man1/bzr.1
199
man1/bzr.1: $(MAN_DEPENDENCIES)
200
$(PYTHON) generate_docs.py -o $@ man
202
# build a png of our performance task list
204
# this is no longer built by default; you can build it if you want to look at it
205
doc/developers/performance.png: doc/developers/performance.dot
207
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
209
derived_web_docs = $(htm_files) $(dev_htm_files)
210
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
211
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
213
# the main target to build all the docs
216
# produce a tree containing just the final docs, ready for uploading to the web
219
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
221
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
222
pdf-docs: $(PDF_DOCS)
224
# clean produced docs
226
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
227
$(HTMLDIR) $(derived_txt_files)
228
rm -f doc/*/user-guide/*.pdf
229
rm -rf doc/*/user-guide/latex_prepared
232
### Windows Support ###
234
# make bzr.exe for win32 with py2exe
236
@echo *** Make bzr.exe
237
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
238
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
239
$(PYTHON) setup.py py2exe > py2exe.log
240
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
241
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
243
# win32 installer for bzr.exe
244
installer: exe copy-docs
245
@echo *** Make windows installer
246
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
247
iscc /Q tools/win32/bzr.iss
249
# win32 Python's distutils-based installer
250
# require to have Python interpreter installed on win32
252
python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
255
python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
257
python-installer: py-inst-24 py-inst-25
261
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
262
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
264
# clean on win32 all installer-related files and directories
265
clean-win32: clean-docs
266
$(PYTHON) tools/win32/ostools.py remove build
267
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
268
$(PYTHON) tools/win32/ostools.py remove py2exe.log
269
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
270
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
271
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
272
$(PYTHON) tools/win32/ostools.py remove dist
274
.PHONY: dist dist-upload-escudero check-dist-tarball
276
# build a distribution tarball and zip file.
278
# this method of copying the pyrex generated files is a bit ugly; it would be
279
# nicer to generate it from distutils.
281
version=`./bzr version --short` && \
282
echo Building distribution of bzr $$version && \
283
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
284
expdir=$$expbasedir/bzr-$$version && \
285
tarball=$$PWD/../bzr-$$version.tar.gz && \
286
zipball=$$PWD/../bzr-$$version.zip && \
289
bzr export $$expdir && \
290
cp bzrlib/*.c $$expdir/bzrlib/. && \
291
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
292
(cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
293
gpg --detach-sign $$tarball && \
294
gpg --detach-sign $$zipball && \
297
# run all tests in a previously built tarball
299
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
300
version=`./bzr version --short` && \
301
tarball=$$PWD/../bzr-$$version.tar.gz && \
302
tar Cxz $$tmpdir -f $$tarball && \
303
$(MAKE) -C $$tmpdir/bzr-$$version check && \
307
# upload previously built tarball to the download directory on bazaar-vcs.org,
308
# and verify that it can be downloaded ok.
309
dist-upload-escudero:
310
version=`./bzr version --short` && \
311
tarball=../bzr-$$version.tar.gz && \
312
zipball=../bzr-$$version.zip && \
313
scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
314
escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
316
echo verifying over http... && \
317
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
318
| diff -s - $$zipball && \
319
curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
320
| diff -s - $$zipball.sig
321
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
322
| diff -s - $$tarball && \
323
curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
324
| diff -s - $$tarball.sig
added
removed
Makefile
