~bzr-pqm/bzr/bzr.dev

2413.4.1 by John Arbash Meinel
Cherrypick just the epydoc builder changes.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
#
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.
7
#
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.
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
# building documentation, etc.
19
1739.1.6 by Robert Collins
Resolve conflicts with bzr.dev.
20
.PHONY: all clean extensions pyflakes api-docs
21
1739.1.5 by Robert Collins
Review feedback.
22
all: extensions
23
24
extensions:
1739.1.3 by Robert Collins
Merge bzr.dev.
25
	@echo "building extension modules."
2449.1.1 by Alexander Belchenko
fix RSTX wrong formatting in HACKING
26
	python setup.py build_ext -i
1102 by Martin Pool
- merge test refactoring from robertc
27
1739.1.6 by Robert Collins
Resolve conflicts with bzr.dev.
28
check: extensions
2080.2.2 by John Arbash Meinel
Teach the pqm to treat warnings as errors
29
	python -Werror ./bzr selftest -v $(tests)
1526.1.1 by Robert Collins
Run the test suite with no locale as well as the default locale. Also add a test for build_tree_shape to selftest.
30
	@echo "Running all tests with no locale."
1704.1.1 by Robert Collins
'bzr selftest' now shows a progress bar with the number of tests, and
31
	LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
2090.2.4 by Martin Pool
Make check should run under python -O too
32
	python -O -Werror ./bzr selftest -v $(tests)
1102 by Martin Pool
- merge test refactoring from robertc
33
1185.33.72 by Martin Pool
Fix commit message template for non-ascii files, and add test for handling of
34
check-msgeditor:
35
	./bzr --no-plugins selftest -v msgeditor
36
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
37
# Run Python style checker (apt-get install pyflakes)
38
pyflakes:
39
	pyflakes bzrlib
40
41
pyflakes-nounused:
42
	# There are many of these warnings at the moment and they're not a
43
	# high priority to fix
44
	pyflakes bzrlib | grep -v ' imported but unused'
45
46
clean:
2366.2.1 by Matthew Fuller
(trivial) Use 'python setup.py' instead of './setup.py'.
47
	python setup.py clean
1185.62.18 by John Arbash Meinel
From Jari Alto: Makefile fixes (clean target error suppression)
48
	-find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
1427 by Robert Collins
clean up test dirs on make clean
49
	rm -rf test????.tmp
1185.1.21 by Robert Collins
add a clean target
50
2413.4.1 by John Arbash Meinel
Cherrypick just the epydoc builder changes.
51
docfiles = bzr bzrlib
52
api-docs:
53
	mkdir -p api/html
54
	PYTHONPATH=$(PWD) python tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
55
56
check-api-docs:
57
	PYTHONPATH=$(PWD) python tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
1158 by Martin Pool
- make target to build emacs TAGS file
58
59
60
# build emacs cross-reference
61
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
62
TAGS: $(tag_files)
63
	ctags-exuberant -e $(tag_files)
1536.1.1 by Martin Pool
Move in tutorial text from wiki.
64
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
65
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
66
# Produce HTML docs to upload on Canonical server
67
HTMLDIR := html_docs
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
68
PRETTYDIR := pretty_docs
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
69
1711.2.129 by John Arbash Meinel
change htmldocs => html-docs, to be consistent with other -docs functions
70
html-docs: docs
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
71
	python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
72
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
73
74
# translate txt docs to html
75
doc_dir := doc 
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
76
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
77
htm_files := $(patsubst %.txt, %.htm, $(txt_files)) 
78
2054.2.16 by Aaron Bentley
More updates from review comments
79
pretty-html-docs: pretty_files
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
80
81
pretty_docs:
82
	python -c "import os; os.mkdir('$(PRETTYDIR)')"
83
84
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
85
2405.2.1 by Andrew Bennetts
Build HACKING.htm from 'make docs'.
86
doc/HACKING.htm: HACKING
87
	python tools/rst2html.py --link-stylesheet --stylesheet=default.css HACKING doc/HACKING.htm
88
89
doc/%.htm: doc/%.txt 
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
90
	python tools/rst2html.py --link-stylesheet --stylesheet=default.css doc/$*.txt doc/$*.htm
91
92
$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
93
	python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
94
	$(PRETTYDIR)/$*.htm
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
95
2425.1.1 by Robert Collins
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
96
MAN_DEPENDENCIES = bzrlib/builtins.py \
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
97
		 bzrlib/bundle/commands.py \
98
		 bzrlib/conflicts.py \
99
		 bzrlib/sign_my_commits.py \
100
		 generate_docs.py \
101
		 tools/doc_generate/__init__.py \
102
		 tools/doc_generate/autodoc_rstx.py
2425.1.1 by Robert Collins
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
103
104
doc/bzr_man.txt: $(MAN_DEPENDENCIES)
105
	python generate_docs.py -o $@ rstx
106
107
MAN_PAGES = man1/bzr.1
108
man1/bzr.1: $(MAN_DEPENDENCIES)
109
	python generate_docs.py -o $@ man
110
111
docs: $(htm_files) $(MAN_PAGES) doc/HACKING.htm
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
112
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
113
copy-docs: docs
1861.2.18 by Alexander Belchenko
Makefile: cross-platform actions for building installer
114
	python tools/win32/ostools.py copytodir $(htm_files) doc/default.css NEWS README  win32_bzr.exe/doc
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
115
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
116
# clean produced docs
117
clean-docs:
2425.1.1 by Robert Collins
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
118
	python tools/win32/ostools.py remove $(htm_files) \
119
	$(HTMLDIR) $(PRETTYDIR) doc/bzr_man.txt $(MAN_PAGES)
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
120
121
122
# make bzr.exe for win32 with py2exe
123
exe:
124
	@echo *** Make bzr.exe
125
	python setup.py py2exe > py2exe.log
126
	python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
127
	python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
128
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
129
# win32 installer for bzr.exe
1982.2.1 by Alexander Belchenko
small but important fix for 'make installer' dependencies
130
installer: exe copy-docs
1861.2.18 by Alexander Belchenko
Makefile: cross-platform actions for building installer
131
	@echo *** Make windows installer
132
	cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
133
	iscc /Q tools/win32/bzr.iss
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
134
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
135
# win32 python's distutils-based installer
136
# require to have python interpreter installed on win32
1860.1.3 by Alexander Belchenko
python-installer:
137
python-installer: docs
2245.4.5 by Alexander Belchenko
bzr-win32-bdist-postinstall.py: good win98 support
138
	python setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
139
140
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
141
# clean on win32 all installer-related files and directories
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
142
clean-win32:
1861.2.18 by Alexander Belchenko
Makefile: cross-platform actions for building installer
143
	python tools/win32/ostools.py remove build
144
	python tools/win32/ostools.py remove win32_bzr.exe
145
	python tools/win32/ostools.py remove py2exe.log
146
	python tools/win32/ostools.py remove doc/*.htm
147
	python tools/win32/ostools.py remove doc/bzr_man.txt
148
	python tools/win32/ostools.py remove tools/win32/bzr.iss
149
	python tools/win32/ostools.py remove bzr-setup*.exe
2245.4.5 by Alexander Belchenko
bzr-win32-bdist-postinstall.py: good win98 support
150
	python tools/win32/ostools.py remove bzr-*win32.exe
1861.2.18 by Alexander Belchenko
Makefile: cross-platform actions for building installer
151
	python tools/win32/ostools.py remove dist