← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-30 14:24:06 UTC
  • mfrom: (4576.1.1 export-to-dir)
  • Revision ID: pqm@pqm.ubuntu.com-20090730142406-wg8gmxpcjz4c1z00
(bialix) Allow 'bzr export' to export into an existing (but empty)
        directory

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
PYTHON24=python24
 
25
PYTHON25=python25
 
26
BZR_TARGET=release
 
27
PLUGIN_TARGET=plugin-release
 
28
PYTHON_BUILDFLAGS=
 
29
 
 
30
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
 
31
 
 
32
all: extensions
 
33
 
 
34
extensions:
 
35
        @echo "building extension modules."
 
36
        $(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
 
37
 
 
38
check: docs check-nodocs
 
39
 
 
40
check-nodocs: extensions
 
41
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
 
42
        @echo "Running all tests with no locale."
 
43
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
 
44
 
 
45
# Run Python style checker (apt-get install pyflakes)
 
46
#
 
47
# Note that at present this gives many false warnings, because it doesn't
 
48
# know about identifiers loaded through lazy_import.
 
49
pyflakes:
 
50
        pyflakes bzrlib
 
51
 
 
52
pyflakes-nounused:
 
53
        # There are many of these warnings at the moment and they're not a
 
54
        # high priority to fix
 
55
        pyflakes bzrlib | grep -v ' imported but unused'
 
56
 
 
57
clean:
 
58
        $(PYTHON) setup.py clean
 
59
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
 
60
 
 
61
# Build API documentation
 
62
docfiles = bzr bzrlib
 
63
api-docs:
 
64
        mkdir -p api/html
 
65
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
66
check-api-docs:
 
67
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
 
68
 
 
69
# build tags for emacs and vim
 
70
TAGS:
 
71
        ctags -R -e bzrlib
 
72
 
 
73
tags:
 
74
        ctags -R bzrlib
 
75
 
 
76
# these are treated as phony so they'll always be rebuilt - it's pretty quick
 
77
.PHONY: TAGS tags
 
78
 
 
79
### Documentation ###
 
80
 
 
81
# set PRETTY to get docs that look like the Bazaar web site
 
82
ifdef PRETTY
 
83
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
84
else
 
85
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
86
endif
 
87
 
 
88
# translate txt docs to html
 
89
derived_txt_files := \
 
90
        doc/en/user-reference/bzr_man.txt \
 
91
        doc/en/release-notes/NEWS.txt
 
92
txt_files := \
 
93
        doc/en/tutorials/tutorial.txt \
 
94
        doc/en/tutorials/using_bazaar_with_launchpad.txt \
 
95
        doc/en/tutorials/centralized_workflow.txt \
 
96
        $(wildcard doc/ru/tutorials/*.txt) \
 
97
        $(wildcard doc/*/mini-tutorial/index.txt) \
 
98
        $(wildcard doc/*/user-guide/index.txt) \
 
99
        $(derived_txt_files) \
 
100
        doc/en/developer-guide/HACKING.txt \
 
101
        doc/en/upgrade-guide/index.txt \
 
102
        $(wildcard doc/es/guia-usario/*.txt) \
 
103
        doc/es/mini-tutorial/index.txt \
 
104
        doc/index.txt \
 
105
        $(wildcard doc/index.*.txt)
 
106
non_txt_files := \
 
107
       doc/default.css \
 
108
       $(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
 
109
       $(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
 
110
       $(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
 
111
       $(wildcard doc/*/user-guide/images/*.png)
 
112
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
 
113
 
 
114
# doc/developers/*.txt files that should *not* be individually
 
115
# converted to HTML
 
116
dev_txt_nohtml := \
 
117
        doc/developers/add.txt \
 
118
        doc/developers/annotate.txt \
 
119
        doc/developers/bundle-creation.txt \
 
120
        doc/developers/commit.txt \
 
121
        doc/developers/diff.txt \
 
122
        doc/developers/directory-fingerprints.txt \
 
123
        doc/developers/gc.txt \
 
124
        doc/developers/incremental-push-pull.txt \
 
125
        doc/developers/initial-push-pull.txt \
 
126
        doc/developers/merge-scaling.txt \
 
127
        doc/developers/missing.txt \
 
128
        doc/developers/performance-roadmap-rationale.txt \
 
129
        doc/developers/performance-use-case-analysis.txt \
 
130
        doc/developers/planned-change-integration.txt \
 
131
        doc/developers/planned-performance-changes.txt \
 
132
        doc/developers/revert.txt \
 
133
        doc/developers/status.txt \
 
134
        doc/developers/uncommit.txt
 
135
 
 
136
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
 
137
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
 
138
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
139
 
 
140
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide)) 
 
141
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
142
 
 
143
# Set the paper size for PDF files.
 
144
# Options:  'a4' (ISO A4 size), 'letter' (US Letter size)
 
145
PAPERSIZE = a4
 
146
# TODO: Add generation for Russian PDF
 
147
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
 
148
 
 
149
# Copy and modify the RST sources, and convert SVG images to PDF
 
150
# files for use a images in the LaTeX-generated PDF.
 
151
# Then generate the PDF output from the modified RST sources.
 
152
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
 
153
        mkdir -p doc/en/user-guide/latex_prepared
 
154
        $(PYTHON) tools/prepare_for_latex.py \
 
155
            --out-dir=doc/en/user-guide/latex_prepared \
 
156
            --in-dir=doc/en/user-guide
 
157
        cd doc/en/user-guide/latex_prepared && \
 
158
            $(PYTHON) ../../../../tools/rst2pdf.py \
 
159
                --documentoptions=10pt,$(PAPERSIZE)paper \
 
160
                --input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
 
161
                --strict --title="Bazaar User Guide" \
 
162
                index.txt ../user-guide.$(PAPERSIZE).pdf
 
163
 
 
164
doc/developers/%.html: doc/developers/%.txt
 
165
        $(rst2html) --stylesheet=../default.css $< $@
 
166
 
 
167
doc/index.html: doc/index.txt
 
168
        $(rst2html) --stylesheet=default.css $< $@
 
169
 
 
170
doc/index.%.html: doc/index.%.txt
 
171
        $(rst2html) --stylesheet=default.css $< $@
 
172
 
 
173
%.html: %.txt
 
174
        $(rst2html) --stylesheet=../../default.css $< $@
 
175
 
 
176
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
177
        $(wildcard bzrlib/*.py) \
 
178
        $(wildcard bzrlib/*/*.py) \
 
179
        tools/generate_docs.py \
 
180
        $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
181
 
 
182
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
183
        $(PYTHON) tools/generate_docs.py -o $@ rstx
 
184
 
 
185
doc/en/release-notes/NEWS.txt: NEWS
 
186
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
187
 
 
188
MAN_PAGES = man1/bzr.1
 
189
man1/bzr.1: $(MAN_DEPENDENCIES)
 
190
        $(PYTHON) tools/generate_docs.py -o $@ man
 
191
 
 
192
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
 
193
 
 
194
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
 
195
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
196
 
 
197
# build a png of our performance task list
 
198
# 
 
199
# this is no longer built by default; you can build it if you want to look at it
 
200
doc/developers/performance.png: doc/developers/performance.dot
 
201
        @echo Generating $@
 
202
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
203
 
 
204
derived_web_docs = $(htm_files) $(dev_htm_files) 
 
205
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
206
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
207
 
 
208
# the main target to build all the docs
 
209
docs: $(ALL_DOCS)
 
210
 
 
211
# produce a tree containing just the final docs, ready for uploading to the web
 
212
HTMLDIR := html_docs
 
213
html-docs: docs
 
214
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
 
215
 
 
216
# Produce PDF documents.  Requires pdfLaTeX, rubber, and Inkscape.
 
217
pdf-docs: $(PDF_DOCS)
 
218
 
 
219
# clean produced docs
 
220
clean-docs:
 
221
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
 
222
            $(HTMLDIR) $(derived_txt_files)
 
223
        rm -f doc/*/user-guide/*.pdf
 
224
        rm -rf doc/*/user-guide/latex_prepared
 
225
 
 
226
 
 
227
### Windows Support ###
 
228
 
 
229
# make all the installers completely from scratch, using zc.buildout
 
230
# to fetch the dependencies
 
231
installer-all:
 
232
        @echo *** Make all the installers from scratch
 
233
        cd tools/win32 && $(PYTHON) bootstrap.py
 
234
        cd tools/win32 && bin/buildout
 
235
        cd tools/win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
 
236
 
 
237
 
 
238
clean-installer-all:
 
239
        $(PYTHON) tools/win32/ostools.py remove tools/win32/.installed.cfg
 
240
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bin/
 
241
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr/
 
242
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr-rebase/
 
243
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr-svn/
 
244
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzrtools/
 
245
        $(PYTHON) tools/win32/ostools.py remove tools/win32/db4/
 
246
        $(PYTHON) tools/win32/ostools.py remove tools/win32/develop-eggs/
 
247
        $(PYTHON) tools/win32/ostools.py remove tools/win32/libintl/
 
248
        $(PYTHON) tools/win32/ostools.py remove tools/win32/parts/
 
249
        $(PYTHON) tools/win32/ostools.py remove tools/win32/qbzr/
 
250
        $(PYTHON) tools/win32/ostools.py remove tools/win32/subvertpy/
 
251
        $(PYTHON) tools/win32/ostools.py remove tools/win32/svn/
 
252
        $(PYTHON) tools/win32/ostools.py remove tools/win32/tbzr/
 
253
        $(PYTHON) tools/win32/ostools.py remove tools/win32/tortoise-overlays/
 
254
        $(PYTHON) tools/win32/ostools.py remove tools/win32/zlib/
 
255
 
 
256
# make bzr.exe for win32 with py2exe
 
257
exe:
 
258
        @echo *** Make bzr.exe
 
259
        $(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
 
260
        $(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
 
261
        $(PYTHON) setup.py py2exe > py2exe.log
 
262
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
263
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
 
264
 
 
265
# win32 installer for bzr.exe
 
266
installer: exe copy-docs
 
267
        @echo *** Make Windows installer
 
268
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
 
269
        iscc /Q tools/win32/bzr.iss
 
270
 
 
271
# win32 Python's distutils-based installer
 
272
# require to have Python interpreter installed on win32
 
273
py-inst-24: docs
 
274
        $(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
275
 
 
276
py-inst-25: docs
 
277
        $(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
278
 
 
279
py-inst-26: docs
 
280
        python26 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
281
 
 
282
python-installer: py-inst-24 py-inst-25 py-inst-26
 
283
 
 
284
 
 
285
copy-docs: docs
 
286
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
287
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
 
288
 
 
289
# clean on win32 all installer-related files and directories
 
290
clean-win32: clean-docs
 
291
        $(PYTHON) tools/win32/ostools.py remove build
 
292
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
 
293
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
 
294
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
 
295
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
 
296
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
 
297
        $(PYTHON) tools/win32/ostools.py remove dist
 
298
 
 
299
.PHONY: dist dist-upload-escudero check-dist-tarball
 
300
 
 
301
# build a distribution tarball and zip file.
 
302
#
 
303
# this method of copying the pyrex generated files is a bit ugly; it would be
 
304
# nicer to generate it from distutils.
 
305
dist: 
 
306
        version=`./bzr version --short` && \
 
307
        echo Building distribution of bzr $$version && \
 
308
        expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
 
309
        expdir=$$expbasedir/bzr-$$version && \
 
310
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
311
        zipball=$$PWD/../bzr-$$version.zip && \
 
312
        $(MAKE) clean && \
 
313
        $(MAKE) && \
 
314
        bzr export $$expdir && \
 
315
        cp bzrlib/*.c $$expdir/bzrlib/. && \
 
316
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
 
317
        (cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
 
318
        gpg --detach-sign $$tarball && \
 
319
        gpg --detach-sign $$zipball && \
 
320
        rm -rf $$expbasedir
 
321
 
 
322
# run all tests in a previously built tarball
 
323
check-dist-tarball:
 
324
        tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
 
325
        version=`./bzr version --short` && \
 
326
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
327
        tar Cxz $$tmpdir -f $$tarball && \
 
328
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
 
329
        rm -rf $$tmpdir
 
330
 
 
331
 
 
332
# upload previously built tarball to the download directory on bazaar-vcs.org,
 
333
# and verify that it can be downloaded ok.
 
334
dist-upload-escudero:
 
335
        version=`./bzr version --short` && \
 
336
        tarball=../bzr-$$version.tar.gz && \
 
337
        zipball=../bzr-$$version.zip && \
 
338
        scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
 
339
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
 
340
                && \
 
341
        echo verifying over http... && \
 
342
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
 
343
                | diff -s - $$zipball && \
 
344
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
 
345
                | diff -s - $$zipball.sig 
 
346
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
 
347
                | diff -s - $$tarball && \
 
348
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
 
349
                | diff -s - $$tarball.sig