~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005-2012, 2016, 2017 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

# A relatively simple Makefile to assist in building parts of bzr. Mostly for

# building documentation, etc.

### Core Stuff ###

PYTHON=python

PYTHON24=python24

PYTHON25=python25

PYTHON26=python26

BZR_TARGET=release

PLUGIN_TARGET=plugin-release

PYTHON_BUILDFLAGS=

.PHONY: all clean realclean extensions pyflakes api-docs check-nodocs check

all: extensions

extensions:

	@echo "building extension modules."

	$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)

check: docs check-nodocs

check-nodocs: extensions

	set -e

	# Generate a stream for PQM to watch.

	-$(RM) -f selftest.log

	echo `date` ": selftest starts" 1>&2

	$(PYTHON) -Werror -Wignore::ImportWarning -O ./bzr selftest -Oselftest.timeout=120 \

	  --subunit $(tests) | tee selftest.log

	echo `date` ": selftest ends" 1>&2

	# An empty log file should catch errors in the $(PYTHON)

	# command above (the '|' swallow any errors since 'make'

	# sees the 'tee' exit code for the whole line

	if [ ! -s selftest.log ] ; then exit 1 ; fi

	# Check that there were no errors reported.

	subunit-stats < selftest.log

# Run Python style checker (apt-get install pyflakes)

#

# Note that at present this gives many false warnings, because it doesn't

# know about identifiers loaded through lazy_import.

pyflakes:

	pyflakes bzrlib

pyflakes-nounused:

	# There are many of these warnings at the moment and they're not a

	# high priority to fix

	pyflakes bzrlib | grep -v ' imported but unused'

clean:

	$(PYTHON) setup.py clean

	-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f

realclean: clean

	# Remove files which are autogenerated but included by the tarball.

	rm -f bzrlib/*_pyx.c

	rm -f bzrlib/_simple_set_pyx.h bzrlib/_simple_set_pyx_api.h

# Build API documentation

docfiles = bzr bzrlib

api-docs:

	mkdir -p api/html

	pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)

# build tags for emacs and vim

TAGS:

	ctags -R -e bzrlib

tags:

	ctags -R bzrlib

# these are treated as phony so they'll always be rebuilt - it's pretty quick

.PHONY: TAGS tags

### Documentation ###

# Default to plain documentation for maximum backwards compatibility.

# (Post 2.0, the defaults will most likely be Sphinx-style instead.)

docs: docs-plain

clean-docs: clean-plain

html-docs: html-plain

### Man-page Documentation ###

MAN_DEPENDENCIES = bzrlib/builtins.py \

	$(wildcard bzrlib/*.py) \

	$(wildcard bzrlib/*/*.py) \

	tools/generate_docs.py \

	$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 

MAN_PAGES = man1/bzr.1

man1/bzr.1: $(MAN_DEPENDENCIES)

	$(PYTHON) tools/generate_docs.py -o $@ man

### Sphinx-style Documentation ###

# Build the documentation. To keep the dependencies down to a minimum

# for distro packagers, we only build the html documentation by default.

# Sphinx 0.6 or later is preferred for the best rendering, though

# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html

# for installation instructions.

docs-sphinx: html-sphinx

# Clean out generated documentation

clean-sphinx:

	cd doc/en && make clean

	cd doc/es && make clean

	cd doc/ja && make clean

	cd doc/ru && make clean

	cd doc/developers && make clean

SPHINX_DEPENDENCIES = \

        doc/en/release-notes/index.txt \

        doc/en/user-reference/index.txt \

	doc/es/Makefile \

	doc/es/make.bat \

	doc/ja/Makefile \

	doc/ja/make.bat \

	doc/ru/Makefile \

	doc/ru/make.bat \

	doc/developers/Makefile \

	doc/developers/make.bat

NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)

doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)

	LANGUAGE=C $(PYTHON) tools/generate_docs.py -o $@ rstx

doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py

	$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)

doc/%/Makefile: doc/en/Makefile

	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"

doc/%/make.bat: doc/en/make.bat

	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"

# Build the html docs using Sphinx.

html-sphinx: $(SPHINX_DEPENDENCIES)

	cd doc/en && make html

	cd doc/es && make html

	cd doc/ru && make html

	cd doc/ja && make html

	cd doc/developers && make html

# Build the PDF docs using Sphinx. This requires numerous LaTeX

# packages. See http://sphinx.pocoo.org/builders.html for details.

# Note: We don't currently build PDFs for the Russian docs because

# they require additional packages to be installed (to handle

# Russian hyphenation rules, etc.)

pdf-sphinx: $(SPHINX_DEPENDENCIES)

	cd doc/en && make latex

	cd doc/es && make latex

	cd doc/ja && make latex

	cd doc/developers && make latex

	cd doc/en/_build/latex && make all-pdf

	cd doc/es/_build/latex && make all-pdf

	cd doc/developers/_build/latex && make all-pdf

# Build the CHM (Windows Help) docs using Sphinx.

# Note: HtmlHelp Workshop needs to be used on the generated hhp files

# to generate the final chm files.

chm-sphinx: $(SPHINX_DEPENDENCIES)

	cd doc/en && make htmlhelp

	cd doc/es && make htmlhelp

	cd doc/ru && make htmlhelp

	cd doc/ja && make htmlhelp

	cd doc/developers && make htmlhelp

# Build the texinfo files using Sphinx.

texinfo-sphinx: $(SPHINX_DEPENDENCIES)

	cd doc/en && make texinfo

	cd doc/es && make texinfo

	cd doc/ru && make texinfo

	cd doc/ja && make texinfo

	cd doc/developers && make texinfo

### Documentation Website ###

# Where to build the website

DOC_WEBSITE_BUILD = build_doc_website

# Build and package docs into a website, complete with downloads.

doc-website: html-sphinx pdf-sphinx

	$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)

	$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)

	$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)

	$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)

	$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)

### Plain Documentation ###

# While Sphinx is the preferred tool for building documentation, we still

# support our "plain" html documentation so that Sphinx is not a hard

# dependency for packagers on older platforms.

rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning

# translate txt docs to html

derived_txt_files = \

	doc/en/release-notes/NEWS.txt

txt_all = \

	doc/en/tutorials/tutorial.txt \

	doc/en/tutorials/using_bazaar_with_launchpad.txt \

	doc/en/tutorials/centralized_workflow.txt \

        $(wildcard doc/es/tutorials/*.txt) \

		$(wildcard doc/ru/tutorials/*.txt) \

	doc/ja/tutorials/tutorial.txt \

	doc/ja/tutorials/using_bazaar_with_launchpad.txt \

	doc/ja/tutorials/centralized_workflow.txt \

	$(wildcard doc/*/mini-tutorial/index.txt) \

	$(wildcard doc/*/user-guide/index-plain.txt) \

	doc/en/admin-guide/index-plain.txt \

	$(wildcard doc/es/guia-usario/*.txt) \

	$(derived_txt_files) \

	doc/en/upgrade-guide/index.txt \

	doc/index.txt \

	$(wildcard doc/index.*.txt)

txt_nohtml = \

	doc/en/user-guide/index.txt \

	doc/es/user-guide/index.txt \

	doc/ja/user-guide/index.txt \

	doc/ru/user-guide/index.txt \

	doc/en/admin-guide/index.txt

txt_files = $(filter-out $(txt_nohtml), $(txt_all))

htm_files = $(patsubst %.txt, %.html, $(txt_files)) 

non_txt_files = \

       doc/default.css \

       $(wildcard doc/*/bzr-en-quick-reference.svg) \

       $(wildcard doc/*/bzr-en-quick-reference.png) \

       $(wildcard doc/*/bzr-en-quick-reference.pdf) \

       $(wildcard doc/*/bzr-es-quick-reference.svg) \

       $(wildcard doc/*/bzr-es-quick-reference.png) \

       $(wildcard doc/*/bzr-es-quick-reference.pdf) \

       $(wildcard doc/*/bzr-ru-quick-reference.svg) \

       $(wildcard doc/*/bzr-ru-quick-reference.png) \

       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \

       $(wildcard doc/*/user-guide/images/*.png)

# doc/developers/*.txt files that should *not* be individually

# converted to HTML

dev_txt_nohtml = \

	doc/developers/add.txt \

	doc/developers/annotate.txt \

	doc/developers/bundle-creation.txt \

	doc/developers/commit.txt \

	doc/developers/diff.txt \

	doc/developers/directory-fingerprints.txt \

	doc/developers/gc.txt \

	doc/developers/implementation-notes.txt \

	doc/developers/incremental-push-pull.txt \

	doc/developers/index.txt \

	doc/developers/initial-push-pull.txt \

	doc/developers/merge-scaling.txt \

	doc/developers/miscellaneous-notes.txt \

	doc/developers/missing.txt \

	doc/developers/performance-roadmap-rationale.txt \

	doc/developers/performance-use-case-analysis.txt \

	doc/developers/planned-change-integration.txt \

	doc/developers/planned-performance-changes.txt \

	doc/developers/plans.txt \

	doc/developers/process.txt \

	doc/developers/revert.txt \

	doc/developers/specifications.txt \

	doc/developers/status.txt \

	doc/developers/uncommit.txt

dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))

dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))

dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 

doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 

	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@

#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 

#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@

#

#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 

#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@

#

doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide)) 

	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@

doc/developers/%.html: doc/developers/%.txt

	$(rst2html) --stylesheet=../default.css $< $@

doc/index.html: doc/index.txt

	$(rst2html) --stylesheet=default.css $< $@

doc/index.%.html: doc/index.%.txt

	$(rst2html) --stylesheet=default.css $< $@

%.html: %.txt

	$(rst2html) --stylesheet=../../default.css $< "$@"

doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py

	$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)

upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 

doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)

	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@

derived_web_docs = $(htm_files) $(dev_htm_files) 

WEB_DOCS = $(derived_web_docs) $(non_txt_files)

ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)

# the main target to build all the docs

docs-plain: $(ALL_DOCS)

# produce a tree containing just the final docs, ready for uploading to the web

HTMLDIR = html_docs

html-plain: docs-plain

	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)

# clean produced docs

clean-plain:

	$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \

	    $(HTMLDIR) $(derived_txt_files)

### Miscellaneous Documentation Targets ###

# build a png of our performance task list

# this is no longer built by default; you can build it if you want to look at it

doc/developers/performance.png: doc/developers/performance.dot

	@echo Generating $@

	@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"

### Windows Support ###

# make all the installers completely from scratch, using zc.buildout

# to fetch the dependencies

# These are files that need to be copied into the build location to boostrap

# the build process.

# Note that the path is relative to tools/win32

BUILDOUT_FILES = buildout.cfg \

	buildout-templates/bin/build-installer.bat.in \

	ostools.py bootstrap.py

installer-all:

	@echo Make all the installers from scratch

	@# Build everything in a separate directory, to avoid cluttering the WT

	$(PYTHON) tools/win32/ostools.py makedir build-win32

	@# cd to tools/win32 so that the relative paths are copied correctly

	cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32

	@# There seems to be a bug in gf.release.bzr, It doesn't correctly update

	@# existing release directories, so delete them manually before building

	@# It means things may be rebuilt that don't need to be, but at least

	@# it will be correct when they do.

	cd build-win32 && $(PYTHON) ostools.py remove release */release

	cd build-win32 && $(PYTHON) bootstrap.py

	cd build-win32 && bin/buildout

	cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)

clean-installer-all:

	$(PYTHON) tools/win32/ostools.py remove build-win32

# make bzr.exe for win32 with py2exe

exe:

	@echo *** Make bzr.exe

	$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd

	$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)

	$(PYTHON) setup.py py2exe > py2exe.log

	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe

	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe

# win32 installer for bzr.exe

installer: exe copy-docs

	@echo *** Make Windows installer

	$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog

	iscc /Q tools/win32/bzr.iss

# win32 Python's distutils-based installer

# require to have Python interpreter installed on win32

py-inst-24: docs

	$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .

py-inst-25: docs

	$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .

py-inst-26: docs

	$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .

python-installer: py-inst-24 py-inst-25 py-inst-26

copy-docs: docs

	$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc

	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe

# clean on win32 all installer-related files and directories

clean-win32: clean-docs

	$(PYTHON) tools/win32/ostools.py remove build

	$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe

	$(PYTHON) tools/win32/ostools.py remove py2exe.log

	$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss

	$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe

	$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe

	$(PYTHON) tools/win32/ostools.py remove dist

# i18n targets

.PHONY: update-pot po/bzr.pot

update-pot: po/bzr.pot

TRANSLATABLE_PYFILES:=$(shell find bzrlib -name '*.py' \

		| grep -v 'bzrlib/tests/' \

		| grep -v 'bzrlib/doc' \

		)

po/bzr.pot: $(PYFILES) $(DOCFILES)

	$(PYTHON) ./bzr export-pot --include-duplicates > po/bzr.pot

	echo $(TRANSLATABLE_PYFILES) | xargs \

	  xgettext --package-name "bzr" \

	  --msgid-bugs-address "<bazaar@canonical.com>" \

	  --copyright-holder "Canonical" \

	  --from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \

	  -d bzr -p po -o bzr.pot

### Packaging Targets ###

.PHONY: dist check-dist-tarball

# build a distribution source tarball

dist: 

	version=`./bzr version --short` && \

	echo Building distribution of bzr $$version && \

	expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \

	expdir=$$expbasedir/bzr-$$version && \

	tarball=$$PWD/../bzr-$$version.tar.gz && \

	$(MAKE) clean && \

	$(MAKE) && \

	$(PYTHON) setup.py sdist -d $$PWD/.. && \

	gpg --detach-sign --armor $$tarball && \

	rm -rf $$expbasedir

# run all tests in a previously built tarball

check-dist-tarball:

	tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \

	version=`./bzr version --short` && \

	tarball=$$PWD/../bzr-$$version.tar.gz && \

	tar Cxz $$tmpdir -f $$tarball && \

	$(MAKE) -C $$tmpdir/bzr-$$version check && \

	rm -rf $$tmpdir