1
# Copyright (C) 2005-2010 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
43
# Generate a stream for PQM to watch.
44
-$(RM) -f selftest.log
45
$(PYTHON) -Werror -O ./bzr selftest --subunit $(tests) | tee selftest.log
46
# An empty log file should catch errors in the $(PYTHON)
47
# command above (the '|' swallow any errors since 'make'
48
# sees the 'tee' exit code for the whole line
49
if [ ! -s selftest.log ] ; then exit 1 ; fi
50
# Check that there were no errors reported.
51
subunit-stats < selftest.log
53
# Run Python style checker (apt-get install pyflakes)
55
# Note that at present this gives many false warnings, because it doesn't
56
# know about identifiers loaded through lazy_import.
61
# There are many of these warnings at the moment and they're not a
62
# high priority to fix
63
pyflakes bzrlib | grep -v ' imported but unused'
66
$(PYTHON) setup.py clean
67
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
69
# Build API documentation
73
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
75
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
77
# build tags for emacs and vim
84
# these are treated as phony so they'll always be rebuilt - it's pretty quick
90
# Default to plain documentation for maximum backwards compatibility.
91
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
95
clean-docs: clean-plain
100
### Man-page Documentation ###
102
MAN_DEPENDENCIES = bzrlib/builtins.py \
103
$(wildcard bzrlib/*.py) \
104
$(wildcard bzrlib/*/*.py) \
105
tools/generate_docs.py \
106
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
108
MAN_PAGES = man1/bzr.1
109
man1/bzr.1: $(MAN_DEPENDENCIES)
110
$(PYTHON) tools/generate_docs.py -o $@ man
113
### Sphinx-style Documentation ###
115
# Build the documentation. To keep the dependencies down to a minimum
116
# for distro packagers, we only build the html documentation by default.
117
# Sphinx 0.6 or later is preferred for the best rendering, though
118
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
119
# for installation instructions.
120
docs-sphinx: html-sphinx
122
# Clean out generated documentation
124
cd doc/en && make clean
125
cd doc/es && make clean
126
cd doc/ja && make clean
127
cd doc/ru && make clean
128
cd doc/developers && make clean
130
SPHINX_DEPENDENCIES = \
131
doc/en/release-notes/index.txt \
132
doc/en/user-reference/index.txt \
139
doc/developers/Makefile \
140
doc/developers/make.bat
142
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
143
$(PYTHON) tools/generate_docs.py -o $@ rstx
145
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
146
$(PYTHON) tools/generate_release_notes.py NEWS $@
148
doc/%/Makefile: doc/en/Makefile
149
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
151
doc/%/make.bat: doc/en/make.bat
152
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
154
# Build the html docs using Sphinx.
155
html-sphinx: $(SPHINX_DEPENDENCIES)
156
cd doc/en && make html
157
cd doc/es && make html
158
cd doc/ru && make html
159
cd doc/ja && make html
160
cd doc/developers && make html
162
# Build the PDF docs using Sphinx. This requires numerous LaTeX
163
# packages. See http://sphinx.pocoo.org/builders.html for details.
164
# Note: We don't currently build PDFs for the Russian docs because
165
# they require additional packages to be installed (to handle
166
# Russian hyphenation rules, etc.)
167
pdf-sphinx: $(SPHINX_DEPENDENCIES)
168
cd doc/en && make latex
169
cd doc/es && make latex
170
cd doc/ja && make latex
171
cd doc/developers && make latex
172
cd doc/en/_build/latex && make all-pdf
173
cd doc/es/_build/latex && make all-pdf
174
cd doc/developers/_build/latex && make all-pdf
176
# Build the CHM (Windows Help) docs using Sphinx.
177
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
178
# to generate the final chm files.
179
chm-sphinx: $(SPHINX_DEPENDENCIES)
180
cd doc/en && make htmlhelp
181
cd doc/es && make htmlhelp
182
cd doc/ru && make htmlhelp
183
cd doc/ja && make htmlhelp
184
cd doc/developers && make htmlhelp
187
### Documentation Website ###
189
# Where to build the website
190
DOC_WEBSITE_BUILD = build_doc_website
192
# Build and package docs into a website, complete with downloads.
193
doc-website: html-sphinx pdf-sphinx
194
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
195
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
196
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
197
$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
198
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
201
### Plain Documentation ###
203
# While Sphinx is the preferred tool for building documentation, we still
204
# support our "plain" html documentation so that Sphinx is not a hard
205
# dependency for packagers on older platforms.
207
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
209
# translate txt docs to html
210
derived_txt_files = \
211
doc/en/release-notes/NEWS.txt
213
doc/en/tutorials/tutorial.txt \
214
doc/en/tutorials/using_bazaar_with_launchpad.txt \
215
doc/en/tutorials/centralized_workflow.txt \
216
$(wildcard doc/es/tutorials/*.txt) \
217
$(wildcard doc/ru/tutorials/*.txt) \
218
doc/ja/tutorials/tutorial.txt \
219
doc/ja/tutorials/using_bazaar_with_launchpad.txt \
220
doc/ja/tutorials/centralized_workflow.txt \
221
$(wildcard doc/*/mini-tutorial/index.txt) \
222
$(wildcard doc/*/user-guide/index-plain.txt) \
223
doc/en/admin-guide/index-plain.txt \
224
$(wildcard doc/es/guia-usario/*.txt) \
225
$(derived_txt_files) \
226
doc/en/upgrade-guide/index.txt \
228
$(wildcard doc/index.*.txt)
230
doc/en/user-guide/index.txt \
231
doc/es/user-guide/index.txt \
232
doc/ja/user-guide/index.txt \
233
doc/ru/user-guide/index.txt \
234
doc/en/admin-guide/index.txt
235
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
236
htm_files = $(patsubst %.txt, %.html, $(txt_files))
240
$(wildcard doc/*/bzr-en-quick-reference.svg) \
241
$(wildcard doc/*/bzr-en-quick-reference.png) \
242
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
243
$(wildcard doc/*/bzr-es-quick-reference.svg) \
244
$(wildcard doc/*/bzr-es-quick-reference.png) \
245
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
246
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
247
$(wildcard doc/*/bzr-ru-quick-reference.png) \
248
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
249
$(wildcard doc/*/user-guide/images/*.png)
251
# doc/developers/*.txt files that should *not* be individually
254
doc/developers/add.txt \
255
doc/developers/annotate.txt \
256
doc/developers/bundle-creation.txt \
257
doc/developers/commit.txt \
258
doc/developers/diff.txt \
259
doc/developers/directory-fingerprints.txt \
260
doc/developers/gc.txt \
261
doc/developers/implementation-notes.txt \
262
doc/developers/incremental-push-pull.txt \
263
doc/developers/index.txt \
264
doc/developers/initial-push-pull.txt \
265
doc/developers/merge-scaling.txt \
266
doc/developers/miscellaneous-notes.txt \
267
doc/developers/missing.txt \
268
doc/developers/performance-roadmap-rationale.txt \
269
doc/developers/performance-use-case-analysis.txt \
270
doc/developers/planned-change-integration.txt \
271
doc/developers/planned-performance-changes.txt \
272
doc/developers/plans.txt \
273
doc/developers/process.txt \
274
doc/developers/revert.txt \
275
doc/developers/specifications.txt \
276
doc/developers/status.txt \
277
doc/developers/uncommit.txt
279
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
280
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
281
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
283
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
284
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
286
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
287
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
289
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
290
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
292
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide))
293
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
295
doc/developers/%.html: doc/developers/%.txt
296
$(rst2html) --stylesheet=../default.css $< $@
298
doc/index.html: doc/index.txt
299
$(rst2html) --stylesheet=default.css $< $@
301
doc/index.%.html: doc/index.%.txt
302
$(rst2html) --stylesheet=default.css $< $@
305
$(rst2html) --stylesheet=../../default.css $< $@
307
doc/en/release-notes/NEWS.txt: NEWS
308
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
310
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
312
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
313
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
315
derived_web_docs = $(htm_files) $(dev_htm_files)
316
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
317
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
319
# the main target to build all the docs
320
docs-plain: $(ALL_DOCS)
322
# produce a tree containing just the final docs, ready for uploading to the web
324
html-plain: docs-plain
325
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
327
# clean produced docs
329
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
330
$(HTMLDIR) $(derived_txt_files)
333
### Miscellaneous Documentation Targets ###
335
# build a png of our performance task list
336
# this is no longer built by default; you can build it if you want to look at it
337
doc/developers/performance.png: doc/developers/performance.dot
339
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
342
### Windows Support ###
344
# make all the installers completely from scratch, using zc.buildout
345
# to fetch the dependencies
346
# These are files that need to be copied into the build location to boostrap
348
# Note that the path is relative to tools/win32
349
BUILDOUT_FILES = buildout.cfg \
350
buildout-templates/bin/build-installer.bat.in \
351
ostools.py bootstrap.py
354
@echo Make all the installers from scratch
355
@# Build everything in a separate directory, to avoid cluttering the WT
356
$(PYTHON) tools/win32/ostools.py makedir build-win32
357
@# cd to tools/win32 so that the relative paths are copied correctly
358
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
359
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
360
@# existing release directories, so delete them manually before building
361
@# It means things may be rebuilt that don't need to be, but at least
362
@# it will be correct when they do.
363
cd build-win32 && $(PYTHON) ostools.py remove release */release
364
cd build-win32 && $(PYTHON) bootstrap.py
365
cd build-win32 && bin/buildout
366
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
370
$(PYTHON) tools/win32/ostools.py remove build-win32
372
# make bzr.exe for win32 with py2exe
374
@echo *** Make bzr.exe
375
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
376
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
377
$(PYTHON) setup.py py2exe > py2exe.log
378
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
379
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
381
# win32 installer for bzr.exe
382
installer: exe copy-docs
383
@echo *** Make Windows installer
384
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
385
iscc /Q tools/win32/bzr.iss
387
# win32 Python's distutils-based installer
388
# require to have Python interpreter installed on win32
390
$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
393
$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
396
$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
398
python-installer: py-inst-24 py-inst-25 py-inst-26
402
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
403
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
405
# clean on win32 all installer-related files and directories
406
clean-win32: clean-docs
407
$(PYTHON) tools/win32/ostools.py remove build
408
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
409
$(PYTHON) tools/win32/ostools.py remove py2exe.log
410
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
411
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
412
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
413
$(PYTHON) tools/win32/ostools.py remove dist
416
### Packaging Targets ###
418
.PHONY: dist check-dist-tarball
420
# build a distribution source tarball
422
# this method of copying the pyrex generated files is a bit ugly; it would be
423
# nicer to generate it from distutils.
425
version=`./bzr version --short` && \
426
echo Building distribution of bzr $$version && \
427
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
428
expdir=$$expbasedir/bzr-$$version && \
429
tarball=$$PWD/../bzr-$$version.tar.gz && \
432
bzr export $$expdir && \
433
cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
434
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
435
gpg --detach-sign $$tarball && \
438
# run all tests in a previously built tarball
440
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
441
version=`./bzr version --short` && \
442
tarball=$$PWD/../bzr-$$version.tar.gz && \
443
tar Cxz $$tmpdir -f $$tarball && \
444
$(MAKE) -C $$tmpdir/bzr-$$version check && \
added
removed
Makefile
