← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Martin Pool
  • Date: 2009-08-14 12:08:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4614.
  • Revision ID: mbp@sourcefrog.net-20090814120808-4gvx7fhg44z29cj3
Use platform(aliased=1)

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
39
39
check: docs check-nodocs
40
40
 
41
41
check-nodocs: extensions
42
 
        set -e
43
 
        # Generate a stream for PQM to watch.
44
 
        -$(RM) -f selftest.log
45
 
        $(PYTHON) -Werror -O ./bzr selftest --subunit $(tests) | tee selftest.log
46
 
        # An empty log file should catch errors in the $(PYTHON)
47
 
        # command above (the '|' swallow any errors since 'make'
48
 
        # sees the 'tee' exit code for the whole line
49
 
        if [ ! -s selftest.log ] ; then exit 1 ; fi
50
 
        # Check that there were no errors reported.
51
 
        subunit-stats < selftest.log
 
42
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
 
43
        @echo "Running all tests with no locale."
 
44
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
52
45
 
53
46
# Run Python style checker (apt-get install pyflakes)
54
47
#
84
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
85
78
.PHONY: TAGS tags
86
79
 
87
 
 
88
80
### Documentation ###
89
81
 
90
 
# Default to plain documentation for maximum backwards compatibility.
91
 
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
92
 
 
93
 
docs: docs-plain
94
 
 
95
 
clean-docs: clean-plain
96
 
 
97
 
html-docs: html-plain
98
 
 
99
 
 
100
 
### Man-page Documentation ###
101
 
 
102
 
MAN_DEPENDENCIES = bzrlib/builtins.py \
103
 
        $(wildcard bzrlib/*.py) \
104
 
        $(wildcard bzrlib/*/*.py) \
105
 
        tools/generate_docs.py \
106
 
        $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
107
 
 
108
 
MAN_PAGES = man1/bzr.1
109
 
man1/bzr.1: $(MAN_DEPENDENCIES)
110
 
        $(PYTHON) tools/generate_docs.py -o $@ man
111
 
 
112
 
 
113
 
### Sphinx-style Documentation ###
114
 
 
115
 
# Build the documentation. To keep the dependencies down to a minimum
116
 
# for distro packagers, we only build the html documentation by default.
117
 
# Sphinx 0.6 or later is preferred for the best rendering, though
118
 
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
119
 
# for installation instructions.
120
 
docs-sphinx: html-sphinx
121
 
 
122
 
# Clean out generated documentation
123
 
clean-sphinx:
124
 
        cd doc/en && make clean
125
 
        cd doc/es && make clean
126
 
        cd doc/ja && make clean
127
 
        cd doc/ru && make clean
128
 
        cd doc/developers && make clean
129
 
 
130
 
SPHINX_DEPENDENCIES = \
131
 
        doc/en/release-notes/index.txt \
132
 
        doc/en/user-reference/index.txt \
133
 
        doc/es/Makefile \
134
 
        doc/es/make.bat \
135
 
        doc/ja/Makefile \
136
 
        doc/ja/make.bat \
137
 
        doc/ru/Makefile \
138
 
        doc/ru/make.bat \
139
 
        doc/developers/Makefile \
140
 
        doc/developers/make.bat
141
 
 
142
 
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
143
 
        $(PYTHON) tools/generate_docs.py -o $@ rstx
144
 
 
145
 
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
146
 
        $(PYTHON) tools/generate_release_notes.py NEWS $@
147
 
 
148
 
doc/%/Makefile: doc/en/Makefile
149
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
150
 
 
151
 
doc/%/make.bat: doc/en/make.bat
152
 
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
153
 
 
154
 
# Build the html docs using Sphinx.
155
 
html-sphinx: $(SPHINX_DEPENDENCIES)
156
 
        cd doc/en && make html
157
 
        cd doc/es && make html
158
 
        cd doc/ru && make html
159
 
        cd doc/ja && make html
160
 
        cd doc/developers && make html
161
 
 
162
 
# Build the PDF docs using Sphinx. This requires numerous LaTeX
163
 
# packages. See http://sphinx.pocoo.org/builders.html for details.
164
 
# Note: We don't currently build PDFs for the Russian docs because
165
 
# they require additional packages to be installed (to handle
166
 
# Russian hyphenation rules, etc.)
167
 
pdf-sphinx: $(SPHINX_DEPENDENCIES)
168
 
        cd doc/en && make latex
169
 
        cd doc/es && make latex
170
 
        cd doc/ja && make latex
171
 
        cd doc/developers && make latex
172
 
        cd doc/en/_build/latex && make all-pdf
173
 
        cd doc/es/_build/latex && make all-pdf
174
 
        cd doc/developers/_build/latex && make all-pdf
175
 
 
176
 
# Build the CHM (Windows Help) docs using Sphinx.
177
 
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
178
 
# to generate the final chm files.
179
 
chm-sphinx: $(SPHINX_DEPENDENCIES)
180
 
        cd doc/en && make htmlhelp
181
 
        cd doc/es && make htmlhelp
182
 
        cd doc/ru && make htmlhelp
183
 
        cd doc/ja && make htmlhelp
184
 
        cd doc/developers && make htmlhelp
185
 
 
186
 
 
187
 
### Documentation Website ###
188
 
 
189
 
# Where to build the website
190
 
DOC_WEBSITE_BUILD = build_doc_website
191
 
 
192
 
# Build and package docs into a website, complete with downloads.
193
 
doc-website: html-sphinx pdf-sphinx
194
 
        $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
195
 
        $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
196
 
        $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
197
 
        $(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
198
 
        $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
199
 
 
200
 
 
201
 
### Plain Documentation ###
202
 
 
203
 
# While Sphinx is the preferred tool for building documentation, we still
204
 
# support our "plain" html documentation so that Sphinx is not a hard
205
 
# dependency for packagers on older platforms.
206
 
 
207
 
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
82
# set PRETTY to get docs that look like the Bazaar web site
 
83
ifdef PRETTY
 
84
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
85
else
 
86
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
87
endif
208
88
 
209
89
# translate txt docs to html
210
 
derived_txt_files = \
 
90
derived_txt_files := \
 
91
        doc/en/user-reference/bzr_man.txt \
211
92
        doc/en/release-notes/NEWS.txt
212
 
txt_all = \
 
93
txt_files := \
213
94
        doc/en/tutorials/tutorial.txt \
214
95
        doc/en/tutorials/using_bazaar_with_launchpad.txt \
215
96
        doc/en/tutorials/centralized_workflow.txt \
216
 
        $(wildcard doc/es/tutorials/*.txt) \
217
 
                $(wildcard doc/ru/tutorials/*.txt) \
218
 
        doc/ja/tutorials/tutorial.txt \
219
 
        doc/ja/tutorials/using_bazaar_with_launchpad.txt \
220
 
        doc/ja/tutorials/centralized_workflow.txt \
 
97
        $(wildcard doc/ru/tutorials/*.txt) \
221
98
        $(wildcard doc/*/mini-tutorial/index.txt) \
222
 
        $(wildcard doc/*/user-guide/index-plain.txt) \
223
 
        doc/en/admin-guide/index-plain.txt \
224
 
        $(wildcard doc/es/guia-usario/*.txt) \
 
99
        $(wildcard doc/*/user-guide/index.txt) \
225
100
        $(derived_txt_files) \
 
101
        doc/en/developer-guide/HACKING.txt \
226
102
        doc/en/upgrade-guide/index.txt \
 
103
        $(wildcard doc/es/guia-usario/*.txt) \
 
104
        doc/es/mini-tutorial/index.txt \
227
105
        doc/index.txt \
228
106
        $(wildcard doc/index.*.txt)
229
 
txt_nohtml = \
230
 
        doc/en/user-guide/index.txt \
231
 
        doc/es/user-guide/index.txt \
232
 
        doc/ja/user-guide/index.txt \
233
 
        doc/ru/user-guide/index.txt \
234
 
        doc/en/admin-guide/index.txt
235
 
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
236
 
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
237
 
 
238
 
non_txt_files = \
 
107
non_txt_files := \
239
108
       doc/default.css \
240
 
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
241
 
       $(wildcard doc/*/bzr-en-quick-reference.png) \
242
 
       $(wildcard doc/*/bzr-en-quick-reference.pdf) \
243
 
       $(wildcard doc/*/bzr-es-quick-reference.svg) \
244
 
       $(wildcard doc/*/bzr-es-quick-reference.png) \
245
 
       $(wildcard doc/*/bzr-es-quick-reference.pdf) \
246
 
       $(wildcard doc/*/bzr-ru-quick-reference.svg) \
247
 
       $(wildcard doc/*/bzr-ru-quick-reference.png) \
248
 
       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \
 
109
       $(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
 
110
       $(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
 
111
       $(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
249
112
       $(wildcard doc/*/user-guide/images/*.png)
 
113
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
250
114
 
251
115
# doc/developers/*.txt files that should *not* be individually
252
116
# converted to HTML
253
 
dev_txt_nohtml = \
 
117
dev_txt_nohtml := \
254
118
        doc/developers/add.txt \
255
119
        doc/developers/annotate.txt \
256
120
        doc/developers/bundle-creation.txt \
258
122
        doc/developers/diff.txt \
259
123
        doc/developers/directory-fingerprints.txt \
260
124
        doc/developers/gc.txt \
261
 
        doc/developers/implementation-notes.txt \
262
125
        doc/developers/incremental-push-pull.txt \
263
 
        doc/developers/index.txt \
264
126
        doc/developers/initial-push-pull.txt \
265
127
        doc/developers/merge-scaling.txt \
266
 
        doc/developers/miscellaneous-notes.txt \
267
128
        doc/developers/missing.txt \
268
129
        doc/developers/performance-roadmap-rationale.txt \
269
130
        doc/developers/performance-use-case-analysis.txt \
270
131
        doc/developers/planned-change-integration.txt \
271
132
        doc/developers/planned-performance-changes.txt \
272
 
        doc/developers/plans.txt \
273
 
        doc/developers/process.txt \
274
133
        doc/developers/revert.txt \
275
 
        doc/developers/specifications.txt \
276
134
        doc/developers/status.txt \
277
135
        doc/developers/uncommit.txt
278
136
 
279
 
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
280
 
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
281
 
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
282
 
 
283
 
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
284
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
285
 
 
286
 
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 
287
 
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
288
 
#
289
 
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
290
 
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
291
 
#
292
 
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide)) 
293
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
 
137
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
 
138
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
 
139
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
140
 
 
141
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide)) 
 
142
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
143
 
 
144
# Set the paper size for PDF files.
 
145
# Options:  'a4' (ISO A4 size), 'letter' (US Letter size)
 
146
PAPERSIZE = a4
 
147
# TODO: Add generation for Russian PDF
 
148
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
 
149
 
 
150
# Copy and modify the RST sources, and convert SVG images to PDF
 
151
# files for use a images in the LaTeX-generated PDF.
 
152
# Then generate the PDF output from the modified RST sources.
 
153
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
 
154
        mkdir -p doc/en/user-guide/latex_prepared
 
155
        $(PYTHON) tools/prepare_for_latex.py \
 
156
            --out-dir=doc/en/user-guide/latex_prepared \
 
157
            --in-dir=doc/en/user-guide
 
158
        cd doc/en/user-guide/latex_prepared && \
 
159
            $(PYTHON) ../../../../tools/rst2pdf.py \
 
160
                --documentoptions=10pt,$(PAPERSIZE)paper \
 
161
                --input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
 
162
                --strict --title="Bazaar User Guide" \
 
163
                index.txt ../user-guide.$(PAPERSIZE).pdf
294
164
 
295
165
doc/developers/%.html: doc/developers/%.txt
296
166
        $(rst2html) --stylesheet=../default.css $< $@
304
174
%.html: %.txt
305
175
        $(rst2html) --stylesheet=../../default.css $< $@
306
176
 
 
177
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
178
        $(wildcard bzrlib/*.py) \
 
179
        $(wildcard bzrlib/*/*.py) \
 
180
        tools/generate_docs.py \
 
181
        $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
182
 
 
183
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
184
        $(PYTHON) tools/generate_docs.py -o $@ rstx
 
185
 
307
186
doc/en/release-notes/NEWS.txt: NEWS
308
187
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
309
188
 
 
189
MAN_PAGES = man1/bzr.1
 
190
man1/bzr.1: $(MAN_DEPENDENCIES)
 
191
        $(PYTHON) tools/generate_docs.py -o $@ man
 
192
 
310
193
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
311
194
 
312
195
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
313
196
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
314
197
 
 
198
# build a png of our performance task list
 
199
# 
 
200
# this is no longer built by default; you can build it if you want to look at it
 
201
doc/developers/performance.png: doc/developers/performance.dot
 
202
        @echo Generating $@
 
203
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
204
 
315
205
derived_web_docs = $(htm_files) $(dev_htm_files) 
316
206
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
317
207
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
318
208
 
319
209
# the main target to build all the docs
320
 
docs-plain: $(ALL_DOCS)
 
210
docs: $(ALL_DOCS)
321
211
 
322
212
# produce a tree containing just the final docs, ready for uploading to the web
323
 
HTMLDIR = html_docs
324
 
html-plain: docs-plain
 
213
HTMLDIR := html_docs
 
214
html-docs: docs
325
215
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
326
216
 
 
217
# Produce PDF documents.  Requires pdfLaTeX, rubber, and Inkscape.
 
218
pdf-docs: $(PDF_DOCS)
 
219
 
327
220
# clean produced docs
328
 
clean-plain:
 
221
clean-docs:
329
222
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
330
223
            $(HTMLDIR) $(derived_txt_files)
331
 
 
332
 
 
333
 
### Miscellaneous Documentation Targets ###
334
 
 
335
 
# build a png of our performance task list
336
 
# this is no longer built by default; you can build it if you want to look at it
337
 
doc/developers/performance.png: doc/developers/performance.dot
338
 
        @echo Generating $@
339
 
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
224
        rm -f doc/*/user-guide/*.pdf
 
225
        rm -rf doc/*/user-guide/latex_prepared
340
226
 
341
227
 
342
228
### Windows Support ###
346
232
# These are files that need to be copied into the build location to boostrap
347
233
# the build process.
348
234
# Note that the path is relative to tools/win32
349
 
BUILDOUT_FILES = buildout.cfg \
 
235
BUILDOUT_FILES := buildout.cfg \
350
236
        buildout-templates/bin/build-installer.bat.in \
351
237
        ostools.py bootstrap.py
352
238
 
412
298
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
413
299
        $(PYTHON) tools/win32/ostools.py remove dist
414
300
 
415
 
 
416
 
### Packaging Targets ###
417
 
 
418
 
.PHONY: dist check-dist-tarball
419
 
 
420
 
# build a distribution source tarball
 
301
.PHONY: dist dist-upload-escudero check-dist-tarball
 
302
 
 
303
# build a distribution tarball and zip file.
421
304
#
422
305
# this method of copying the pyrex generated files is a bit ugly; it would be
423
306
# nicer to generate it from distutils.
427
310
        expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
428
311
        expdir=$$expbasedir/bzr-$$version && \
429
312
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
313
        zipball=$$PWD/../bzr-$$version.zip && \
430
314
        $(MAKE) clean && \
431
315
        $(MAKE) && \
432
316
        bzr export $$expdir && \
433
 
        cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
 
317
        cp bzrlib/*.c $$expdir/bzrlib/. && \
434
318
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
 
319
        (cd $$expbasedir && zip -r $$zipball bzr-$$version) && \
435
320
        gpg --detach-sign $$tarball && \
 
321
        gpg --detach-sign $$zipball && \
436
322
        rm -rf $$expbasedir
437
323
 
438
324
# run all tests in a previously built tarball
443
329
        tar Cxz $$tmpdir -f $$tarball && \
444
330
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
445
331
        rm -rf $$tmpdir
 
332
 
 
333
 
 
334
# upload previously built tarball to the download directory on bazaar-vcs.org,
 
335
# and verify that it can be downloaded ok.
 
336
dist-upload-escudero:
 
337
        version=`./bzr version --short` && \
 
338
        tarball=../bzr-$$version.tar.gz && \
 
339
        zipball=../bzr-$$version.zip && \
 
340
        scp $$zipball $$zipball.sig $$tarball $$tarball.sig \
 
341
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
 
342
                && \
 
343
        echo verifying over http... && \
 
344
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip \
 
345
                | diff -s - $$zipball && \
 
346
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.zip.sig \
 
347
                | diff -s - $$zipball.sig 
 
348
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
 
349
                | diff -s - $$tarball && \
 
350
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
 
351
                | diff -s - $$tarball.sig