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.
30
PLUGIN_TARGET=plugin-release
32
BRZ_PLUGIN_PATH=-site:-user
34
# Shorter replacement for $(sort $(wildcard <arg>)) as $(call sw,<arg>)
35
sw = $(sort $(wildcard $(1)))
38
.PHONY: all clean realclean extensions pyflakes api-docs check-nodocs check
43
@echo "building extension modules."
44
$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
46
check: docs check-nodocs
48
check-nodocs: check-nodocs2 check-nodocs3
51
# Generate a stream for PQM to watch.
52
-$(RM) -f selftest.log
53
echo `date` ": selftest starts" 1>&2
54
set -o pipefail; BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::ImportWarning -Wignore::PendingDeprecationWarning -Wignore::DeprecationWarning -O \
55
./brz selftest -Oselftest.timeout=120 --load-list=python3.passing \
56
--subunit2 $(tests) | tee selftest.log | subunit-2to1
57
echo `date` ": selftest ends" 1>&2
58
# An empty log file should catch errors in the $(PYTHON3)
59
# command above (the '|' swallow any errors since 'make'
60
# sees the 'tee' exit code for the whole line
61
if [ ! -s selftest.log ] ; then exit 1 ; fi
62
# Check that there were no errors reported.
63
subunit-stats < selftest.log
65
update-python3-passing:
66
# Generate a stream for PQM to watch.
67
-$(RM) -f selftest.log
68
-BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
69
./brz selftest -Oselftest.timeout=120 \
70
--subunit2 $(tests) > selftest.log
71
grep -v "^#" python3.passing > python3.passing.new
73
subunit-filter --no-failure --no-error --success | \
74
subunit-ls --no-passthrough >> python3.passing.new
75
cp python3.passing python3.passing.old
76
grep "^#" python3.passing.old > python3.passing
77
sort -u python3.passing.new >> python3.passing
79
check-nodocs2: extensions
80
# Generate a stream for PQM to watch.
81
-$(RM) -f selftest.log
82
echo `date` ": selftest starts" 1>&2
83
set -o pipefail; BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
84
./brz selftest -Oselftest.timeout=120 \
85
--subunit2 $(tests) | tee selftest.log | subunit-2to1
86
echo `date` ": selftest ends" 1>&2
87
# An empty log file should catch errors in the $(PYTHON)
88
# command above (the '|' swallow any errors since 'make'
89
# sees the 'tee' exit code for the whole line
90
if [ ! -s selftest.log ] ; then exit 1 ; fi
91
# Check that there were no errors reported.
92
subunit-stats < selftest.log
94
check-ci: docs extensions
95
# FIXME: Remove -Wignore::FutureWarning once
96
# https://github.com/paramiko/paramiko/issues/713 is not a concern
97
# anymore -- vila 2017-05-24
99
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON) -Werror -Wignore::FutureWarning -Wignore::DeprecationWarning -Wignore::ImportWarning -Wignore::ResourceWarning -O \
100
./brz selftest -v --parallel=fork -Oselftest.timeout=120 --subunit2 \
101
| subunit-filter -s --passthrough --rename "^" "python2."; \
102
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::FutureWarning -Wignore::DeprecationWarning -Wignore::PendingDeprecationWarning -Wignore::ImportWarning -O \
103
./brz selftest -v --parallel=fork -Oselftest.timeout=120 --load-list=python3.passing --subunit2 \
104
| subunit-filter -s --passthrough --rename "^" "python3."
106
# Run Python style checker (apt-get install pyflakes)
108
# Note that at present this gives many false warnings, because it doesn't
109
# know about identifiers loaded through lazy_import.
114
# There are many of these warnings at the moment and they're not a
115
# high priority to fix
116
pyflakes breezy | grep -v ' imported but unused'
119
$(PYTHON) setup.py clean
120
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
123
# Remove files which are autogenerated but included by the tarball.
125
rm -f breezy/_simple_set_pyx.h breezy/_simple_set_pyx_api.h
127
# Build API documentation
128
docfiles = brz breezy
131
pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)
133
# build tags for emacs and vim
140
# these are treated as phony so they'll always be rebuilt - it's pretty quick
144
### Documentation ###
146
# Default to plain documentation for maximum backwards compatibility.
147
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
151
clean-docs: clean-plain
153
html-docs: html-plain
156
### Man-page Documentation ###
158
MAN_DEPENDENCIES = breezy/builtins.py \
159
$(call sw,breezy/*.py) \
160
$(call sw,breezy/*/*.py) \
161
tools/generate_docs.py \
162
$(call sw,$(addsuffix /*.txt, breezy/help_topics/en))
164
MAN_PAGES = man1/brz.1
165
man1/brz.1: $(MAN_DEPENDENCIES)
167
$(PYTHON) tools/generate_docs.py -o $@ man
170
### Sphinx-style Documentation ###
172
# Build the documentation. To keep the dependencies down to a minimum
173
# for distro packagers, we only build the html documentation by default.
174
# Sphinx 0.6 or later is preferred for the best rendering, though
175
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
176
# for installation instructions.
177
docs-sphinx: html-sphinx
179
# Clean out generated documentation
181
cd doc/en && make clean
182
cd doc/developers && make clean
184
SPHINX_DEPENDENCIES = \
185
doc/en/release-notes/index.txt \
186
doc/en/user-reference/index.txt \
187
doc/developers/Makefile \
188
doc/developers/make.bat
190
NEWS_FILES = $(call sw,doc/en/release-notes/brz-*.txt)
192
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
193
LANGUAGE=C $(PYTHON) tools/generate_docs.py -o $@ rstx
195
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
196
$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
198
doc/%/Makefile: doc/en/Makefile
199
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
201
doc/%/make.bat: doc/en/make.bat
202
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
204
# Build the html docs using Sphinx.
205
html-sphinx: $(SPHINX_DEPENDENCIES)
206
cd doc/en && make html
207
cd doc/developers && make html
209
# Build the PDF docs using Sphinx. This requires numerous LaTeX
210
# packages. See http://sphinx.pocoo.org/builders.html for details.
211
# Note: We don't currently build PDFs for the Russian docs because
212
# they require additional packages to be installed (to handle
213
# Russian hyphenation rules, etc.)
214
pdf-sphinx: $(SPHINX_DEPENDENCIES)
215
cd doc/en && make latex
216
cd doc/developers && make latex
217
cd doc/en/_build/latex && make all-pdf
218
cd doc/developers/_build/latex && make all-pdf
220
# Build the CHM (Windows Help) docs using Sphinx.
221
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
222
# to generate the final chm files.
223
chm-sphinx: $(SPHINX_DEPENDENCIES)
224
cd doc/en && make htmlhelp
225
cd doc/developers && make htmlhelp
228
# Build the texinfo files using Sphinx.
229
texinfo-sphinx: $(SPHINX_DEPENDENCIES)
230
cd doc/en && make texinfo
231
cd doc/developers && make texinfo
233
### Documentation Website ###
235
# Where to build the website
236
DOC_WEBSITE_BUILD = build_doc_website
238
# Build and package docs into a website, complete with downloads.
239
doc-website: html-sphinx pdf-sphinx
240
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
241
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
244
### Plain Documentation ###
246
# While Sphinx is the preferred tool for building documentation, we still
247
# support our "plain" html documentation so that Sphinx is not a hard
248
# dependency for packagers on older platforms.
250
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
252
# translate txt docs to html
253
derived_txt_files = \
254
doc/en/release-notes/NEWS.txt
256
doc/en/tutorials/tutorial.txt \
257
doc/en/tutorials/using_breezy_with_launchpad.txt \
258
doc/en/tutorials/centralized_workflow.txt \
259
$(call sw,doc/*/mini-tutorial/index.txt) \
260
$(call sw,doc/*/user-guide/index-plain.txt) \
261
doc/en/admin-guide/index-plain.txt \
262
$(call sw,doc/es/guia-usario/*.txt) \
263
$(derived_txt_files) \
264
doc/en/upgrade-guide/index.txt \
266
$(call sw,doc/index.*.txt)
268
doc/en/user-guide/index.txt \
269
doc/en/admin-guide/index.txt
270
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
271
htm_files = $(patsubst %.txt, %.html, $(txt_files))
275
$(call sw,doc/*/brz-en-quick-reference.svg) \
276
$(call sw,doc/*/brz-en-quick-reference.png) \
277
$(call sw,doc/*/brz-en-quick-reference.pdf) \
278
$(call sw,doc/*/bzr-es-quick-reference.svg) \
279
$(call sw,doc/*/bzr-es-quick-reference.png) \
280
$(call sw,doc/*/bzr-es-quick-reference.pdf) \
281
$(call sw,doc/*/bzr-ru-quick-reference.svg) \
282
$(call sw,doc/*/bzr-ru-quick-reference.png) \
283
$(call sw,doc/*/bzr-ru-quick-reference.pdf) \
284
$(call sw,doc/*/user-guide/images/*.png)
286
# doc/developers/*.txt files that should *not* be individually
289
doc/developers/add.txt \
290
doc/developers/annotate.txt \
291
doc/developers/bundle-creation.txt \
292
doc/developers/commit.txt \
293
doc/developers/diff.txt \
294
doc/developers/directory-fingerprints.txt \
295
doc/developers/gc.txt \
296
doc/developers/implementation-notes.txt \
297
doc/developers/incremental-push-pull.txt \
298
doc/developers/index.txt \
299
doc/developers/initial-push-pull.txt \
300
doc/developers/merge-scaling.txt \
301
doc/developers/miscellaneous-notes.txt \
302
doc/developers/missing.txt \
303
doc/developers/performance-roadmap-rationale.txt \
304
doc/developers/performance-use-case-analysis.txt \
305
doc/developers/planned-change-integration.txt \
306
doc/developers/planned-performance-changes.txt \
307
doc/developers/plans.txt \
308
doc/developers/process.txt \
309
doc/developers/revert.txt \
310
doc/developers/specifications.txt \
311
doc/developers/status.txt \
312
doc/developers/uncommit.txt
314
dev_txt_all = $(call sw,$(addsuffix /*.txt, doc/developers))
315
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
316
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
318
doc/en/user-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/user-guide))
319
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
321
#doc/es/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/es/user-guide))
322
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
324
#doc/ru/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/ru/user-guide))
325
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
327
doc/en/admin-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/admin-guide))
328
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
330
doc/developers/%.html: doc/developers/%.txt
331
$(rst2html) --stylesheet=../default.css $< $@
333
doc/index.html: doc/index.txt
334
$(rst2html) --stylesheet=default.css $< $@
336
doc/index.%.html: doc/index.%.txt
337
$(rst2html) --stylesheet=default.css $< $@
340
$(rst2html) --stylesheet=../../default.css $< "$@"
342
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
343
$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
345
upgrade_guide_dependencies = $(call sw,$(addsuffix /*.txt, doc/en/upgrade-guide))
347
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
348
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
350
derived_web_docs = $(htm_files) $(dev_htm_files)
351
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
352
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
354
# the main target to build all the docs
355
docs-plain: $(ALL_DOCS)
357
# produce a tree containing just the final docs, ready for uploading to the web
359
html-plain: docs-plain
360
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
362
# clean produced docs
364
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
365
$(HTMLDIR) $(derived_txt_files)
368
### Miscellaneous Documentation Targets ###
370
# build a png of our performance task list
371
# this is no longer built by default; you can build it if you want to look at it
372
doc/developers/performance.png: doc/developers/performance.dot
374
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
377
### Windows Support ###
379
# make all the installers completely from scratch, using zc.buildout
380
# to fetch the dependencies
381
# These are files that need to be copied into the build location to boostrap
383
# Note that the path is relative to tools/win32
384
BUILDOUT_FILES = buildout.cfg \
385
buildout-templates/bin/build-installer.bat.in \
386
ostools.py bootstrap.py
389
@echo Make all the installers from scratch
390
@# Build everything in a separate directory, to avoid cluttering the WT
391
$(PYTHON) tools/win32/ostools.py makedir build-win32
392
@# cd to tools/win32 so that the relative paths are copied correctly
393
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
394
@# There seems to be a bug in gf.release.brz, It doesn't correctly update
395
@# existing release directories, so delete them manually before building
396
@# It means things may be rebuilt that don't need to be, but at least
397
@# it will be correct when they do.
398
cd build-win32 && $(PYTHON) ostools.py remove release */release
399
cd build-win32 && $(PYTHON) bootstrap.py
400
cd build-win32 && bin/buildout
401
cd build-win32 && bin/build-installer.bat $(BRZ_TARGET) $(PLUGIN_TARGET)
405
$(PYTHON) tools/win32/ostools.py remove build-win32
407
# make brz.exe for win32 with py2exe
409
@echo *** Make brz.exe
410
$(PYTHON) tools/win32/ostools.py remove breezy/*.pyd
411
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
412
$(PYTHON) setup.py py2exe > py2exe.log
413
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_brz.bat win32_brz.exe
414
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_brz.exe
416
# win32 installer for brz.exe
417
installer: exe copy-docs
418
@echo *** Make Windows installer
419
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/brz.iss tools/win32/brz.iss.cog
420
iscc /Q tools/win32/brz.iss
422
# win32 Python's distutils-based installer
423
# require to have Python interpreter installed on win32
425
$(PYTHON24) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
428
$(PYTHON25) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
431
$(PYTHON26) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
433
python-installer: py-inst-24 py-inst-25 py-inst-26
437
$(PYTHON) tools/win32/ostools.py copytodir README win32_brz.exe/doc
438
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_brz.exe
440
# clean on win32 all installer-related files and directories
441
clean-win32: clean-docs
442
$(PYTHON) tools/win32/ostools.py remove build
443
$(PYTHON) tools/win32/ostools.py remove win32_brz.exe
444
$(PYTHON) tools/win32/ostools.py remove py2exe.log
445
$(PYTHON) tools/win32/ostools.py remove tools/win32/brz.iss
446
$(PYTHON) tools/win32/ostools.py remove brz-setup*.exe
447
$(PYTHON) tools/win32/ostools.py remove brz-*win32.exe
448
$(PYTHON) tools/win32/ostools.py remove dist
453
.PHONY: update-pot po/brz.pot
454
update-pot: po/brz.pot
456
TRANSLATABLE_PYFILES:=$(shell find breezy -name '*.py' \
457
| grep -v 'breezy/tests/' \
458
| grep -v 'breezy/doc' \
461
po/brz.pot: $(PYFILES) $(DOCFILES)
462
$(PYTHON) ./brz export-pot --include-duplicates > po/brz.pot
463
echo $(TRANSLATABLE_PYFILES) | xargs \
464
xgettext --package-name "brz" \
465
--msgid-bugs-address "<bazaar@canonical.com>" \
466
--copyright-holder "Canonical" \
467
--from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \
468
-d bzr -p po -o brz.pot
471
### Packaging Targets ###
473
.PHONY: dist check-dist-tarball
475
# build a distribution source tarball
477
version=`./brz version --short` && \
478
echo Building distribution of brz $$version && \
479
expbasedir=`mktemp -t -d tmp_brz_dist.XXXXXXXXXX` && \
480
expdir=$$expbasedir/brz-$$version && \
481
tarball=$$PWD/../brz-$$version.tar.gz && \
484
$(PYTHON) setup.py sdist -d $$PWD/.. && \
485
gpg --detach-sign --armor $$tarball && \
488
# run all tests in a previously built tarball
490
tmpdir=`mktemp -t -d tmp_brz_check_dist.XXXXXXXXXX` && \
491
version=`./brz version --short` && \
492
tarball=$$PWD/../brz-$$version.tar.gz && \
493
tar Cxz $$tmpdir -f $$tarball && \
494
$(MAKE) -C $$tmpdir/brz-$$version check && \
added
removed
Makefile
