39
46
check: docs check-nodocs
41
check-nodocs: extensions
42
# Generate a stream for PQM to watch.
43
$(PYTHON) -Werror -O ./bzr selftest --subunit $(tests) | tee selftest.log
44
# Check that there were no errors reported.
45
subunit-stats < selftest.log
47
# Run Python style checker (apt-get install pyflakes)
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 --strict \
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
check-nodocs2: extensions
66
# Generate a stream for PQM to watch.
67
-$(RM) -f selftest.log
68
echo `date` ": selftest starts" 1>&2
69
set -o pipefail; BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON) -Werror -Wignore::ImportWarning -Wignore::DeprecationWarning -O \
70
./brz selftest -Oselftest.timeout=120 \
71
--subunit2 $(tests) | tee selftest.log | subunit-2to1
72
echo `date` ": selftest ends" 1>&2
73
# An empty log file should catch errors in the $(PYTHON)
74
# command above (the '|' swallow any errors since 'make'
75
# sees the 'tee' exit code for the whole line
76
if [ ! -s selftest.log ] ; then exit 1 ; fi
77
# Check that there were no errors reported.
78
subunit-stats < selftest.log
80
check-ci: docs extensions
81
# FIXME: Remove -Wignore::FutureWarning once
82
# https://github.com/paramiko/paramiko/issues/713 is not a concern
83
# anymore -- vila 2017-05-24
85
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON) -Werror -Wignore::FutureWarning -Wignore::DeprecationWarning -Wignore::ImportWarning -Wignore::ResourceWarning -O \
86
./brz selftest -v --parallel=fork -Oselftest.timeout=120 --subunit2 \
87
| subunit-filter -s --passthrough --rename "^" "python2."; \
88
BRZ_PLUGIN_PATH=$(BRZ_PLUGIN_PATH) $(PYTHON3) -Werror -Wignore::FutureWarning -Wignore::DeprecationWarning -Wignore::PendingDeprecationWarning -Wignore::ImportWarning -Wignore::ResourceWarning -O \
89
./brz selftest -v --parallel=fork -Oselftest.timeout=120 --subunit2 \
90
| subunit-filter -s --passthrough --rename "^" "python3."
92
# Run Python style checker (apt-get install flake8)
49
94
# Note that at present this gives many false warnings, because it doesn't
50
95
# know about identifiers loaded through lazy_import.
55
# There are many of these warnings at the moment and they're not a
56
# high priority to fix
57
pyflakes bzrlib | grep -v ' imported but unused'
60
100
$(PYTHON) setup.py clean
61
101
-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
63
# Build API documentation
67
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
69
PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
104
# Remove files which are autogenerated but included by the tarball.
105
rm -f breezy/*_pyx.c breezy/bzr/*_pyx.c
106
rm -f breezy/_simple_set_pyx.h breezy/_simple_set_pyx_api.h
71
108
# build tags for emacs and vim
78
115
# these are treated as phony so they'll always be rebuilt - it's pretty quick
159
184
# they require additional packages to be installed (to handle
160
185
# Russian hyphenation rules, etc.)
161
186
pdf-sphinx: $(SPHINX_DEPENDENCIES)
162
cd doc/en && make latex
163
cd doc/es && make latex
164
cd doc/ja && make latex
165
cd doc/developers && make latex
166
cd doc/en/_build/latex && make all-pdf
167
cd doc/es/_build/latex && make all-pdf
168
cd doc/developers/_build/latex && make all-pdf
187
$(MAKE) -C doc/en latex
188
$(MAKE) -C doc/developers latex
189
$(MAKE) -C doc/en/_build/latex all-pdf
190
$(MAKE) -C doc/developers/_build/latex all-pdf
170
192
# Build the CHM (Windows Help) docs using Sphinx.
171
193
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
172
194
# to generate the final chm files.
173
195
chm-sphinx: $(SPHINX_DEPENDENCIES)
174
cd doc/en && make htmlhelp
175
cd doc/es && make htmlhelp
176
cd doc/ru && make htmlhelp
177
cd doc/ja && make htmlhelp
178
cd doc/developers && make htmlhelp
196
$(MAKE) -C doc/en htmlhelp
197
$(MAKE) -C doc/developers htmlhelp
200
# Build the texinfo files using Sphinx.
201
texinfo-sphinx: $(SPHINX_DEPENDENCIES)
202
$(MAKE) -C doc/en texinfo
203
$(MAKE) -C doc/developers texinfo
181
205
### Documentation Website ###
186
210
# Build and package docs into a website, complete with downloads.
187
211
doc-website: html-sphinx pdf-sphinx
188
212
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
189
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
190
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
191
$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
192
213
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
195
### Plain Documentation ###
197
# While Sphinx is the preferred tool for building documentation, we still
198
# support our "plain" html documentation so that Sphinx is not a hard
199
# dependency for packagers on older platforms.
201
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
203
# translate txt docs to html
204
derived_txt_files = \
205
doc/en/release-notes/NEWS.txt
207
doc/en/tutorials/tutorial.txt \
208
doc/en/tutorials/using_bazaar_with_launchpad.txt \
209
doc/en/tutorials/centralized_workflow.txt \
210
$(wildcard doc/es/tutorials/*.txt) \
211
$(wildcard doc/ru/tutorials/*.txt) \
212
doc/ja/tutorials/tutorial.txt \
213
doc/ja/tutorials/using_bazaar_with_launchpad.txt \
214
doc/ja/tutorials/centralized_workflow.txt \
215
$(wildcard doc/*/mini-tutorial/index.txt) \
216
$(wildcard doc/*/user-guide/index-plain.txt) \
217
doc/en/admin-guide/index-plain.txt \
218
$(wildcard doc/es/guia-usario/*.txt) \
219
$(derived_txt_files) \
220
doc/en/upgrade-guide/index.txt \
222
$(wildcard doc/index.*.txt)
224
doc/en/user-guide/index.txt \
225
doc/es/user-guide/index.txt \
226
doc/ja/user-guide/index.txt \
227
doc/ru/user-guide/index.txt \
228
doc/en/admin-guide/index.txt
229
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
230
htm_files = $(patsubst %.txt, %.html, $(txt_files))
234
$(wildcard doc/*/bzr-en-quick-reference.svg) \
235
$(wildcard doc/*/bzr-en-quick-reference.png) \
236
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
237
$(wildcard doc/*/bzr-es-quick-reference.svg) \
238
$(wildcard doc/*/bzr-es-quick-reference.png) \
239
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
240
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
241
$(wildcard doc/*/bzr-ru-quick-reference.png) \
242
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
243
$(wildcard doc/*/user-guide/images/*.png)
245
# doc/developers/*.txt files that should *not* be individually
248
doc/developers/add.txt \
249
doc/developers/annotate.txt \
250
doc/developers/bundle-creation.txt \
251
doc/developers/commit.txt \
252
doc/developers/diff.txt \
253
doc/developers/directory-fingerprints.txt \
254
doc/developers/gc.txt \
255
doc/developers/implementation-notes.txt \
256
doc/developers/incremental-push-pull.txt \
257
doc/developers/index.txt \
258
doc/developers/initial-push-pull.txt \
259
doc/developers/merge-scaling.txt \
260
doc/developers/miscellaneous-notes.txt \
261
doc/developers/missing.txt \
262
doc/developers/performance-roadmap-rationale.txt \
263
doc/developers/performance-use-case-analysis.txt \
264
doc/developers/planned-change-integration.txt \
265
doc/developers/planned-performance-changes.txt \
266
doc/developers/plans.txt \
267
doc/developers/process.txt \
268
doc/developers/revert.txt \
269
doc/developers/specifications.txt \
270
doc/developers/status.txt \
271
doc/developers/uncommit.txt
273
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
274
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
275
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
277
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
278
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
280
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
281
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
283
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
284
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
286
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide))
287
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
289
doc/developers/%.html: doc/developers/%.txt
290
$(rst2html) --stylesheet=../default.css $< $@
292
doc/index.html: doc/index.txt
293
$(rst2html) --stylesheet=default.css $< $@
295
doc/index.%.html: doc/index.%.txt
296
$(rst2html) --stylesheet=default.css $< $@
299
$(rst2html) --stylesheet=../../default.css $< $@
301
doc/en/release-notes/NEWS.txt: NEWS
302
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
304
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
306
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
307
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
309
derived_web_docs = $(htm_files) $(dev_htm_files)
310
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
311
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
313
# the main target to build all the docs
314
docs-plain: $(ALL_DOCS)
316
# produce a tree containing just the final docs, ready for uploading to the web
318
html-plain: docs-plain
319
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
321
# clean produced docs
323
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
324
$(HTMLDIR) $(derived_txt_files)
327
216
### Miscellaneous Documentation Targets ###
329
218
# build a png of our performance task list
350
239
$(PYTHON) tools/win32/ostools.py makedir build-win32
351
240
@# cd to tools/win32 so that the relative paths are copied correctly
352
241
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
353
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
242
@# There seems to be a bug in gf.release.brz, It doesn't correctly update
354
243
@# existing release directories, so delete them manually before building
355
244
@# It means things may be rebuilt that don't need to be, but at least
356
245
@# it will be correct when they do.
357
246
cd build-win32 && $(PYTHON) ostools.py remove release */release
358
247
cd build-win32 && $(PYTHON) bootstrap.py
359
248
cd build-win32 && bin/buildout
360
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
249
cd build-win32 && bin/build-installer.bat $(BRZ_TARGET) $(PLUGIN_TARGET)
363
252
clean-installer-all:
364
253
$(PYTHON) tools/win32/ostools.py remove build-win32
366
# make bzr.exe for win32 with py2exe
255
# make brz.exe for win32 with py2exe
368
@echo *** Make bzr.exe
369
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
257
@echo *** Make brz.exe
258
$(PYTHON) tools/win32/ostools.py remove breezy/*.pyd
370
259
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
371
260
$(PYTHON) setup.py py2exe > py2exe.log
372
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
373
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
261
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_brz.bat win32_brz.exe
262
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_brz.exe
375
# win32 installer for bzr.exe
264
# win32 installer for brz.exe
376
265
installer: exe copy-docs
377
266
@echo *** Make Windows installer
378
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
379
iscc /Q tools/win32/bzr.iss
267
$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/brz.iss tools/win32/brz.iss.cog
268
iscc /Q tools/win32/brz.iss
381
270
# win32 Python's distutils-based installer
382
271
# require to have Python interpreter installed on win32
384
$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
273
$(PYTHON24) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
387
$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
276
$(PYTHON25) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
390
$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
279
$(PYTHON26) setup.py bdist_wininst --install-script="brz-win32-bdist-postinstall.py" -d .
392
281
python-installer: py-inst-24 py-inst-25 py-inst-26
396
$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
397
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
285
$(PYTHON) tools/win32/ostools.py copytodir README win32_brz.exe/doc
286
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_brz.exe
399
288
# clean on win32 all installer-related files and directories
400
289
clean-win32: clean-docs
401
290
$(PYTHON) tools/win32/ostools.py remove build
402
$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
291
$(PYTHON) tools/win32/ostools.py remove win32_brz.exe
403
292
$(PYTHON) tools/win32/ostools.py remove py2exe.log
404
$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
405
$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
406
$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
293
$(PYTHON) tools/win32/ostools.py remove tools/win32/brz.iss
294
$(PYTHON) tools/win32/ostools.py remove brz-setup*.exe
295
$(PYTHON) tools/win32/ostools.py remove brz-*win32.exe
407
296
$(PYTHON) tools/win32/ostools.py remove dist
301
.PHONY: update-pot po/brz.pot
302
update-pot: po/brz.pot
304
TRANSLATABLE_PYFILES:=$(shell find breezy -name '*.py' \
305
| grep -v 'breezy/tests/' \
306
| grep -v 'breezy/doc' \
309
po/brz.pot: $(PYFILES) $(DOCFILES)
310
$(PYTHON) ./brz export-pot --include-duplicates > po/brz.pot
311
echo $(TRANSLATABLE_PYFILES) | xargs \
312
xgettext --package-name "brz" \
313
--msgid-bugs-address "<bazaar@canonical.com>" \
314
--copyright-holder "Canonical" \
315
--from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \
316
-d bzr -p po -o brz.pot
410
319
### Packaging Targets ###
412
321
.PHONY: dist check-dist-tarball
414
323
# build a distribution source tarball
416
# this method of copying the pyrex generated files is a bit ugly; it would be
417
# nicer to generate it from distutils.
419
version=`./bzr version --short` && \
420
echo Building distribution of bzr $$version && \
421
expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
422
expdir=$$expbasedir/bzr-$$version && \
423
tarball=$$PWD/../bzr-$$version.tar.gz && \
325
version=`./brz version --short` && \
326
echo Building distribution of brz $$version && \
327
expbasedir=`mktemp -t -d tmp_brz_dist.XXXXXXXXXX` && \
328
expdir=$$expbasedir/brz-$$version && \
329
tarball=$$PWD/../breezy-$$version.tar.gz && \
424
330
$(MAKE) clean && \
426
bzr export $$expdir && \
427
cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
428
tar cfz $$tarball -C $$expbasedir bzr-$$version && \
429
gpg --detach-sign $$tarball && \
332
$(PYTHON) setup.py sdist -d $$PWD/.. && \
333
gpg --detach-sign --armor $$tarball && \
430
334
rm -rf $$expbasedir
432
336
# run all tests in a previously built tarball
433
337
check-dist-tarball:
434
tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
435
version=`./bzr version --short` && \
436
tarball=$$PWD/../bzr-$$version.tar.gz && \
338
tmpdir=`mktemp -t -d tmp_brz_check_dist.XXXXXXXXXX` && \
339
version=`./brz version --short` && \
340
tarball=$$PWD/../breezy-$$version.tar.gz && \
437
341
tar Cxz $$tmpdir -f $$tarball && \
438
$(MAKE) -C $$tmpdir/bzr-$$version check && \
342
$(MAKE) -C $$tmpdir/breezy-$$version check && \