4
./bzr selftest $(tests)
5
@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
1
# Copyright (C) 2005-2012, 2016, 2017 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 brz. Mostly for
18
# building documentation, etc.
29
PLUGIN_TARGET=plugin-release
31
BRZ_PLUGIN_PATH=-site:-user
33
# Shorter replacement for $(sort $(wildcard <arg>)) as $(call sw,<arg>)
34
sw = $(sort $(wildcard $(1)))
37
.PHONY: all clean realclean extensions pyflakes api-docs check-nodocs check
42
@echo "building extension modules."
43
$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
45
check: docs check-nodocs
47
check-nodocs: check-nodocs2 check-nodocs3
50
# Generate a stream for PQM to watch.
51
-$(RM) -f selftest.log
52
echo `date` ": selftest starts" 1>&2
53
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
54
./brz selftest -Oselftest.timeout=120 --load-list=python3.passing \
55
--subunit2 $(tests) | tee selftest.log | subunit-2to1
56
echo `date` ": selftest ends" 1>&2
57
# An empty log file should catch errors in the $(PYTHON3)
58
# command above (the '|' swallow any errors since 'make'
59
# sees the 'tee' exit code for the whole line
60
if [ ! -s selftest.log ] ; then exit 1 ; fi
61
# Check that there were no errors reported.
62
subunit-stats < selftest.log
64
update-python3-passing:
65
# Generate a stream for PQM to watch.
66
-$(RM) -f selftest.log
67
-BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
68
./brz selftest -Oselftest.timeout=120 \
69
--subunit2 $(tests) > selftest.log
70
grep -v "^#" python3.passing > python3.passing.new
72
subunit-filter --no-failure --no-error --success | \
73
subunit-ls --no-passthrough >> python3.passing.new
74
cp python3.passing python3.passing.old
75
grep "^#" python3.passing.old > python3.passing
76
sort -u python3.passing.new >> python3.passing
78
check-nodocs2: extensions
79
# Generate a stream for PQM to watch.
80
-$(RM) -f selftest.log
81
echo `date` ": selftest starts" 1>&2
82
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
83
./brz selftest -Oselftest.timeout=120 \
84
--subunit2 $(tests) | tee selftest.log | subunit-2to1
85
echo `date` ": selftest ends" 1>&2
86
# An empty log file should catch errors in the $(PYTHON)
87
# command above (the '|' swallow any errors since 'make'
88
# sees the 'tee' exit code for the whole line
89
if [ ! -s selftest.log ] ; then exit 1 ; fi
90
# Check that there were no errors reported.
91
subunit-stats < selftest.log
93
# Run Python style checker (apt-get install pyflakes)
95
# Note that at present this gives many false warnings, because it doesn't
96
# know about identifiers loaded through lazy_import.
101
# There are many of these warnings at the moment and they're not a
102
# high priority to fix
103
pyflakes breezy | grep -v ' imported but unused'
106
$(PYTHON) setup.py clean
107
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
110
# Remove files which are autogenerated but included by the tarball.
112
rm -f breezy/_simple_set_pyx.h breezy/_simple_set_pyx_api.h
114
# Build API documentation
115
docfiles = brz breezy
118
pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)
120
# build tags for emacs and vim
127
# these are treated as phony so they'll always be rebuilt - it's pretty quick
131
### Documentation ###
133
# Default to plain documentation for maximum backwards compatibility.
134
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
138
clean-docs: clean-plain
140
html-docs: html-plain
143
### Man-page Documentation ###
145
MAN_DEPENDENCIES = breezy/builtins.py \
146
$(call sw,breezy/*.py) \
147
$(call sw,breezy/*/*.py) \
148
tools/generate_docs.py \
149
$(call sw,$(addsuffix /*.txt, breezy/help_topics/en))
151
MAN_PAGES = man1/brz.1
152
man1/brz.1: $(MAN_DEPENDENCIES)
153
$(PYTHON) tools/generate_docs.py -o $@ man
156
### Sphinx-style Documentation ###
158
# Build the documentation. To keep the dependencies down to a minimum
159
# for distro packagers, we only build the html documentation by default.
160
# Sphinx 0.6 or later is preferred for the best rendering, though
161
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
162
# for installation instructions.
163
docs-sphinx: html-sphinx
165
# Clean out generated documentation
167
cd doc/en && make clean
168
cd doc/developers && make clean
170
SPHINX_DEPENDENCIES = \
171
doc/en/release-notes/index.txt \
172
doc/en/user-reference/index.txt \
173
doc/developers/Makefile \
174
doc/developers/make.bat
176
NEWS_FILES = $(call sw,doc/en/release-notes/brz-*.txt)
178
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
179
LANGUAGE=C $(PYTHON) tools/generate_docs.py -o $@ rstx
181
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
182
$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
184
doc/%/Makefile: doc/en/Makefile
185
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
187
doc/%/make.bat: doc/en/make.bat
188
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
190
# Build the html docs using Sphinx.
191
html-sphinx: $(SPHINX_DEPENDENCIES)
192
cd doc/en && make html
193
cd doc/developers && make html
195
# Build the PDF docs using Sphinx. This requires numerous LaTeX
196
# packages. See http://sphinx.pocoo.org/builders.html for details.
197
# Note: We don't currently build PDFs for the Russian docs because
198
# they require additional packages to be installed (to handle
199
# Russian hyphenation rules, etc.)
200
pdf-sphinx: $(SPHINX_DEPENDENCIES)
201
cd doc/en && make latex
202
cd doc/developers && make latex
203
cd doc/en/_build/latex && make all-pdf
204
cd doc/developers/_build/latex && make all-pdf
206
# Build the CHM (Windows Help) docs using Sphinx.
207
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
208
# to generate the final chm files.
209
chm-sphinx: $(SPHINX_DEPENDENCIES)
210
cd doc/en && make htmlhelp
211
cd doc/developers && make htmlhelp
214
# Build the texinfo files using Sphinx.
215
texinfo-sphinx: $(SPHINX_DEPENDENCIES)
216
cd doc/en && make texinfo
217
cd doc/developers && make texinfo
219
### Documentation Website ###
221
# Where to build the website
222
DOC_WEBSITE_BUILD = build_doc_website
224
# Build and package docs into a website, complete with downloads.
225
doc-website: html-sphinx pdf-sphinx
226
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
227
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
230
### Plain Documentation ###
232
# While Sphinx is the preferred tool for building documentation, we still
233
# support our "plain" html documentation so that Sphinx is not a hard
234
# dependency for packagers on older platforms.
236
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
238
# translate txt docs to html
239
derived_txt_files = \
240
doc/en/release-notes/NEWS.txt
242
doc/en/tutorials/tutorial.txt \
243
doc/en/tutorials/using_breezy_with_launchpad.txt \
244
doc/en/tutorials/centralized_workflow.txt \
245
$(call sw,doc/*/mini-tutorial/index.txt) \
246
$(call sw,doc/*/user-guide/index-plain.txt) \
247
doc/en/admin-guide/index-plain.txt \
248
$(call sw,doc/es/guia-usario/*.txt) \
249
$(derived_txt_files) \
250
doc/en/upgrade-guide/index.txt \
252
$(call sw,doc/index.*.txt)
254
doc/en/user-guide/index.txt \
255
doc/en/admin-guide/index.txt
256
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
257
htm_files = $(patsubst %.txt, %.html, $(txt_files))
261
$(call sw,doc/*/brz-en-quick-reference.svg) \
262
$(call sw,doc/*/brz-en-quick-reference.png) \
263
$(call sw,doc/*/brz-en-quick-reference.pdf) \
264
$(call sw,doc/*/bzr-es-quick-reference.svg) \
265
$(call sw,doc/*/bzr-es-quick-reference.png) \
266
$(call sw,doc/*/bzr-es-quick-reference.pdf) \
267
$(call sw,doc/*/bzr-ru-quick-reference.svg) \
268
$(call sw,doc/*/bzr-ru-quick-reference.png) \
269
$(call sw,doc/*/bzr-ru-quick-reference.pdf) \
270
$(call sw,doc/*/user-guide/images/*.png)
272
# doc/developers/*.txt files that should *not* be individually
275
doc/developers/add.txt \
276
doc/developers/annotate.txt \
277
doc/developers/bundle-creation.txt \
278
doc/developers/commit.txt \
279
doc/developers/diff.txt \
280
doc/developers/directory-fingerprints.txt \
281
doc/developers/gc.txt \
282
doc/developers/implementation-notes.txt \
283
doc/developers/incremental-push-pull.txt \
284
doc/developers/index.txt \
285
doc/developers/initial-push-pull.txt \
286
doc/developers/merge-scaling.txt \
287
doc/developers/miscellaneous-notes.txt \
288
doc/developers/missing.txt \
289
doc/developers/performance-roadmap-rationale.txt \
290
doc/developers/performance-use-case-analysis.txt \
291
doc/developers/planned-change-integration.txt \
292
doc/developers/planned-performance-changes.txt \
293
doc/developers/plans.txt \
294
doc/developers/process.txt \
295
doc/developers/revert.txt \
296
doc/developers/specifications.txt \
297
doc/developers/status.txt \
298
doc/developers/uncommit.txt
300
dev_txt_all = $(call sw,$(addsuffix /*.txt, doc/developers))
301
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
302
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
304
doc/en/user-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/user-guide))
305
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
307
#doc/es/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/es/user-guide))
308
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
310
#doc/ru/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/ru/user-guide))
311
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
313
doc/en/admin-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/admin-guide))
314
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
316
doc/developers/%.html: doc/developers/%.txt
317
$(rst2html) --stylesheet=../default.css $< $@
319
doc/index.html: doc/index.txt
320
$(rst2html) --stylesheet=default.css $< $@
322
doc/index.%.html: doc/index.%.txt
323
$(rst2html) --stylesheet=default.css $< $@
326
$(rst2html) --stylesheet=../../default.css $< "$@"
328
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
329
$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
331
upgrade_guide_dependencies = $(call sw,$(addsuffix /*.txt, doc/en/upgrade-guide))
333
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
334
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
336
derived_web_docs = $(htm_files) $(dev_htm_files)
337
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
338
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
340
# the main target to build all the docs
341
docs-plain: $(ALL_DOCS)
343
# produce a tree containing just the final docs, ready for uploading to the web
345
html-plain: docs-plain
346
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
348
# clean produced docs
350
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
351
$(HTMLDIR) $(derived_txt_files)
354
### Miscellaneous Documentation Targets ###
356
# build a png of our performance task list
357
# this is no longer built by default; you can build it if you want to look at it
358
doc/developers/performance.png: doc/developers/performance.dot
360
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
363
### Windows Support ###
365
# make all the installers completely from scratch, using zc.buildout
366
# to fetch the dependencies
367
# These are files that need to be copied into the build location to boostrap
369
# Note that the path is relative to tools/win32
370
BUILDOUT_FILES = buildout.cfg \
371
buildout-templates/bin/build-installer.bat.in \
372
ostools.py bootstrap.py
375
@echo Make all the installers from scratch
376
@# Build everything in a separate directory, to avoid cluttering the WT
377
$(PYTHON) tools/win32/ostools.py makedir build-win32
378
@# cd to tools/win32 so that the relative paths are copied correctly
379
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
380
@# There seems to be a bug in gf.release.brz, It doesn't correctly update
381
@# existing release directories, so delete them manually before building
382
@# It means things may be rebuilt that don't need to be, but at least
383
@# it will be correct when they do.
384
cd build-win32 && $(PYTHON) ostools.py remove release */release
385
cd build-win32 && $(PYTHON) bootstrap.py
386
cd build-win32 && bin/buildout
387
cd build-win32 && bin/build-installer.bat $(BRZ_TARGET) $(PLUGIN_TARGET)
391
$(PYTHON) tools/win32/ostools.py remove build-win32
393
# make brz.exe for win32 with py2exe
395
@echo *** Make brz.exe
396
$(PYTHON) tools/win32/ostools.py remove breezy/*.pyd
397
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
398
$(PYTHON) setup.py py2exe > py2exe.log
399
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_brz.bat win32_brz.exe
400
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_brz.exe
402
# win32 installer for brz.exe
403
installer: exe copy-docs
404
@echo *** Make Windows installer
405
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/brz.iss tools/win32/brz.iss.cog
406
iscc /Q tools/win32/brz.iss
408
# win32 Python's distutils-based installer
409
# require to have Python interpreter installed on win32
411
$(PYTHON24) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
414
$(PYTHON25) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
417
$(PYTHON26) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
419
python-installer: py-inst-24 py-inst-25 py-inst-26
423
$(PYTHON) tools/win32/ostools.py copytodir README win32_brz.exe/doc
424
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_brz.exe
426
# clean on win32 all installer-related files and directories
427
clean-win32: clean-docs
428
$(PYTHON) tools/win32/ostools.py remove build
429
$(PYTHON) tools/win32/ostools.py remove win32_brz.exe
430
$(PYTHON) tools/win32/ostools.py remove py2exe.log
431
$(PYTHON) tools/win32/ostools.py remove tools/win32/brz.iss
432
$(PYTHON) tools/win32/ostools.py remove brz-setup*.exe
433
$(PYTHON) tools/win32/ostools.py remove brz-*win32.exe
434
$(PYTHON) tools/win32/ostools.py remove dist
439
.PHONY: update-pot po/brz.pot
440
update-pot: po/brz.pot
442
TRANSLATABLE_PYFILES:=$(shell find breezy -name '*.py' \
443
| grep -v 'breezy/tests/' \
444
| grep -v 'breezy/doc' \
447
po/brz.pot: $(PYFILES) $(DOCFILES)
448
$(PYTHON) ./brz export-pot --include-duplicates > po/brz.pot
449
echo $(TRANSLATABLE_PYFILES) | xargs \
450
xgettext --package-name "brz" \
451
--msgid-bugs-address "<bazaar@canonical.com>" \
452
--copyright-holder "Canonical" \
453
--from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \
454
-d bzr -p po -o brz.pot
457
### Packaging Targets ###
459
.PHONY: dist check-dist-tarball
461
# build a distribution source tarball
463
version=`./brz version --short` && \
464
echo Building distribution of brz $$version && \
465
expbasedir=`mktemp -t -d tmp_brz_dist.XXXXXXXXXX` && \
466
expdir=$$expbasedir/brz-$$version && \
467
tarball=$$PWD/../brz-$$version.tar.gz && \
470
$(PYTHON) setup.py sdist -d $$PWD/.. && \
471
gpg --detach-sign --armor $$tarball && \
474
# run all tests in a previously built tarball
476
tmpdir=`mktemp -t -d tmp_brz_check_dist.XXXXXXXXXX` && \
477
version=`./brz version --short` && \
478
tarball=$$PWD/../brz-$$version.tar.gz && \
479
tar Cxz $$tmpdir -f $$tarball && \
480
$(MAKE) -C $$tmpdir/brz-$$version check && \
added
removed
Makefile
