← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Andrew Bennetts
  • Date: 2009-10-13 05:20:50 UTC
  • mfrom: (4634.52.16 2.0)
  • mto: This revision was merged to the branch mainline in revision 4738.
  • Revision ID: andrew.bennetts@canonical.com-20091013052050-u1w6tv0z7kqhn8d0
Merge 2.0 into lp:bzr, resolving conflicts in NEWS and releasing.txt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
28
28
PLUGIN_TARGET=plugin-release
29
29
PYTHON_BUILDFLAGS=
30
30
 
31
 
.PHONY: all clean realclean extensions pyflakes api-docs check-nodocs check
 
31
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
32
32
 
33
33
all: extensions
34
34
 
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
 
        echo `date` ": selftest starts" 1>&2
46
 
        $(PYTHON) -Werror -Wignore::ImportWarning -O ./bzr selftest -Oselftest.timeout=120 \
47
 
          --subunit $(tests) | tee selftest.log
48
 
        echo `date` ": selftest ends" 1>&2
49
 
        # An empty log file should catch errors in the $(PYTHON)
50
 
        # command above (the '|' swallow any errors since 'make'
51
 
        # sees the 'tee' exit code for the whole line
52
 
        if [ ! -s selftest.log ] ; then exit 1 ; fi
53
 
        # Check that there were no errors reported.
54
 
        subunit-stats < selftest.log
 
42
        $(PYTHON) -Werror -O ./bzr selftest -1 --subunit $(tests)
55
43
 
56
44
# Run Python style checker (apt-get install pyflakes)
57
45
#
69
57
        $(PYTHON) setup.py clean
70
58
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
71
59
 
72
 
realclean: clean
73
 
        # Remove files which are autogenerated but included by the tarball.
74
 
        rm -f bzrlib/*_pyx.c
75
 
        rm -f bzrlib/_simple_set_pyx.h bzrlib/_simple_set_pyx_api.h
76
 
 
77
60
# Build API documentation
78
61
docfiles = bzr bzrlib
79
62
api-docs:
80
63
        mkdir -p api/html
81
 
        pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)
 
64
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
65
check-api-docs:
 
66
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
82
67
 
83
68
# build tags for emacs and vim
84
69
TAGS:
129
114
clean-sphinx:
130
115
        cd doc/en && make clean
131
116
        cd doc/es && make clean
132
 
        cd doc/ja && make clean
133
117
        cd doc/ru && make clean
134
118
        cd doc/developers && make clean
135
119
 
138
122
        doc/en/user-reference/index.txt \
139
123
        doc/es/Makefile \
140
124
        doc/es/make.bat \
141
 
        doc/ja/Makefile \
142
 
        doc/ja/make.bat \
143
125
        doc/ru/Makefile \
144
126
        doc/ru/make.bat \
145
127
        doc/developers/Makefile \
146
128
        doc/developers/make.bat
147
129
 
148
 
NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)
149
 
 
150
130
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
151
131
        $(PYTHON) tools/generate_docs.py -o $@ rstx
152
132
 
153
 
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
154
 
        $(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
 
133
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
 
134
        $(PYTHON) tools/generate_release_notes.py NEWS $@
155
135
 
156
136
doc/%/Makefile: doc/en/Makefile
157
137
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
164
144
        cd doc/en && make html
165
145
        cd doc/es && make html
166
146
        cd doc/ru && make html
167
 
        cd doc/ja && make html
168
147
        cd doc/developers && make html
169
148
 
170
149
# Build the PDF docs using Sphinx. This requires numerous LaTeX
175
154
pdf-sphinx: $(SPHINX_DEPENDENCIES)
176
155
        cd doc/en && make latex
177
156
        cd doc/es && make latex
178
 
        cd doc/ja && make latex
179
157
        cd doc/developers && make latex
180
158
        cd doc/en/_build/latex && make all-pdf
181
159
        cd doc/es/_build/latex && make all-pdf
188
166
        cd doc/en && make htmlhelp
189
167
        cd doc/es && make htmlhelp
190
168
        cd doc/ru && make htmlhelp
191
 
        cd doc/ja && make htmlhelp
192
169
        cd doc/developers && make htmlhelp
193
170
 
194
171
 
195
 
# Build the texinfo files using Sphinx.
196
 
texinfo-sphinx: $(SPHINX_DEPENDENCIES)
197
 
        cd doc/en && make texinfo
198
 
        cd doc/es && make texinfo
199
 
        cd doc/ru && make texinfo
200
 
        cd doc/ja && make texinfo
201
 
        cd doc/developers && make texinfo
202
 
 
203
172
### Documentation Website ###
204
173
 
205
174
# Where to build the website
206
 
DOC_WEBSITE_BUILD = build_doc_website
 
175
DOC_WEBSITE_BUILD := build_doc_website
207
176
 
208
177
# Build and package docs into a website, complete with downloads.
209
178
doc-website: html-sphinx pdf-sphinx
210
179
        $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
211
180
        $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
212
181
        $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
213
 
        $(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
214
182
        $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
215
183
 
216
184
 
220
188
# support our "plain" html documentation so that Sphinx is not a hard
221
189
# dependency for packagers on older platforms.
222
190
 
223
 
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
191
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
224
192
 
225
193
# translate txt docs to html
226
 
derived_txt_files = \
 
194
derived_txt_files := \
 
195
        doc/en/user-reference/bzr_man.txt \
227
196
        doc/en/release-notes/NEWS.txt
228
 
txt_all = \
 
197
txt_all := \
229
198
        doc/en/tutorials/tutorial.txt \
230
199
        doc/en/tutorials/using_bazaar_with_launchpad.txt \
231
200
        doc/en/tutorials/centralized_workflow.txt \
232
201
        $(wildcard doc/es/tutorials/*.txt) \
233
 
                $(wildcard doc/ru/tutorials/*.txt) \
234
 
        doc/ja/tutorials/tutorial.txt \
235
 
        doc/ja/tutorials/using_bazaar_with_launchpad.txt \
236
 
        doc/ja/tutorials/centralized_workflow.txt \
 
202
        $(wildcard doc/ru/tutorials/*.txt) \
237
203
        $(wildcard doc/*/mini-tutorial/index.txt) \
238
204
        $(wildcard doc/*/user-guide/index-plain.txt) \
239
 
        doc/en/admin-guide/index-plain.txt \
240
205
        $(wildcard doc/es/guia-usario/*.txt) \
241
206
        $(derived_txt_files) \
242
207
        doc/en/upgrade-guide/index.txt \
243
208
        doc/index.txt \
244
209
        $(wildcard doc/index.*.txt)
245
 
txt_nohtml = \
 
210
txt_nohtml := \
246
211
        doc/en/user-guide/index.txt \
247
212
        doc/es/user-guide/index.txt \
248
 
        doc/ja/user-guide/index.txt \
249
 
        doc/ru/user-guide/index.txt \
250
 
        doc/en/admin-guide/index.txt
251
 
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
252
 
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
 
213
        doc/ru/user-guide/index.txt
 
214
txt_files := $(filter-out $(txt_nohtml), $(txt_all))
 
215
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
253
216
 
254
 
non_txt_files = \
 
217
non_txt_files := \
255
218
       doc/default.css \
256
219
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
257
220
       $(wildcard doc/*/bzr-en-quick-reference.png) \
266
229
 
267
230
# doc/developers/*.txt files that should *not* be individually
268
231
# converted to HTML
269
 
dev_txt_nohtml = \
 
232
dev_txt_nohtml := \
270
233
        doc/developers/add.txt \
271
234
        doc/developers/annotate.txt \
272
235
        doc/developers/bundle-creation.txt \
292
255
        doc/developers/status.txt \
293
256
        doc/developers/uncommit.txt
294
257
 
295
 
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
296
 
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
297
 
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
258
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
 
259
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
 
260
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
298
261
 
299
262
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
300
263
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
305
268
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
306
269
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
307
270
#
308
 
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide)) 
309
 
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
310
 
 
311
271
doc/developers/%.html: doc/developers/%.txt
312
272
        $(rst2html) --stylesheet=../default.css $< $@
313
273
 
318
278
        $(rst2html) --stylesheet=default.css $< $@
319
279
 
320
280
%.html: %.txt
321
 
        $(rst2html) --stylesheet=../../default.css $< "$@"
322
 
 
323
 
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
324
 
        $(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
 
281
        $(rst2html) --stylesheet=../../default.css $< $@
 
282
 
 
283
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
284
        $(PYTHON) tools/generate_docs.py -o $@ rstx
 
285
 
 
286
doc/en/release-notes/NEWS.txt: NEWS
 
287
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
325
288
 
326
289
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
327
290
 
336
299
docs-plain: $(ALL_DOCS)
337
300
 
338
301
# produce a tree containing just the final docs, ready for uploading to the web
339
 
HTMLDIR = html_docs
 
302
HTMLDIR := html_docs
340
303
html-plain: docs-plain
341
304
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
342
305
 
362
325
# These are files that need to be copied into the build location to boostrap
363
326
# the build process.
364
327
# Note that the path is relative to tools/win32
365
 
BUILDOUT_FILES = buildout.cfg \
 
328
BUILDOUT_FILES := buildout.cfg \
366
329
        buildout-templates/bin/build-installer.bat.in \
367
330
        ostools.py bootstrap.py
368
331
 
429
392
        $(PYTHON) tools/win32/ostools.py remove dist
430
393
 
431
394
 
432
 
# i18n targets
433
 
 
434
 
.PHONY: update-pot po/bzr.pot
435
 
update-pot: po/bzr.pot
436
 
 
437
 
TRANSLATABLE_PYFILES:=$(shell find bzrlib -name '*.py' \
438
 
                | grep -v 'bzrlib/tests/' \
439
 
                | grep -v 'bzrlib/doc' \
440
 
                )
441
 
 
442
 
po/bzr.pot: $(PYFILES) $(DOCFILES)
443
 
        $(PYTHON) ./bzr export-pot --include-duplicates > po/bzr.pot
444
 
        echo $(TRANSLATABLE_PYFILES) | xargs \
445
 
          xgettext --package-name "bzr" \
446
 
          --msgid-bugs-address "<bazaar@canonical.com>" \
447
 
          --copyright-holder "Canonical" \
448
 
          --from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \
449
 
          -d bzr -p po -o bzr.pot
450
 
 
451
 
 
452
395
### Packaging Targets ###
453
396
 
454
 
.PHONY: dist check-dist-tarball
 
397
.PHONY: dist dist-upload-escudero check-dist-tarball
455
398
 
456
399
# build a distribution source tarball
457
400
#
466
409
        $(MAKE) clean && \
467
410
        $(MAKE) && \
468
411
        bzr export $$expdir && \
469
 
        cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
 
412
        cp bzrlib/*.c $$expdir/bzrlib/. && \
470
413
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
471
414
        gpg --detach-sign $$tarball && \
472
415
        rm -rf $$expbasedir
479
422
        tar Cxz $$tmpdir -f $$tarball && \
480
423
        $(MAKE) -C $$tmpdir/bzr-$$version check && \
481
424
        rm -rf $$tmpdir
 
425
 
 
426
 
 
427
# upload previously built tarball to the download directory on bazaar-vcs.org,
 
428
# and verify that it can be downloaded ok.
 
429
dist-upload-escudero:
 
430
        version=`./bzr version --short` && \
 
431
        tarball=../bzr-$$version.tar.gz && \
 
432
        scp $$tarball $$tarball.sig \
 
433
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
 
434
                && \
 
435
        echo verifying over http... && \
 
436
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
 
437
                | diff -s - $$tarball && \
 
438
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
 
439
                | diff -s - $$tarball.sig