← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

Update test support, and remove deprecated functions pullable_revisions and get_intervening_revisions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
 
 
20
 
 
21
 
### Core Stuff ###
22
 
 
23
 
PYTHON=python
24
 
 
25
 
.PHONY: all clean extensions pyflakes api-docs
26
 
 
27
 
all: extensions
28
 
 
29
 
extensions:
30
 
        @echo "building extension modules."
31
 
        $(PYTHON) setup.py build_ext -i
32
 
 
33
 
check: docs extensions
34
 
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
 
1
all: 
 
2
 
 
3
check:
 
4
        ./bzr selftest $(tests)
35
5
        @echo "Running all tests with no locale."
36
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
37
 
 
38
 
# Run Python style checker (apt-get install pyflakes)
39
 
#
40
 
# Note that at present this gives many false warnings, because it doesn't
41
 
# know about identifiers loaded through lazy_import.
42
 
pyflakes:
43
 
        pyflakes bzrlib
44
 
 
45
 
pyflakes-nounused:
46
 
        # There are many of these warnings at the moment and they're not a
47
 
        # high priority to fix
48
 
        pyflakes bzrlib | grep -v ' imported but unused'
49
 
 
50
 
clean:
51
 
        $(PYTHON) setup.py clean
52
 
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
53
 
 
54
 
# Build API documentation
55
 
docfiles = bzr bzrlib
56
 
api-docs:
57
 
        mkdir -p api/html
58
 
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
59
 
check-api-docs:
60
 
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
61
 
 
62
 
# build tags for emacs and vim
63
 
TAGS:
64
 
        ctags -R -e bzrlib
65
 
 
66
 
tags:
67
 
        ctags -R bzrlib
68
 
 
69
 
# these are treated as phony so they'll always be rebuilt - it's pretty quick
70
 
.PHONY: TAGS tags
71
 
 
72
 
### Documentation ###
73
 
 
74
 
# set PRETTY to get docs that look like the Bazaar web site
75
 
ifdef PRETTY
76
 
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
77
 
else
78
 
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
79
 
endif
80
 
 
81
 
# translate txt docs to html
82
 
derived_txt_files := \
83
 
        doc/en/user-reference/bzr_man.txt \
84
 
        doc/en/developer-guide/HACKING.txt \
85
 
        doc/en/release-notes/NEWS.txt
86
 
txt_files := $(wildcard doc/en/tutorials/*.txt) \
87
 
        $(derived_txt_files) \
88
 
        doc/en/user-guide/index.txt \
89
 
        doc/en/mini-tutorial/index.txt \
90
 
        $(wildcard doc/es/guia-usario/*.txt) \
91
 
        doc/es/mini-tutorial/index.txt \
92
 
        doc/index.txt \
93
 
        doc/index.es.txt
94
 
non_txt_files := \
95
 
       doc/default.css \
96
 
       doc/en/quick-reference/quick-start-summary.svg \
97
 
       doc/en/quick-reference/quick-start-summary.png \
98
 
       doc/en/quick-reference/quick-start-summary.pdf \
99
 
       $(wildcard doc/en/user-guide/images/*.png) \
100
 
       doc/es/referencia-rapida/referencia-rapida.svg \
101
 
       doc/es/referencia-rapida/referencia-rapida.png \
102
 
       doc/es/referencia-rapida/referencia-rapida.pdf \
103
 
       $(wildcard doc/es/guia-usuario/images/*.png)
104
 
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
105
 
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
106
 
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
107
 
 
108
 
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
109
 
        $(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
110
 
 
111
 
doc/developers/%.html: doc/developers/%.txt
112
 
        $(rst2html) --stylesheet=../default.css $< $@
113
 
 
114
 
doc/index.html: doc/index.txt
115
 
        $(rst2html) --stylesheet=default.css $< $@
116
 
 
117
 
%.html: %.txt
118
 
        $(rst2html) --stylesheet=../../default.css $< $@
119
 
 
120
 
MAN_DEPENDENCIES = bzrlib/builtins.py \
121
 
                 bzrlib/bundle/commands.py \
122
 
                 bzrlib/conflicts.py \
123
 
                 bzrlib/help_topics/__init__.py \
124
 
                 bzrlib/sign_my_commits.py \
125
 
                 bzrlib/bugtracker.py \
126
 
                 generate_docs.py \
127
 
                 tools/doc_generate/__init__.py \
128
 
                 tools/doc_generate/autodoc_man.py \
129
 
                 tools/doc_generate/autodoc_rstx.py \
130
 
                 $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
131
 
 
132
 
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
133
 
        $(PYTHON) generate_docs.py -o $@ rstx
134
 
 
135
 
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
136
 
        $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
137
 
 
138
 
doc/en/release-notes/NEWS.txt: NEWS
139
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
140
 
 
141
 
MAN_PAGES = man1/bzr.1
142
 
man1/bzr.1: $(MAN_DEPENDENCIES)
143
 
        $(PYTHON) generate_docs.py -o $@ man
144
 
 
145
 
# build a png of our performance task list
146
 
doc/developers/performance.png: doc/developers/performance.dot
147
 
        @echo Generating $@
148
 
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
149
 
 
150
 
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
151
 
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
152
 
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
153
 
 
154
 
# the main target to build all the docs
155
 
docs: $(ALL_DOCS)
156
 
 
157
 
# produce a tree containing just the final docs, ready for uploading to the web
158
 
HTMLDIR := html_docs
159
 
html-docs: docs
160
 
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
161
 
 
162
 
# clean produced docs
163
 
clean-docs:
164
 
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
165
 
        $(HTMLDIR) $(derived_txt_files)
166
 
 
167
 
 
168
 
### Windows Support ###
169
 
 
170
 
# make bzr.exe for win32 with py2exe
171
 
exe:
172
 
        @echo *** Make bzr.exe
173
 
        $(PYTHON) setup.py build_ext -i -f
174
 
        $(PYTHON) setup.py py2exe > py2exe.log
175
 
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
176
 
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
177
 
 
178
 
# win32 installer for bzr.exe
179
 
installer: exe copy-docs
180
 
        @echo *** Make windows installer
181
 
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
182
 
        iscc /Q tools/win32/bzr.iss
183
 
 
184
 
# win32 Python's distutils-based installer
185
 
# require to have Python interpreter installed on win32
186
 
py-inst-24: docs
187
 
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
188
 
 
189
 
py-inst-25: docs
190
 
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
191
 
 
192
 
python-installer: py-inst-24 py-inst-25
193
 
 
194
 
 
195
 
copy-docs: docs
196
 
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
197
 
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
198
 
 
199
 
# clean on win32 all installer-related files and directories
200
 
clean-win32: clean-docs
201
 
        $(PYTHON) tools/win32/ostools.py remove build
202
 
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
203
 
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
204
 
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
205
 
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
206
 
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
207
 
        $(PYTHON) tools/win32/ostools.py remove dist
208
 
 
209
 
.PHONY: dist dist-upload-escudero check-dist-tarball
210
 
 
211
 
# build a distribution tarball.
212
 
#
213
 
# this method of copying the pyrex generated files is a bit ugly; it would be
214
 
# nicer to generate it from distutils.
215
 
#
216
 
# these are a bit ubuntu-specific.
217
 
dist: 
218
 
        version=`./bzr version --short` && \
219
 
        echo Building distribution of bzr $$version && \
220
 
        expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
221
 
        expdir=$$expbasedir/bzr-$$version && \
222
 
        tarball=$$PWD/../bzr-$$version.tar.gz && \
223
 
        $(MAKE) clean && \
224
 
        $(MAKE) && \
225
 
        bzr export $$expdir && \
226
 
        cp bzrlib/*.c $$expdir/bzrlib/. && \
227
 
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
228
 
        gpg --detach-sign $$tarball && \
229
 
        echo $$tarball done. && \
230
 
        rm -rf $$expbasedir
231
 
 
232
 
# run all tests in a previously built tarball
233
 
check-dist-tarball:
234
 
        tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
235
 
        version=`./bzr version --short` && \
236
 
        tarball=$$PWD/../bzr-$$version.tar.gz && \
237
 
        tar Cxz $$tmpdir -f $$tarball && \
238
 
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
239
 
        rm -rf $$tmpdir
240
 
 
241
 
 
242
 
# upload previously built tarball to the download directory on bazaar-vcs.org,
243
 
# and verify that it can be downloaded ok.
244
 
dist-upload-escudero:
245
 
        version=`./bzr version --short` && \
246
 
        tarball=../bzr-$$version.tar.gz && \
247
 
        scp $$tarball $$tarball.sig \
248
 
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
249
 
                && \
250
 
        echo verifying over http... && \
251
 
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
252
 
                | diff -s - $$tarball && \
253
 
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
254
 
                | diff -s - $$tarball.sig 
 
6
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest $(tests)
 
7
 
 
8
check-msgeditor:
 
9
        ./bzr --no-plugins selftest -v msgeditor
 
10
 
 
11
clean: 
 
12
        ./setup.py clean
 
13
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
 
14
        rm -rf test????.tmp
 
15
 
 
16
.PHONY: all
 
17
 
 
18
 
 
19
# build emacs cross-reference
 
20
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
 
21
TAGS: $(tag_files)
 
22
        ctags-exuberant -e $(tag_files)
 
23
 
 
24
tutorial.html: tutorial.txt
 
25
        rest2html tutorial.txt > tutorial.html