← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Jelmer Vernooij
  • Date: 2009-05-27 08:33:37 UTC
  • mto: (4398.5.1 bencode_serializer)
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: jelmer@samba.org-20090527083337-fij2klthhtsdl2hy
Fix copyright headers, add _bencode_py.py to the list of files that do not have to have canonical copyright.

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