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