← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Ian Clatworthy
  • Date: 2007-07-10 01:37:27 UTC
  • mto: This revision was merged to the branch mainline in revision 2598.
  • Revision ID: ian.clatworthy@internode.on.net-20070710013727-xrx8w91shojt1p4l
(Ian Clatworthy) Prepare for 0.19 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
18
# building documentation, etc.
19
19
 
20
 
 
21
 
### Core Stuff ###
22
 
 
23
 
PYTHON=python
24
 
PYTHON_BUILDFLAGS=
25
 
 
26
 
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
 
20
.PHONY: all clean extensions pyflakes api-docs
27
21
 
28
22
all: extensions
29
23
 
30
24
extensions:
31
25
        @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)
 
26
        python setup.py build_ext -i
 
27
 
 
28
check: docs extensions
 
29
        python -Werror ./bzr selftest -v $(tests)
38
30
        @echo "Running all tests with no locale."
39
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
 
31
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
 
32
        python -O -Werror ./bzr selftest -v $(tests)
 
33
 
 
34
check-msgeditor:
 
35
        ./bzr --no-plugins selftest -v msgeditor
40
36
 
41
37
# 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
38
pyflakes:
46
39
        pyflakes bzrlib
47
40
 
51
44
        pyflakes bzrlib | grep -v ' imported but unused'
52
45
 
53
46
clean:
54
 
        $(PYTHON) setup.py clean
55
 
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
 
47
        python setup.py clean
 
48
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
 
49
        rm -rf test????.tmp
56
50
 
57
 
# Build API documentation
58
51
docfiles = bzr bzrlib
59
52
api-docs:
60
53
        mkdir -p api/html
61
 
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
54
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
55
 
62
56
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
 
57
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
 
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)
 
64
 
 
65
 
 
66
# Produce HTML docs to upload on Canonical server
 
67
HTMLDIR := html_docs
 
68
PRETTYDIR := pretty_docs
 
69
 
 
70
html-docs: docs
 
71
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
 
72
 
83
73
 
84
74
# translate txt docs to html
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)) 
 
75
doc_dir := doc 
 
76
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
 
77
htm_files := $(patsubst %.txt, %.htm, $(txt_files)) 
108
78
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 $< $@
 
79
dev_htm_files := $(patsubst %.txt, %.htm, $(dev_txt_files)) 
 
80
 
 
81
pretty-html-docs: pretty_files
 
82
 
 
83
pretty_docs:
 
84
        python -c "import os; os.mkdir('$(PRETTYDIR)')"
 
85
 
 
86
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
 
87
 
 
88
doc/developers/%.htm: doc/developers/%.txt
 
89
        python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
 
90
 
 
91
doc/developers/HACKING.htm: doc/developers/HACKING
 
92
        python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
 
93
 
 
94
%.htm: %.txt
 
95
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css --footnote-references=superscript $< $@
 
96
 
 
97
$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
 
98
        python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
 
99
        $(PRETTYDIR)/$*.htm
142
100
 
143
101
MAN_DEPENDENCIES = bzrlib/builtins.py \
144
102
                 bzrlib/bundle/commands.py \
145
103
                 bzrlib/conflicts.py \
146
 
                 bzrlib/help_topics/__init__.py \
147
 
                 bzrlib/bzrdir.py \
148
104
                 bzrlib/sign_my_commits.py \
149
 
                 bzrlib/bugtracker.py \
150
105
                 generate_docs.py \
151
106
                 tools/doc_generate/__init__.py \
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('$<', '$@')"
 
107
                 tools/doc_generate/autodoc_rstx.py
 
108
 
 
109
doc/bzr_man.txt: $(MAN_DEPENDENCIES)
 
110
        python generate_docs.py -o $@ rstx
164
111
 
165
112
MAN_PAGES = man1/bzr.1
166
113
man1/bzr.1: $(MAN_DEPENDENCIES)
167
 
        $(PYTHON) generate_docs.py -o $@ man
 
114
        python generate_docs.py -o $@ man
 
115
 
 
116
ALL_DOCS = $(htm_files) $(MAN_PAGES) doc/developers/HACKING.htm $(dev_htm_files) doc/developers/performance.png
 
117
docs: $(ALL_DOCS)
 
118
 
 
119
copy-docs: docs
 
120
        python tools/win32/ostools.py copytodir $(htm_files) \
 
121
                doc/default.css NEWS README \
 
122
                win32_bzr.exe/doc
 
123
        python tools/win32/ostools.py copytodir doc/developers/HACKING.htm \
 
124
                $(dev_htm_files) \
 
125
                win32_bzr.exe/doc/developers
 
126
 
 
127
# clean produced docs
 
128
clean-docs:
 
129
        python tools/win32/ostools.py remove $(ALL_DOCS) \
 
130
        $(HTMLDIR) $(PRETTYDIR) doc/bzr_man.txt doc/developers/performance.png
 
131
 
168
132
 
169
133
# build a png of our performance task list
170
134
doc/developers/performance.png: doc/developers/performance.dot
171
135
        @echo Generating $@
172
136
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
173
137
 
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)
188
 
 
189
 
# clean produced docs
190
 
clean-docs:
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 ###
198
138
 
199
139
# make bzr.exe for win32 with py2exe
200
140
exe:
201
141
        @echo *** Make 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
 
142
        python setup.py build_ext -i -f
 
143
        python setup.py py2exe > py2exe.log
 
144
        python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
145
        python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
206
146
 
207
147
# win32 installer for bzr.exe
208
148
installer: exe copy-docs
209
149
        @echo *** Make windows installer
210
 
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
 
150
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
211
151
        iscc /Q tools/win32/bzr.iss
212
152
 
213
 
# win32 Python's distutils-based installer
214
 
# require to have Python interpreter installed on win32
215
 
py-inst-24: docs
 
153
# win32 python's distutils-based installer
 
154
# require to have python interpreter installed on win32
 
155
python-installer: docs
216
156
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
217
 
 
218
 
py-inst-25: docs
219
157
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
220
158
 
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
227
159
 
228
160
# clean on win32 all installer-related files and directories
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 
 
161
clean-win32:
 
162
        python tools/win32/ostools.py remove build
 
163
        python tools/win32/ostools.py remove win32_bzr.exe
 
164
        python tools/win32/ostools.py remove py2exe.log
 
165
        python tools/win32/ostools.py remove doc/*.htm
 
166
        python tools/win32/ostools.py remove doc/developers/*.htm
 
167
        python tools/win32/ostools.py remove doc/bzr_man.txt
 
168
        python tools/win32/ostools.py remove tools/win32/bzr.iss
 
169
        python tools/win32/ostools.py remove bzr-setup*.exe
 
170
        python tools/win32/ostools.py remove bzr-*win32.exe
 
171
        python tools/win32/ostools.py remove dist