← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Joe Julian
  • Date: 2010-01-10 02:25:31 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: joe@julianfamily.org-20100110022531-wqk61rsagz8xsiga
https://launchpad.net/bugs/175839
Added MANIFEST.in to allow bdist_rpm to have all the required include files and tools. bdist_rpm will still fail to build correctly on some distributions due to a disttools bug http://bugs.python.org/issue644744

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, 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
21
21
### Core Stuff ###
22
22
 
23
23
PYTHON=python
 
24
PYTHON24=python24
 
25
PYTHON25=python25
 
26
PYTHON26=python26
 
27
BZR_TARGET=release
 
28
PLUGIN_TARGET=plugin-release
24
29
PYTHON_BUILDFLAGS=
25
30
 
26
31
.PHONY: all clean extensions pyflakes api-docs check-nodocs check
72
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
73
78
.PHONY: TAGS tags
74
79
 
 
80
 
75
81
### Documentation ###
76
82
 
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
# Default to plain documentation for maximum backwards compatibility.
 
84
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
 
85
 
 
86
docs: docs-plain
 
87
 
 
88
clean-docs: clean-plain
 
89
 
 
90
html-docs: html-plain
 
91
 
 
92
 
 
93
### Man-page Documentation ###
 
94
 
 
95
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
96
        $(wildcard bzrlib/*.py) \
 
97
        $(wildcard bzrlib/*/*.py) \
 
98
        tools/generate_docs.py \
 
99
        $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
100
 
 
101
MAN_PAGES = man1/bzr.1
 
102
man1/bzr.1: $(MAN_DEPENDENCIES)
 
103
        $(PYTHON) tools/generate_docs.py -o $@ man
 
104
 
 
105
 
 
106
### Sphinx-style Documentation ###
 
107
 
 
108
# Build the documentation. To keep the dependencies down to a minimum
 
109
# for distro packagers, we only build the html documentation by default.
 
110
# Sphinx 0.6 or later is preferred for the best rendering, though
 
111
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
 
112
# for installation instructions.
 
113
docs-sphinx: html-sphinx
 
114
 
 
115
# Clean out generated documentation
 
116
clean-sphinx:
 
117
        cd doc/en && make clean
 
118
        cd doc/es && make clean
 
119
        cd doc/ja && make clean
 
120
        cd doc/ru && make clean
 
121
        cd doc/developers && make clean
 
122
 
 
123
SPHINX_DEPENDENCIES = \
 
124
        doc/en/release-notes/index.txt \
 
125
        doc/en/user-reference/index.txt \
 
126
        doc/es/Makefile \
 
127
        doc/es/make.bat \
 
128
        doc/ja/Makefile \
 
129
        doc/ja/make.bat \
 
130
        doc/ru/Makefile \
 
131
        doc/ru/make.bat \
 
132
        doc/developers/Makefile \
 
133
        doc/developers/make.bat
 
134
 
 
135
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
 
136
        $(PYTHON) tools/generate_docs.py -o $@ rstx
 
137
 
 
138
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
 
139
        $(PYTHON) tools/generate_release_notes.py NEWS $@
 
140
 
 
141
doc/%/Makefile: doc/en/Makefile
 
142
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
143
 
 
144
doc/%/make.bat: doc/en/make.bat
 
145
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
146
 
 
147
# Build the html docs using Sphinx.
 
148
html-sphinx: $(SPHINX_DEPENDENCIES)
 
149
        cd doc/en && make html
 
150
        cd doc/es && make html
 
151
        cd doc/ru && make html
 
152
        cd doc/ja && make html
 
153
        cd doc/developers && make html
 
154
 
 
155
# Build the PDF docs using Sphinx. This requires numerous LaTeX
 
156
# packages. See http://sphinx.pocoo.org/builders.html for details.
 
157
# Note: We don't currently build PDFs for the Russian docs because
 
158
# they require additional packages to be installed (to handle
 
159
# Russian hyphenation rules, etc.)
 
160
pdf-sphinx: $(SPHINX_DEPENDENCIES)
 
161
        cd doc/en && make latex
 
162
        cd doc/es && make latex
 
163
        cd doc/ja && make latex
 
164
        cd doc/developers && make latex
 
165
        cd doc/en/_build/latex && make all-pdf
 
166
        cd doc/es/_build/latex && make all-pdf
 
167
        cd doc/developers/_build/latex && make all-pdf
 
168
 
 
169
# Build the CHM (Windows Help) docs using Sphinx.
 
170
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
 
171
# to generate the final chm files.
 
172
chm-sphinx: $(SPHINX_DEPENDENCIES)
 
173
        cd doc/en && make htmlhelp
 
174
        cd doc/es && make htmlhelp
 
175
        cd doc/ru && make htmlhelp
 
176
        cd doc/ja && make htmlhelp
 
177
        cd doc/developers && make htmlhelp
 
178
 
 
179
 
 
180
### Documentation Website ###
 
181
 
 
182
# Where to build the website
 
183
DOC_WEBSITE_BUILD = build_doc_website
 
184
 
 
185
# Build and package docs into a website, complete with downloads.
 
186
doc-website: html-sphinx pdf-sphinx
 
187
        $(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
 
188
        $(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
 
189
        $(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
 
190
        $(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
 
191
        $(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
 
192
 
 
193
 
 
194
### Plain Documentation ###
 
195
 
 
196
# While Sphinx is the preferred tool for building documentation, we still
 
197
# support our "plain" html documentation so that Sphinx is not a hard
 
198
# dependency for packagers on older platforms.
 
199
 
 
200
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
83
201
 
84
202
# translate txt docs to html
85
 
derived_txt_files := \
 
203
derived_txt_files = \
86
204
        doc/en/user-reference/bzr_man.txt \
87
 
        doc/en/developer-guide/HACKING.txt \
88
205
        doc/en/release-notes/NEWS.txt
89
 
txt_files := $(wildcard doc/en/tutorials/*.txt) \
 
206
txt_all = \
 
207
        doc/en/tutorials/tutorial.txt \
 
208
        doc/en/tutorials/using_bazaar_with_launchpad.txt \
 
209
        doc/en/tutorials/centralized_workflow.txt \
 
210
        $(wildcard doc/es/tutorials/*.txt) \
 
211
                $(wildcard doc/ru/tutorials/*.txt) \
 
212
        doc/ja/tutorials/tutorial.txt \
 
213
        doc/ja/tutorials/using_bazaar_with_launchpad.txt \
 
214
        doc/ja/tutorials/centralized_workflow.txt \
 
215
        $(wildcard doc/*/mini-tutorial/index.txt) \
 
216
        $(wildcard doc/*/user-guide/index-plain.txt) \
 
217
        $(wildcard doc/es/guia-usario/*.txt) \
90
218
        $(derived_txt_files) \
 
219
        doc/en/upgrade-guide/index.txt \
 
220
        doc/index.txt \
 
221
        $(wildcard doc/index.*.txt)
 
222
txt_nohtml = \
91
223
        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 := \
 
224
        doc/es/user-guide/index.txt \
 
225
        doc/ja/user-guide/index.txt \
 
226
        doc/ru/user-guide/index.txt
 
227
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
 
228
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
 
229
 
 
230
non_txt_files = \
98
231
       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
 
 
 
232
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
 
233
       $(wildcard doc/*/bzr-en-quick-reference.png) \
 
234
       $(wildcard doc/*/bzr-en-quick-reference.pdf) \
 
235
       $(wildcard doc/*/bzr-es-quick-reference.svg) \
 
236
       $(wildcard doc/*/bzr-es-quick-reference.png) \
 
237
       $(wildcard doc/*/bzr-es-quick-reference.pdf) \
 
238
       $(wildcard doc/*/bzr-ru-quick-reference.svg) \
 
239
       $(wildcard doc/*/bzr-ru-quick-reference.png) \
 
240
       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \
 
241
       $(wildcard doc/*/user-guide/images/*.png)
 
242
 
 
243
# doc/developers/*.txt files that should *not* be individually
 
244
# converted to HTML
 
245
dev_txt_nohtml = \
 
246
        doc/developers/add.txt \
 
247
        doc/developers/annotate.txt \
 
248
        doc/developers/bundle-creation.txt \
 
249
        doc/developers/commit.txt \
 
250
        doc/developers/diff.txt \
 
251
        doc/developers/directory-fingerprints.txt \
 
252
        doc/developers/gc.txt \
 
253
        doc/developers/implementation-notes.txt \
 
254
        doc/developers/incremental-push-pull.txt \
 
255
        doc/developers/index.txt \
 
256
        doc/developers/initial-push-pull.txt \
 
257
        doc/developers/merge-scaling.txt \
 
258
        doc/developers/miscellaneous-notes.txt \
 
259
        doc/developers/missing.txt \
 
260
        doc/developers/performance-roadmap-rationale.txt \
 
261
        doc/developers/performance-use-case-analysis.txt \
 
262
        doc/developers/planned-change-integration.txt \
 
263
        doc/developers/planned-performance-changes.txt \
 
264
        doc/developers/plans.txt \
 
265
        doc/developers/process.txt \
 
266
        doc/developers/revert.txt \
 
267
        doc/developers/specifications.txt \
 
268
        doc/developers/status.txt \
 
269
        doc/developers/uncommit.txt
 
270
 
 
271
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
 
272
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
 
273
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
274
 
 
275
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
 
276
        $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
 
277
 
 
278
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 
 
279
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
280
#
 
281
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
 
282
#       $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
283
#
134
284
doc/developers/%.html: doc/developers/%.txt
135
285
        $(rst2html) --stylesheet=../default.css $< $@
136
286
 
137
287
doc/index.html: doc/index.txt
138
288
        $(rst2html) --stylesheet=default.css $< $@
139
289
 
 
290
doc/index.%.html: doc/index.%.txt
 
291
        $(rst2html) --stylesheet=default.css $< $@
 
292
 
140
293
%.html: %.txt
141
294
        $(rst2html) --stylesheet=../../default.css $< $@
142
295
 
143
 
MAN_DEPENDENCIES = bzrlib/builtins.py \
144
 
                 bzrlib/bundle/commands.py \
145
 
                 bzrlib/conflicts.py \
146
 
                 bzrlib/help_topics/__init__.py \
147
 
                 bzrlib/bzrdir.py \
148
 
                 bzrlib/sign_my_commits.py \
149
 
                 bzrlib/bugtracker.py \
150
 
                 generate_docs.py \
151
 
                 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
296
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
 
297
        $(PYTHON) tools/generate_docs.py -o $@ rstx
161
298
 
162
299
doc/en/release-notes/NEWS.txt: NEWS
163
300
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
164
301
 
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
 
302
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
 
303
 
 
304
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
 
305
        $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
 
306
 
 
307
derived_web_docs = $(htm_files) $(dev_htm_files) 
175
308
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
176
309
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
177
310
 
178
311
# the main target to build all the docs
179
 
docs: $(ALL_DOCS)
 
312
docs-plain: $(ALL_DOCS)
180
313
 
181
314
# produce a tree containing just the final docs, ready for uploading to the web
182
 
HTMLDIR := html_docs
183
 
html-docs: docs
 
315
HTMLDIR = html_docs
 
316
html-plain: docs-plain
184
317
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
185
318
 
186
 
# Produce PDF documents.  Requires pdfLaTeX, rubber, and Inkscape.
187
 
pdf-docs: $(PDF_DOCS)
188
 
 
189
319
# clean produced docs
190
 
clean-docs:
 
320
clean-plain:
191
321
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
192
322
            $(HTMLDIR) $(derived_txt_files)
193
 
        rm -f doc/en/user-guide/*.pdf
194
 
        rm -rf doc/en/user-guide/latex_prepared
 
323
 
 
324
 
 
325
### Miscellaneous Documentation Targets ###
 
326
 
 
327
# build a png of our performance task list
 
328
# this is no longer built by default; you can build it if you want to look at it
 
329
doc/developers/performance.png: doc/developers/performance.dot
 
330
        @echo Generating $@
 
331
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
195
332
 
196
333
 
197
334
### Windows Support ###
198
335
 
 
336
# make all the installers completely from scratch, using zc.buildout
 
337
# to fetch the dependencies
 
338
# These are files that need to be copied into the build location to boostrap
 
339
# the build process.
 
340
# Note that the path is relative to tools/win32
 
341
BUILDOUT_FILES = buildout.cfg \
 
342
        buildout-templates/bin/build-installer.bat.in \
 
343
        ostools.py bootstrap.py
 
344
 
 
345
installer-all:
 
346
        @echo Make all the installers from scratch
 
347
        @# Build everything in a separate directory, to avoid cluttering the WT
 
348
        $(PYTHON) tools/win32/ostools.py makedir build-win32
 
349
        @# cd to tools/win32 so that the relative paths are copied correctly
 
350
        cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
 
351
        @# There seems to be a bug in gf.release.bzr, It doesn't correctly update
 
352
        @# existing release directories, so delete them manually before building
 
353
        @# It means things may be rebuilt that don't need to be, but at least
 
354
        @# it will be correct when they do.
 
355
        cd build-win32 && $(PYTHON) ostools.py remove release */release
 
356
        cd build-win32 && $(PYTHON) bootstrap.py
 
357
        cd build-win32 && bin/buildout
 
358
        cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
 
359
 
 
360
 
 
361
clean-installer-all:
 
362
        $(PYTHON) tools/win32/ostools.py remove build-win32
 
363
 
199
364
# make bzr.exe for win32 with py2exe
200
365
exe:
201
366
        @echo *** Make bzr.exe
 
367
        $(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
202
368
        $(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
203
369
        $(PYTHON) setup.py py2exe > py2exe.log
204
370
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
206
372
 
207
373
# win32 installer for bzr.exe
208
374
installer: exe copy-docs
209
 
        @echo *** Make windows installer
 
375
        @echo *** Make Windows installer
210
376
        $(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
211
377
        iscc /Q tools/win32/bzr.iss
212
378
 
213
379
# win32 Python's distutils-based installer
214
380
# require to have Python interpreter installed on win32
215
381
py-inst-24: docs
216
 
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
382
        $(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
217
383
 
218
384
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
 
385
        $(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
386
 
 
387
py-inst-26: docs
 
388
        $(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
389
 
 
390
python-installer: py-inst-24 py-inst-25 py-inst-26
222
391
 
223
392
 
224
393
copy-docs: docs
235
404
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
236
405
        $(PYTHON) tools/win32/ostools.py remove dist
237
406
 
 
407
 
 
408
### Packaging Targets ###
 
409
 
238
410
.PHONY: dist dist-upload-escudero check-dist-tarball
239
411
 
240
412
# build a distribution tarball and zip file.