~bzr-pqm/bzr/bzr.dev

5752.3.8 by John Arbash Meinel
Merge bzr.dev 5764 to resolve release-notes (aka NEWS) conflicts
1
# Copyright (C) 2005-2011 Canonical Ltd
2399.1.1 by John Arbash Meinel
Update Makefile to add 'make api-docs' using pydoctor
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2399.1.1 by John Arbash Meinel
Update Makefile to add 'make api-docs' using pydoctor
16
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
# building documentation, etc.
19
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
20
21
### Core Stuff ###
22
2916.1.1 by Andrew Bennetts
Allow overriding the PYTHON executable for 'make extensions', and remove *.so files in 'make clean'.
23
PYTHON=python
4392.3.18 by Sidnei da Silva
- Make python-installer too
24
PYTHON24=python24
25
PYTHON25=python25
4580.5.1 by John Arbash Meinel
Try to update the buildout rules for the newest versions of everything.
26
PYTHON26=python26
4392.3.23 by Sidnei da Silva
- Define targets as 'release' and 'dev', allow passing them through make
27
BZR_TARGET=release
28
PLUGIN_TARGET=plugin-release
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
29
PYTHON_BUILDFLAGS=
2916.1.1 by Andrew Bennetts
Allow overriding the PYTHON executable for 'make extensions', and remove *.so files in 'make clean'.
30
5756.1.1 by Jelmer Vernooij
Add a 'make realclean' target that cleans up generated .c and .h files
31
.PHONY: all clean realclean extensions pyflakes api-docs check-nodocs check
1739.1.6 by Robert Collins
Resolve conflicts with bzr.dev.
32
1739.1.5 by Robert Collins
Review feedback.
33
all: extensions
34
35
extensions:
1739.1.3 by Robert Collins
Merge bzr.dev.
36
	@echo "building extension modules."
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
37
	$(PYTHON) setup.py build_ext -i $(PYTHON_BUILDFLAGS)
1102 by Martin Pool
- merge test refactoring from robertc
38
3893.1.1 by Aaron Bentley
Add check-nodocs target
39
check: docs check-nodocs
40
41
check-nodocs: extensions
5397.1.1 by John Arbash Meinel
Make any failure be treated as a real failure.
42
	set -e
5051.5.1 by Robert Collins
* PQM will now run with subunit output. To analyze a PQM error use
43
	# Generate a stream for PQM to watch.
5397.1.4 by John Arbash Meinel
Merge vila's bug #626667 fix, add -f to the RM for set -e to not fail.
44
	-$(RM) -f selftest.log
6112.3.1 by Vincent Ladeuil
Output time stamps while running ``make check`` to get better timings from pqm
45
	echo `date` ": selftest starts" 1>&2
6319.1.2 by Martin Pool
Set a timeout of 120s per test during 'make check'
46
	$(PYTHON) -Werror -Wignore::ImportWarning -O ./bzr selftest -Oselftest.timeout=120 \
47
	  --subunit $(tests) | tee selftest.log
6112.3.1 by Vincent Ladeuil
Output time stamps while running ``make check`` to get better timings from pqm
48
	echo `date` ": selftest ends" 1>&2
5396.2.1 by Vincent Ladeuil
Catch errors in ``make check-no-docs`` to avoid merging invalid submissions.
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
5051.5.1 by Robert Collins
* PQM will now run with subunit output. To analyze a PQM error use
53
	# Check that there were no errors reported.
54
	subunit-stats < selftest.log
1102 by Martin Pool
- merge test refactoring from robertc
55
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
56
# Run Python style checker (apt-get install pyflakes)
2625.11.1 by Martin Pool
(trivial) Remove obsolete Makefile targets
57
#
58
# Note that at present this gives many false warnings, because it doesn't
59
# know about identifiers loaded through lazy_import.
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
60
pyflakes:
61
	pyflakes bzrlib
62
63
pyflakes-nounused:
64
	# There are many of these warnings at the moment and they're not a
65
	# high priority to fix
66
	pyflakes bzrlib | grep -v ' imported but unused'
67
68
clean:
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
69
	$(PYTHON) setup.py clean
2916.1.1 by Andrew Bennetts
Allow overriding the PYTHON executable for 'make extensions', and remove *.so files in 'make clean'.
70
	-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
1185.1.21 by Robert Collins
add a clean target
71
5756.1.1 by Jelmer Vernooij
Add a 'make realclean' target that cleans up generated .c and .h files
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
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
77
# Build API documentation
2399.1.9 by John Arbash Meinel
Since I have epydoc working with lazy imports, make it the default api doc generator.
78
docfiles = bzr bzrlib
2399.1.1 by John Arbash Meinel
Update Makefile to add 'make api-docs' using pydoctor
79
api-docs:
2413.4.1 by John Arbash Meinel
Cherrypick just the epydoc builder changes.
80
	mkdir -p api/html
5891.1.1 by Andrew Bennetts
Use pydoctor in api-docs make target.
81
	pydoctor --make-html --docformat='restructuredtext' --html-output=api/html $(docfiles)
2399.1.12 by John Arbash Meinel
Add make check-api-docs, which runs epydoc --check, rather than generating output
82
2625.11.2 by Martin Pool
Put back better rules for building ctags
83
# build tags for emacs and vim
84
TAGS:
85
	ctags -R -e bzrlib
86
87
tags:
88
	ctags -R bzrlib
89
90
# these are treated as phony so they'll always be rebuilt - it's pretty quick
91
.PHONY: TAGS tags
92
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
93
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
94
### Documentation ###
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
95
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
96
# Default to plain documentation for maximum backwards compatibility.
97
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
98
4634.39.37 by Ian Clatworthy
Makefile tweaks
99
docs: docs-plain
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
100
101
clean-docs: clean-plain
102
103
html-docs: html-plain
104
105
106
### Man-page Documentation ###
107
108
MAN_DEPENDENCIES = bzrlib/builtins.py \
109
	$(wildcard bzrlib/*.py) \
110
	$(wildcard bzrlib/*/*.py) \
111
	tools/generate_docs.py \
112
	$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
113
114
MAN_PAGES = man1/bzr.1
115
man1/bzr.1: $(MAN_DEPENDENCIES)
116
	$(PYTHON) tools/generate_docs.py -o $@ man
117
118
119
### Sphinx-style Documentation ###
120
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
121
# Build the documentation. To keep the dependencies down to a minimum
122
# for distro packagers, we only build the html documentation by default.
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
123
# Sphinx 0.6 or later is preferred for the best rendering, though
124
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
125
# for installation instructions.
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
126
docs-sphinx: html-sphinx
4634.39.15 by Ian Clatworthy
Simplify Makefile
127
128
# Clean out generated documentation
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
129
clean-sphinx:
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
130
	cd doc/en && make clean
4634.39.15 by Ian Clatworthy
Simplify Makefile
131
	cd doc/es && make clean
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
132
	cd doc/ja && make clean
4634.39.15 by Ian Clatworthy
Simplify Makefile
133
	cd doc/ru && make clean
134
	cd doc/developers && make clean
135
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
136
SPHINX_DEPENDENCIES = \
137
        doc/en/release-notes/index.txt \
138
        doc/en/user-reference/index.txt \
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
139
	doc/es/Makefile \
140
	doc/es/make.bat \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
141
	doc/ja/Makefile \
142
	doc/ja/make.bat \
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
143
	doc/ru/Makefile \
144
	doc/ru/make.bat \
145
	doc/developers/Makefile \
146
	doc/developers/make.bat
147
5462.5.1 by Andrew Bennetts
Split NEWS into per-release doc/en/release-notes/bzr-*.txt
148
NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)
149
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
150
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
151
	$(PYTHON) tools/generate_docs.py -o $@ rstx
152
5462.5.1 by Andrew Bennetts
Split NEWS into per-release doc/en/release-notes/bzr-*.txt
153
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
154
	$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
155
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
156
doc/%/Makefile: doc/en/Makefile
157
	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
158
159
doc/%/make.bat: doc/en/make.bat
160
	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
4634.39.15 by Ian Clatworthy
Simplify Makefile
161
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
162
# Build the html docs using Sphinx.
163
html-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
164
	cd doc/en && make html
4634.39.15 by Ian Clatworthy
Simplify Makefile
165
	cd doc/es && make html
166
	cd doc/ru && make html
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
167
	cd doc/ja && make html
4634.39.15 by Ian Clatworthy
Simplify Makefile
168
	cd doc/developers && make html
169
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
170
# Build the PDF docs using Sphinx. This requires numerous LaTeX
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
171
# packages. See http://sphinx.pocoo.org/builders.html for details.
4634.39.15 by Ian Clatworthy
Simplify Makefile
172
# Note: We don't currently build PDFs for the Russian docs because
173
# they require additional packages to be installed (to handle
174
# Russian hyphenation rules, etc.)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
175
pdf-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
176
	cd doc/en && make latex
4634.39.15 by Ian Clatworthy
Simplify Makefile
177
	cd doc/es && make latex
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
178
	cd doc/ja && make latex
4634.39.15 by Ian Clatworthy
Simplify Makefile
179
	cd doc/developers && make latex
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
180
	cd doc/en/_build/latex && make all-pdf
4634.39.15 by Ian Clatworthy
Simplify Makefile
181
	cd doc/es/_build/latex && make all-pdf
182
	cd doc/developers/_build/latex && make all-pdf
183
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
184
# Build the CHM (Windows Help) docs using Sphinx.
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
185
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
186
# to generate the final chm files.
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
187
chm-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
188
	cd doc/en && make htmlhelp
4634.39.15 by Ian Clatworthy
Simplify Makefile
189
	cd doc/es && make htmlhelp
190
	cd doc/ru && make htmlhelp
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
191
	cd doc/ja && make htmlhelp
4634.39.15 by Ian Clatworthy
Simplify Makefile
192
	cd doc/developers && make htmlhelp
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
193
2522.3.1 by Robert Collins
Draft proposed integration order for performance changes.
194
6437.48.1 by Vincent Ladeuil
Rely on sphinx for texinfo doc generation
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
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
203
### Documentation Website ###
204
205
# Where to build the website
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
206
DOC_WEBSITE_BUILD = build_doc_website
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
207
208
# Build and package docs into a website, complete with downloads.
4634.39.37 by Ian Clatworthy
Makefile tweaks
209
doc-website: html-sphinx pdf-sphinx
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
210
	$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
211
	$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
212
	$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
4634.97.5 by Martin Pool
Japanese docs need to be installed too (how tedious)
213
	$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
214
	$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
215
216
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
217
### Plain Documentation ###
218
219
# While Sphinx is the preferred tool for building documentation, we still
220
# support our "plain" html documentation so that Sphinx is not a hard
221
# dependency for packagers on older platforms.
222
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
223
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
224
225
# translate txt docs to html
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
226
derived_txt_files = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
227
	doc/en/release-notes/NEWS.txt
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
228
txt_all = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
229
	doc/en/tutorials/tutorial.txt \
230
	doc/en/tutorials/using_bazaar_with_launchpad.txt \
231
	doc/en/tutorials/centralized_workflow.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
232
        $(wildcard doc/es/tutorials/*.txt) \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
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 \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
237
	$(wildcard doc/*/mini-tutorial/index.txt) \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
238
	$(wildcard doc/*/user-guide/index-plain.txt) \
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
239
	doc/en/admin-guide/index-plain.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
240
	$(wildcard doc/es/guia-usario/*.txt) \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
241
	$(derived_txt_files) \
242
	doc/en/upgrade-guide/index.txt \
243
	doc/index.txt \
244
	$(wildcard doc/index.*.txt)
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
245
txt_nohtml = \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
246
	doc/en/user-guide/index.txt \
247
	doc/es/user-guide/index.txt \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
248
	doc/ja/user-guide/index.txt \
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
249
	doc/ru/user-guide/index.txt \
250
	doc/en/admin-guide/index.txt
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
251
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
252
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
253
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
254
non_txt_files = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
255
       doc/default.css \
256
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
257
       $(wildcard doc/*/bzr-en-quick-reference.png) \
258
       $(wildcard doc/*/bzr-en-quick-reference.pdf) \
259
       $(wildcard doc/*/bzr-es-quick-reference.svg) \
260
       $(wildcard doc/*/bzr-es-quick-reference.png) \
261
       $(wildcard doc/*/bzr-es-quick-reference.pdf) \
262
       $(wildcard doc/*/bzr-ru-quick-reference.svg) \
263
       $(wildcard doc/*/bzr-ru-quick-reference.png) \
264
       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \
265
       $(wildcard doc/*/user-guide/images/*.png)
266
267
# doc/developers/*.txt files that should *not* be individually
268
# converted to HTML
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
269
dev_txt_nohtml = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
270
	doc/developers/add.txt \
271
	doc/developers/annotate.txt \
272
	doc/developers/bundle-creation.txt \
273
	doc/developers/commit.txt \
274
	doc/developers/diff.txt \
275
	doc/developers/directory-fingerprints.txt \
276
	doc/developers/gc.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
277
	doc/developers/implementation-notes.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
278
	doc/developers/incremental-push-pull.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
279
	doc/developers/index.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
280
	doc/developers/initial-push-pull.txt \
281
	doc/developers/merge-scaling.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
282
	doc/developers/miscellaneous-notes.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
283
	doc/developers/missing.txt \
284
	doc/developers/performance-roadmap-rationale.txt \
285
	doc/developers/performance-use-case-analysis.txt \
286
	doc/developers/planned-change-integration.txt \
287
	doc/developers/planned-performance-changes.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
288
	doc/developers/plans.txt \
289
	doc/developers/process.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
290
	doc/developers/revert.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
291
	doc/developers/specifications.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
292
	doc/developers/status.txt \
293
	doc/developers/uncommit.txt
294
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
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)) 
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
298
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
299
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
300
	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
301
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
302
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 
303
#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
304
#
305
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
306
#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
307
#
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
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
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
311
doc/developers/%.html: doc/developers/%.txt
312
	$(rst2html) --stylesheet=../default.css $< $@
313
314
doc/index.html: doc/index.txt
315
	$(rst2html) --stylesheet=default.css $< $@
316
317
doc/index.%.html: doc/index.%.txt
318
	$(rst2html) --stylesheet=default.css $< $@
319
320
%.html: %.txt
5498.1.2 by Martin Pool
Superstitious argument quoting in makefile
321
	$(rst2html) --stylesheet=../../default.css $< "$@"
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
322
5462.5.3 by Andrew Bennetts
Keep docs-plain working.
323
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
5498.1.2 by Martin Pool
Superstitious argument quoting in makefile
324
	$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
325
326
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
327
328
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
329
	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
330
331
derived_web_docs = $(htm_files) $(dev_htm_files) 
332
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
333
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
334
335
# the main target to build all the docs
336
docs-plain: $(ALL_DOCS)
337
338
# produce a tree containing just the final docs, ready for uploading to the web
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
339
HTMLDIR = html_docs
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
340
html-plain: docs-plain
341
	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
342
343
# clean produced docs
344
clean-plain:
345
	$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
346
	    $(HTMLDIR) $(derived_txt_files)
347
348
349
### Miscellaneous Documentation Targets ###
350
351
# build a png of our performance task list
352
# this is no longer built by default; you can build it if you want to look at it
353
doc/developers/performance.png: doc/developers/performance.dot
354
	@echo Generating $@
355
	@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
356
357
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
358
### Windows Support ###
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
359
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
360
# make all the installers completely from scratch, using zc.buildout
361
# to fetch the dependencies
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
362
# These are files that need to be copied into the build location to boostrap
363
# the build process.
364
# Note that the path is relative to tools/win32
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
365
BUILDOUT_FILES = buildout.cfg \
4580.5.5 by John Arbash Meinel
We need ostools.py as well
366
	buildout-templates/bin/build-installer.bat.in \
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
367
	ostools.py bootstrap.py
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
368
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
369
installer-all:
4580.5.4 by John Arbash Meinel
Something about *** makes it print out all the files in the current dir.
370
	@echo Make all the installers from scratch
371
	@# Build everything in a separate directory, to avoid cluttering the WT
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
372
	$(PYTHON) tools/win32/ostools.py makedir build-win32
373
	@# cd to tools/win32 so that the relative paths are copied correctly
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
374
	cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
375
	@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
376
	@# existing release directories, so delete them manually before building
377
	@# It means things may be rebuilt that don't need to be, but at least
378
	@# it will be correct when they do.
379
	cd build-win32 && $(PYTHON) ostools.py remove release */release
380
	cd build-win32 && $(PYTHON) bootstrap.py
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
381
	cd build-win32 && bin/buildout
382
	cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
383
384
385
clean-installer-all:
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
386
	$(PYTHON) tools/win32/ostools.py remove build-win32
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
387
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
388
# make bzr.exe for win32 with py2exe
389
exe:
390
	@echo *** Make bzr.exe
4385.2.1 by Alexander Belchenko
Workaround for running `make exe` second time: remove all compiled extensions because they will be recompiled anyway.
391
	$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
3514.1.1 by John Arbash Meinel
Updates to allow building with mingw, and to exclude Vista system dlls
392
	$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
393
	$(PYTHON) setup.py py2exe > py2exe.log
394
	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
395
	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
396
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
397
# win32 installer for bzr.exe
1982.2.1 by Alexander Belchenko
small but important fix for 'make installer' dependencies
398
installer: exe copy-docs
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
399
	@echo *** Make Windows installer
3557.1.3 by John Arbash Meinel
trivial tweak of Makefile to use the PYTHON variable
400
	$(PYTHON) tools/win32/run_script.py cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
1861.2.18 by Alexander Belchenko
Makefile: cross-platform actions for building installer
401
	iscc /Q tools/win32/bzr.iss
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
402
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
403
# win32 Python's distutils-based installer
404
# require to have Python interpreter installed on win32
2946.2.1 by Alexander Belchenko
windows python-based installer: shortcut for uninstall action
405
py-inst-24: docs
4392.3.18 by Sidnei da Silva
- Make python-installer too
406
	$(PYTHON24) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
2946.2.1 by Alexander Belchenko
windows python-based installer: shortcut for uninstall action
407
408
py-inst-25: docs
4392.3.18 by Sidnei da Silva
- Make python-installer too
409
	$(PYTHON25) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
410
4459.1.1 by John Arbash Meinel
Include python-2.6 as a build target for standalone builds.
411
py-inst-26: docs
4580.5.1 by John Arbash Meinel
Try to update the buildout rules for the newest versions of everything.
412
	$(PYTHON26) setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
4459.1.1 by John Arbash Meinel
Include python-2.6 as a build target for standalone builds.
413
414
python-installer: py-inst-24 py-inst-25 py-inst-26
2946.2.1 by Alexander Belchenko
windows python-based installer: shortcut for uninstall action
415
416
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
417
copy-docs: docs
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
418
	$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
419
	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
420
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
421
# clean on win32 all installer-related files and directories
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
422
clean-win32: clean-docs
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
423
	$(PYTHON) tools/win32/ostools.py remove build
424
	$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
425
	$(PYTHON) tools/win32/ostools.py remove py2exe.log
426
	$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
427
	$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
428
	$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
429
	$(PYTHON) tools/win32/ostools.py remove dist
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
430
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
431
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
432
# i18n targets
433
434
.PHONY: update-pot po/bzr.pot
435
update-pot: po/bzr.pot
436
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
437
TRANSLATABLE_PYFILES:=$(shell find bzrlib -name '*.py' \
438
    		| grep -v 'bzrlib/tests/' \
5830.2.7 by INADA Naoki
Don't exclude bzr.util for translation target.
439
    		| grep -v 'bzrlib/doc' \
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
440
		)
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
441
442
po/bzr.pot: $(PYFILES) $(DOCFILES)
6351.2.2 by Martin Packman
Use --include-duplicates for make update-pot which already combines multiple msgid strings prettily
443
	$(PYTHON) ./bzr export-pot --include-duplicates > po/bzr.pot
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
444
	echo $(TRANSLATABLE_PYFILES) | xargs \
5830.2.10 by INADA Naoki
Change package name of pot from Bazaar to bzr
445
	  xgettext --package-name "bzr" \
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
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
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
452
### Packaging Targets ###
453
4988.4.1 by Martin Pool
Delete obsolete makefile targets about escudero
454
.PHONY: dist check-dist-tarball
3346.2.3 by Martin Pool
Add dist-upload-escudero target
455
4676.7.1 by Martin Pool
Stop building a source zip; it's not very useful
456
# build a distribution source tarball
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
457
#
458
# this method of copying the pyrex generated files is a bit ugly; it would be
459
# nicer to generate it from distutils.
460
dist: 
461
	version=`./bzr version --short` && \
462
	echo Building distribution of bzr $$version && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
463
	expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
464
	expdir=$$expbasedir/bzr-$$version && \
465
	tarball=$$PWD/../bzr-$$version.tar.gz && \
466
	$(MAKE) clean && \
467
	$(MAKE) && \
468
	bzr export $$expdir && \
4736.2.1 by John Arbash Meinel
Start adding the .h files to the release tarballs as well.
469
	cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
470
	tar cfz $$tarball -C $$expbasedir bzr-$$version && \
471
	gpg --detach-sign $$tarball && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
472
	rm -rf $$expbasedir
3346.2.3 by Martin Pool
Add dist-upload-escudero target
473
3346.2.5 by Martin Pool
Add check-dist-tarball to run tests from the packaged source
474
# run all tests in a previously built tarball
475
check-dist-tarball:
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
476
	tmpdir=`mktemp -t -d tmp_bzr_check_dist.XXXXXXXXXX` && \
3346.2.5 by Martin Pool
Add check-dist-tarball to run tests from the packaged source
477
	version=`./bzr version --short` && \
478
	tarball=$$PWD/../bzr-$$version.tar.gz && \
479
	tar Cxz $$tmpdir -f $$tarball && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
480
	$(MAKE) -C $$tmpdir/bzr-$$version check && \
481
	rm -rf $$tmpdir