← 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-04-07 13:08:21 UTC
  • mfrom: (4222.2.12 ui-username)
  • Revision ID: pqm@pqm.ubuntu.com-20090407130821-e4wi39x60alhpnr4
(Jelmer) Add UIFactory.get_username.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
all:
2
 
 
3
 
check:
4
 
        python -Werror ./bzr selftest -v $(tests)
 
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)
5
38
        @echo "Running all tests with no locale."
6
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
7
 
        python -O -Werror ./bzr selftest -v $(tests)
8
 
 
9
 
check-msgeditor:
10
 
        ./bzr --no-plugins selftest -v msgeditor
 
39
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
11
40
 
12
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.
13
45
pyflakes:
14
46
        pyflakes bzrlib
15
47
 
19
51
        pyflakes bzrlib | grep -v ' imported but unused'
20
52
 
21
53
clean:
22
 
        python setup.py clean
23
 
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
24
 
        rm -rf test????.tmp
25
 
 
26
 
.PHONY: all
27
 
 
28
 
 
29
 
# build emacs cross-reference
30
 
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
31
 
TAGS: $(tag_files)
32
 
        ctags-exuberant -e $(tag_files)
33
 
 
34
 
 
35
 
# Produce HTML docs to upload on Canonical server
36
 
HTMLDIR := html_docs
37
 
PRETTYDIR := pretty_docs
38
 
 
39
 
html-docs: docs
40
 
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
41
 
 
 
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
42
83
 
43
84
# translate txt docs to html
44
 
doc_dir := doc 
45
 
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
46
 
htm_files := $(patsubst %.txt, %.htm, $(txt_files)) 
47
 
 
48
 
pretty-html-docs: pretty_files
49
 
 
50
 
pretty_docs:
51
 
        python -c "import os; os.mkdir('$(PRETTYDIR)')"
52
 
 
53
 
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
54
 
 
55
 
doc/HACKING.htm: HACKING
56
 
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css HACKING doc/HACKING.htm
57
 
 
58
 
doc/%.htm: doc/%.txt 
59
 
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css doc/$*.txt doc/$*.htm
60
 
 
61
 
$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
62
 
        python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
63
 
        $(PRETTYDIR)/$*.htm
64
 
 
65
 
doc/bzr_man.txt: bzrlib/builtins.py \
 
85
derived_txt_files := \
 
86
        doc/en/user-reference/bzr_man.txt \
 
87
        doc/en/developer-guide/HACKING.txt \
 
88
        doc/en/release-notes/NEWS.txt
 
89
txt_files := $(wildcard doc/en/tutorials/*.txt) \
 
90
        $(derived_txt_files) \
 
91
        doc/en/user-guide/index.txt \
 
92
        doc/en/mini-tutorial/index.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
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
 
109
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
110
 
 
111
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
 
112
        $(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
 
113
 
 
114
# Set the paper size for PDF files.
 
115
# Options:  'a4' (ISO A4 size), 'letter' (US Letter size)
 
116
PAPERSIZE = a4
 
117
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
 
118
 
 
119
# Copy and modify the RST sources, and convert SVG images to PDF
 
120
# files for use a images in the LaTeX-generated PDF.
 
121
# Then generate the PDF output from the modified RST sources.
 
122
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
 
123
        mkdir -p doc/en/user-guide/latex_prepared
 
124
        $(PYTHON) tools/prepare_for_latex.py \
 
125
            --out-dir=doc/en/user-guide/latex_prepared \
 
126
            --in-dir=doc/en/user-guide
 
127
        cd doc/en/user-guide/latex_prepared && \
 
128
            $(PYTHON) ../../../../tools/rst2pdf.py \
 
129
                --documentoptions=10pt,$(PAPERSIZE)paper \
 
130
                --input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
 
131
                --strict --title="Bazaar User Guide" \
 
132
                index.txt ../user-guide.$(PAPERSIZE).pdf
 
133
 
 
134
doc/developers/%.html: doc/developers/%.txt
 
135
        $(rst2html) --stylesheet=../default.css $< $@
 
136
 
 
137
doc/index.html: doc/index.txt
 
138
        $(rst2html) --stylesheet=default.css $< $@
 
139
 
 
140
%.html: %.txt
 
141
        $(rst2html) --stylesheet=../../default.css $< $@
 
142
 
 
143
MAN_DEPENDENCIES = bzrlib/builtins.py \
66
144
                 bzrlib/bundle/commands.py \
67
145
                 bzrlib/conflicts.py \
 
146
                 bzrlib/help_topics/__init__.py \
 
147
                 bzrlib/bzrdir.py \
68
148
                 bzrlib/sign_my_commits.py \
 
149
                 bzrlib/bugtracker.py \
69
150
                 generate_docs.py \
70
151
                 tools/doc_generate/__init__.py \
71
 
                 tools/doc_generate/autodoc_rstx.py
72
 
        python generate_docs.py -o doc/bzr_man.txt rstx
73
 
 
74
 
docs: $(htm_files) doc/HACKING.htm
75
 
 
76
 
copy-docs: docs
77
 
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css NEWS README  win32_bzr.exe/doc
 
152
                 tools/doc_generate/autodoc_man.py \
 
153
                 tools/doc_generate/autodoc_rstx.py \
 
154
                 $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
155
 
 
156
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
157
        $(PYTHON) generate_docs.py -o $@ rstx
 
158
 
 
159
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
160
        $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
161
 
 
162
doc/en/release-notes/NEWS.txt: NEWS
 
163
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
164
 
 
165
MAN_PAGES = man1/bzr.1
 
166
man1/bzr.1: $(MAN_DEPENDENCIES)
 
167
        $(PYTHON) generate_docs.py -o $@ man
 
168
 
 
169
# build a png of our performance task list
 
170
doc/developers/performance.png: doc/developers/performance.dot
 
171
        @echo Generating $@
 
172
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
173
 
 
174
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
 
175
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
176
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
177
 
 
178
# the main target to build all the docs
 
179
docs: $(ALL_DOCS)
 
180
 
 
181
# produce a tree containing just the final docs, ready for uploading to the web
 
182
HTMLDIR := html_docs
 
183
html-docs: docs
 
184
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
 
185
 
 
186
# Produce PDF documents.  Requires pdfLaTeX, rubber, and Inkscape.
 
187
pdf-docs: $(PDF_DOCS)
78
188
 
79
189
# clean produced docs
80
190
clean-docs:
81
 
        python tools/win32/ostools.py remove doc/bzr_man.txt $(htm_files) \
82
 
        $(HTMLDIR) $(PRETTYDIR)
83
 
 
 
191
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
 
192
            $(HTMLDIR) $(derived_txt_files)
 
193
        rm -f doc/en/user-guide/*.pdf
 
194
        rm -rf doc/en/user-guide/latex_prepared
 
195
 
 
196
 
 
197
### Windows Support ###
84
198
 
85
199
# make bzr.exe for win32 with py2exe
86
200
exe:
87
201
        @echo *** Make bzr.exe
88
 
        python setup.py py2exe > py2exe.log
89
 
        python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
90
 
        python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
 
202
        $(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
 
203
        $(PYTHON) setup.py py2exe > py2exe.log
 
204
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
205
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
91
206
 
92
207
# win32 installer for bzr.exe
93
208
installer: exe copy-docs
94
209
        @echo *** Make windows installer
95
 
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
 
210
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
96
211
        iscc /Q tools/win32/bzr.iss
97
212
 
98
 
# win32 python's distutils-based installer
99
 
# require to have python interpreter installed on win32
100
 
python-installer: docs
101
 
        python setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
102
 
 
 
213
# win32 Python's distutils-based installer
 
214
# require to have Python interpreter installed on win32
 
215
py-inst-24: docs
 
216
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
217
 
 
218
py-inst-25: docs
 
219
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
220
 
 
221
python-installer: py-inst-24 py-inst-25
 
222
 
 
223
 
 
224
copy-docs: docs
 
225
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
226
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
103
227
 
104
228
# clean on win32 all installer-related files and directories
105
 
clean-win32:
106
 
        python tools/win32/ostools.py remove build
107
 
        python tools/win32/ostools.py remove win32_bzr.exe
108
 
        python tools/win32/ostools.py remove py2exe.log
109
 
        python tools/win32/ostools.py remove doc/*.htm
110
 
        python tools/win32/ostools.py remove doc/bzr_man.txt
111
 
        python tools/win32/ostools.py remove tools/win32/bzr.iss
112
 
        python tools/win32/ostools.py remove bzr-setup*.exe
113
 
        python tools/win32/ostools.py remove bzr-*win32.exe
114
 
        python tools/win32/ostools.py remove dist
 
229
clean-win32: clean-docs
 
230
        $(PYTHON) tools/win32/ostools.py remove build
 
231
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
 
232
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
 
233
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
 
234
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
 
235
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
 
236
        $(PYTHON) tools/win32/ostools.py remove dist
 
237
 
 
238
.PHONY: dist dist-upload-escudero check-dist-tarball
 
239
 
 
240
# build a distribution tarball and zip file.
 
241
#
 
242
# this method of copying the pyrex generated files is a bit ugly; it would be
 
243
# nicer to generate it from distutils.
 
244
dist: 
 
245
        version=`./bzr version --short` && \
 
246
        echo Building distribution of bzr $$version && \
 
247
        expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
 
248
        expdir=$$expbasedir/bzr-$$version && \
 
249
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
250
        zipball=$$PWD/../bzr-$$version.zip && \
 
251
        $(MAKE) clean && \
 
252
        $(MAKE) && \
 
253
        bzr export $$expdir && \
 
254
        cp bzrlib/*.c $$expdir/bzrlib/. && \
 
255
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
 
256
        (cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
 
257
        gpg --detach-sign $$tarball && \
 
258
        gpg --detach-sign $$zipball && \
 
259
        rm -rf $$expbasedir
 
260
 
 
261
# run all tests in a previously built tarball
 
262
check-dist-tarball:
 
263
        tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
 
264
        version=`./bzr version --short` && \
 
265
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
266
        tar Cxz $$tmpdir -f $$tarball && \
 
267
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
 
268
        rm -rf $$tmpdir
 
269
 
 
270
 
 
271
# upload previously built tarball to the download directory on bazaar-vcs.org,
 
272
# and verify that it can be downloaded ok.
 
273
dist-upload-escudero:
 
274
        version=`./bzr version --short` && \
 
275
        tarball=../bzr-$$version.tar.gz && \
 
276
        zipball=../bzr-$$version.zip && \
 
277
        scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
 
278
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
 
279
                && \
 
280
        echo verifying over http... && \
 
281
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
 
282
                | diff -s - $$zipball && \
 
283
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
 
284
                | diff -s - $$zipball.sig 
 
285
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
 
286
                | diff -s - $$tarball && \
 
287
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
 
288
                | diff -s - $$tarball.sig