~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
6015.32.1 by Vincent Ladeuil
Output time stamps while running ``make check`` to get better timings from pqm
45
	echo `date` ": selftest starts" 1>&2
5050.74.1 by Martin Pool
merge up 2.1; restoring python2.4 compatibility and ignoring ImportWarning
46
	$(PYTHON) -Werror -Wignore::ImportWarning -O ./bzr selftest --subunit $(tests) | tee selftest.log
6015.32.1 by Vincent Ladeuil
Output time stamps while running ``make check`` to get better timings from pqm
47
	echo `date` ": selftest ends" 1>&2
5396.2.1 by Vincent Ladeuil
Catch errors in ``make check-no-docs`` to avoid merging invalid submissions.
48
	# An empty log file should catch errors in the $(PYTHON)
49
	# command above (the '|' swallow any errors since 'make'
50
	# sees the 'tee' exit code for the whole line
51
	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
52
	# Check that there were no errors reported.
53
	subunit-stats < selftest.log
1102 by Martin Pool
- merge test refactoring from robertc
54
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
55
# Run Python style checker (apt-get install pyflakes)
2625.11.1 by Martin Pool
(trivial) Remove obsolete Makefile targets
56
#
57
# Note that at present this gives many false warnings, because it doesn't
58
# know about identifiers loaded through lazy_import.
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
59
pyflakes:
60
	pyflakes bzrlib
61
62
pyflakes-nounused:
63
	# There are many of these warnings at the moment and they're not a
64
	# high priority to fix
65
	pyflakes bzrlib | grep -v ' imported but unused'
66
67
clean:
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
68
	$(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'.
69
	-find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
1185.1.21 by Robert Collins
add a clean target
70
5756.1.1 by Jelmer Vernooij
Add a 'make realclean' target that cleans up generated .c and .h files
71
realclean: clean
72
	# Remove files which are autogenerated but included by the tarball.
73
	rm -f bzrlib/*_pyx.c
74
	rm -f bzrlib/_simple_set_pyx.h bzrlib/_simple_set_pyx_api.h
75
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
76
# 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.
77
docfiles = bzr bzrlib
2399.1.1 by John Arbash Meinel
Update Makefile to add 'make api-docs' using pydoctor
78
api-docs:
2413.4.1 by John Arbash Meinel
Cherrypick just the epydoc builder changes.
79
	mkdir -p api/html
5891.1.1 by Andrew Bennetts
Use pydoctor in api-docs make target.
80
	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
81
2625.11.2 by Martin Pool
Put back better rules for building ctags
82
# build tags for emacs and vim
83
TAGS:
84
	ctags -R -e bzrlib
85
86
tags:
87
	ctags -R bzrlib
88
89
# these are treated as phony so they'll always be rebuilt - it's pretty quick
90
.PHONY: TAGS tags
91
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
92
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
93
### Documentation ###
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
94
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
95
# Default to plain documentation for maximum backwards compatibility.
96
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
97
4634.39.37 by Ian Clatworthy
Makefile tweaks
98
docs: docs-plain
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
99
100
clean-docs: clean-plain
101
102
html-docs: html-plain
103
104
105
### Man-page Documentation ###
106
107
MAN_DEPENDENCIES = bzrlib/builtins.py \
108
	$(wildcard bzrlib/*.py) \
109
	$(wildcard bzrlib/*/*.py) \
110
	tools/generate_docs.py \
111
	$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
112
113
MAN_PAGES = man1/bzr.1
114
man1/bzr.1: $(MAN_DEPENDENCIES)
115
	$(PYTHON) tools/generate_docs.py -o $@ man
116
117
118
### Sphinx-style Documentation ###
119
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
120
# Build the documentation. To keep the dependencies down to a minimum
121
# 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
122
# Sphinx 0.6 or later is preferred for the best rendering, though
123
# 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
124
# for installation instructions.
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
125
docs-sphinx: html-sphinx
4634.39.15 by Ian Clatworthy
Simplify Makefile
126
127
# Clean out generated documentation
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
128
clean-sphinx:
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
129
	cd doc/en && make clean
4634.39.15 by Ian Clatworthy
Simplify Makefile
130
	cd doc/es && make clean
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
131
	cd doc/ja && make clean
4634.39.15 by Ian Clatworthy
Simplify Makefile
132
	cd doc/ru && make clean
133
	cd doc/developers && make clean
134
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
135
SPHINX_DEPENDENCIES = \
136
        doc/en/release-notes/index.txt \
137
        doc/en/user-reference/index.txt \
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
138
	doc/es/Makefile \
139
	doc/es/make.bat \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
140
	doc/ja/Makefile \
141
	doc/ja/make.bat \
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
142
	doc/ru/Makefile \
143
	doc/ru/make.bat \
144
	doc/developers/Makefile \
145
	doc/developers/make.bat
146
5462.5.1 by Andrew Bennetts
Split NEWS into per-release doc/en/release-notes/bzr-*.txt
147
NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)
148
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
149
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
150
	$(PYTHON) tools/generate_docs.py -o $@ rstx
151
5462.5.1 by Andrew Bennetts
Split NEWS into per-release doc/en/release-notes/bzr-*.txt
152
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
153
	$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
154
4634.39.24 by Ian Clatworthy
Remove Makefile duplication
155
doc/%/Makefile: doc/en/Makefile
156
	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
157
158
doc/%/make.bat: doc/en/make.bat
159
	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
4634.39.15 by Ian Clatworthy
Simplify Makefile
160
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
161
# Build the html docs using Sphinx.
162
html-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
163
	cd doc/en && make html
4634.39.15 by Ian Clatworthy
Simplify Makefile
164
	cd doc/es && make html
165
	cd doc/ru && make html
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
166
	cd doc/ja && make html
4634.39.15 by Ian Clatworthy
Simplify Makefile
167
	cd doc/developers && make html
168
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
169
# 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
170
# packages. See http://sphinx.pocoo.org/builders.html for details.
4634.39.15 by Ian Clatworthy
Simplify Makefile
171
# Note: We don't currently build PDFs for the Russian docs because
172
# they require additional packages to be installed (to handle
173
# Russian hyphenation rules, etc.)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
174
pdf-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
175
	cd doc/en && make latex
4634.39.15 by Ian Clatworthy
Simplify Makefile
176
	cd doc/es && make latex
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
177
	cd doc/ja && make latex
4634.39.15 by Ian Clatworthy
Simplify Makefile
178
	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
179
	cd doc/en/_build/latex && make all-pdf
4634.39.15 by Ian Clatworthy
Simplify Makefile
180
	cd doc/es/_build/latex && make all-pdf
181
	cd doc/developers/_build/latex && make all-pdf
182
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
183
# 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
184
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
185
# to generate the final chm files.
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
186
chm-sphinx: $(SPHINX_DEPENDENCIES)
4634.39.19 by Ian Clatworthy
Update Makefile: use doc/en instead of doc, only html by default, more comments
187
	cd doc/en && make htmlhelp
4634.39.15 by Ian Clatworthy
Simplify Makefile
188
	cd doc/es && make htmlhelp
189
	cd doc/ru && make htmlhelp
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
190
	cd doc/ja && make htmlhelp
4634.39.15 by Ian Clatworthy
Simplify Makefile
191
	cd doc/developers && make htmlhelp
2054.2.14 by Aaron Bentley
Add 'pretty-docs' target to makefile
192
2522.3.1 by Robert Collins
Draft proposed integration order for performance changes.
193
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
194
### Documentation Website ###
195
196
# Where to build the website
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
197
DOC_WEBSITE_BUILD = build_doc_website
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
198
199
# Build and package docs into a website, complete with downloads.
4634.39.37 by Ian Clatworthy
Makefile tweaks
200
doc-website: html-sphinx pdf-sphinx
4634.39.21 by Ian Clatworthy
First cut at a smart packaging script for the doc website
201
	$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
202
	$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
203
	$(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)
204
	$(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
205
	$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
206
207
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
208
### Plain Documentation ###
209
210
# While Sphinx is the preferred tool for building documentation, we still
211
# support our "plain" html documentation so that Sphinx is not a hard
212
# dependency for packagers on older platforms.
213
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
214
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
215
216
# translate txt docs to html
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
217
derived_txt_files = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
218
	doc/en/release-notes/NEWS.txt
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
219
txt_all = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
220
	doc/en/tutorials/tutorial.txt \
221
	doc/en/tutorials/using_bazaar_with_launchpad.txt \
222
	doc/en/tutorials/centralized_workflow.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
223
        $(wildcard doc/es/tutorials/*.txt) \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
224
		$(wildcard doc/ru/tutorials/*.txt) \
225
	doc/ja/tutorials/tutorial.txt \
226
	doc/ja/tutorials/using_bazaar_with_launchpad.txt \
227
	doc/ja/tutorials/centralized_workflow.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
228
	$(wildcard doc/*/mini-tutorial/index.txt) \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
229
	$(wildcard doc/*/user-guide/index-plain.txt) \
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
230
	doc/en/admin-guide/index-plain.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
231
	$(wildcard doc/es/guia-usario/*.txt) \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
232
	$(derived_txt_files) \
233
	doc/en/upgrade-guide/index.txt \
234
	doc/index.txt \
235
	$(wildcard doc/index.*.txt)
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
236
txt_nohtml = \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
237
	doc/en/user-guide/index.txt \
238
	doc/es/user-guide/index.txt \
4634.99.3 by Naoki INADA
Update Makefile to make japanese docs.
239
	doc/ja/user-guide/index.txt \
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
240
	doc/ru/user-guide/index.txt \
241
	doc/en/admin-guide/index.txt
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
242
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
243
htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
244
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
245
non_txt_files = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
246
       doc/default.css \
247
       $(wildcard doc/*/bzr-en-quick-reference.svg) \
248
       $(wildcard doc/*/bzr-en-quick-reference.png) \
249
       $(wildcard doc/*/bzr-en-quick-reference.pdf) \
250
       $(wildcard doc/*/bzr-es-quick-reference.svg) \
251
       $(wildcard doc/*/bzr-es-quick-reference.png) \
252
       $(wildcard doc/*/bzr-es-quick-reference.pdf) \
253
       $(wildcard doc/*/bzr-ru-quick-reference.svg) \
254
       $(wildcard doc/*/bzr-ru-quick-reference.png) \
255
       $(wildcard doc/*/bzr-ru-quick-reference.pdf) \
256
       $(wildcard doc/*/user-guide/images/*.png)
257
258
# doc/developers/*.txt files that should *not* be individually
259
# converted to HTML
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
260
dev_txt_nohtml = \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
261
	doc/developers/add.txt \
262
	doc/developers/annotate.txt \
263
	doc/developers/bundle-creation.txt \
264
	doc/developers/commit.txt \
265
	doc/developers/diff.txt \
266
	doc/developers/directory-fingerprints.txt \
267
	doc/developers/gc.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
268
	doc/developers/implementation-notes.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
269
	doc/developers/incremental-push-pull.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
270
	doc/developers/index.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
271
	doc/developers/initial-push-pull.txt \
272
	doc/developers/merge-scaling.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
273
	doc/developers/miscellaneous-notes.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
274
	doc/developers/missing.txt \
275
	doc/developers/performance-roadmap-rationale.txt \
276
	doc/developers/performance-use-case-analysis.txt \
277
	doc/developers/planned-change-integration.txt \
278
	doc/developers/planned-performance-changes.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
279
	doc/developers/plans.txt \
280
	doc/developers/process.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
281
	doc/developers/revert.txt \
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
282
	doc/developers/specifications.txt \
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
283
	doc/developers/status.txt \
284
	doc/developers/uncommit.txt
285
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
286
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
287
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
288
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
289
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
290
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
291
	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
292
4634.39.36 by Ian Clatworthy
Get plain-style documentation generation working again
293
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide)) 
294
#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
295
#
296
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide)) 
297
#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
298
#
4871.1.1 by Neil Martinsen-Burrell
Put in place a structure for the admin-guide
299
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide)) 
300
	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
301
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
302
doc/developers/%.html: doc/developers/%.txt
303
	$(rst2html) --stylesheet=../default.css $< $@
304
305
doc/index.html: doc/index.txt
306
	$(rst2html) --stylesheet=default.css $< $@
307
308
doc/index.%.html: doc/index.%.txt
309
	$(rst2html) --stylesheet=default.css $< $@
310
311
%.html: %.txt
5498.1.2 by Martin Pool
Superstitious argument quoting in makefile
312
	$(rst2html) --stylesheet=../../default.css $< "$@"
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
313
5462.5.3 by Andrew Bennetts
Keep docs-plain working.
314
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
5498.1.2 by Martin Pool
Superstitious argument quoting in makefile
315
	$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
316
317
upgrade_guide_dependencies =  $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide)) 
318
319
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
320
	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
321
322
derived_web_docs = $(htm_files) $(dev_htm_files) 
323
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
324
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
325
326
# the main target to build all the docs
327
docs-plain: $(ALL_DOCS)
328
329
# 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
330
HTMLDIR = html_docs
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
331
html-plain: docs-plain
332
	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
333
334
# clean produced docs
335
clean-plain:
336
	$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
337
	    $(HTMLDIR) $(derived_txt_files)
338
339
340
### Miscellaneous Documentation Targets ###
341
342
# build a png of our performance task list
343
# this is no longer built by default; you can build it if you want to look at it
344
doc/developers/performance.png: doc/developers/performance.dot
345
	@echo Generating $@
346
	@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
347
348
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
349
### Windows Support ###
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
350
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
351
# make all the installers completely from scratch, using zc.buildout
352
# to fetch the dependencies
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
353
# These are files that need to be copied into the build location to boostrap
354
# the build process.
355
# Note that the path is relative to tools/win32
4634.83.1 by Bernhard Voelker
Change Makefile to avoid a GNUism
356
BUILDOUT_FILES = buildout.cfg \
4580.5.5 by John Arbash Meinel
We need ostools.py as well
357
	buildout-templates/bin/build-installer.bat.in \
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
358
	ostools.py bootstrap.py
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
359
4392.3.20 by Sidnei da Silva
- Add top-level make target to build all installers using buildout and another to cleanup
360
installer-all:
4580.5.4 by John Arbash Meinel
Something about *** makes it print out all the files in the current dir.
361
	@echo Make all the installers from scratch
362
	@# 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.
363
	$(PYTHON) tools/win32/ostools.py makedir build-win32
364
	@# 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
365
	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.
366
	@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
367
	@# existing release directories, so delete them manually before building
368
	@# It means things may be rebuilt that don't need to be, but at least
369
	@# it will be correct when they do.
370
	cd build-win32 && $(PYTHON) ostools.py remove release */release
371
	cd build-win32 && $(PYTHON) bootstrap.py
4580.5.3 by John Arbash Meinel
Change the Makefile to stage things into a build directory
372
	cd build-win32 && bin/buildout
373
	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
374
375
376
clean-installer-all:
4580.5.14 by John Arbash Meinel
more updates to get things to build cleanly.
377
	$(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
378
1928.2.1 by Alexander Belchenko
New target to produce html docs to upload on server
379
# make bzr.exe for win32 with py2exe
380
exe:
381
	@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.
382
	$(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
383
	$(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
384
	$(PYTHON) setup.py py2exe > py2exe.log
385
	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
386
	$(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
387
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
388
# win32 installer for bzr.exe
1982.2.1 by Alexander Belchenko
small but important fix for 'make installer' dependencies
389
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
390
	@echo *** Make Windows installer
3557.1.3 by John Arbash Meinel
trivial tweak of Makefile to use the PYTHON variable
391
	$(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
392
	iscc /Q tools/win32/bzr.iss
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
393
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
394
# win32 Python's distutils-based installer
395
# require to have Python interpreter installed on win32
2946.2.1 by Alexander Belchenko
windows python-based installer: shortcut for uninstall action
396
py-inst-24: docs
4392.3.18 by Sidnei da Silva
- Make python-installer too
397
	$(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
398
399
py-inst-25: docs
4392.3.18 by Sidnei da Silva
- Make python-installer too
400
	$(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
401
4459.1.1 by John Arbash Meinel
Include python-2.6 as a build target for standalone builds.
402
py-inst-26: docs
4580.5.1 by John Arbash Meinel
Try to update the buildout rules for the newest versions of everything.
403
	$(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.
404
405
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
406
407
2691.1.15 by Ian Clatworthy
reorganise Makefile into logical sections
408
copy-docs: docs
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
409
	$(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
410
	$(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
411
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
412
# clean on win32 all installer-related files and directories
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
413
clean-win32: clean-docs
2934.2.1 by Ian Clatworthy
generates hooks.html correctly and generalise python command in Makefile
414
	$(PYTHON) tools/win32/ostools.py remove build
415
	$(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
416
	$(PYTHON) tools/win32/ostools.py remove py2exe.log
417
	$(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
418
	$(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
419
	$(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
420
	$(PYTHON) tools/win32/ostools.py remove dist
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
421
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
422
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
423
# i18n targets
424
425
.PHONY: update-pot po/bzr.pot
426
update-pot: po/bzr.pot
427
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
428
TRANSLATABLE_PYFILES:=$(shell find bzrlib -name '*.py' \
429
    		| grep -v 'bzrlib/tests/' \
5830.2.7 by INADA Naoki
Don't exclude bzr.util for translation target.
430
    		| grep -v 'bzrlib/doc' \
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
431
		)
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
432
433
po/bzr.pot: $(PYFILES) $(DOCFILES)
5830.2.12 by INADA Naoki
Make "export-pot" hidden command.
434
	$(PYTHON) ./bzr export-pot > po/bzr.pot
5830.2.6 by INADA Naoki
Add target of bzrgettext.py
435
	echo $(TRANSLATABLE_PYFILES) | xargs \
5830.2.10 by INADA Naoki
Change package name of pot from Bazaar to bzr
436
	  xgettext --package-name "bzr" \
5830.2.1 by INADA Naoki
Add update-pot command to Makefile and tools/bzrgettext script that
437
	  --msgid-bugs-address "<bazaar@canonical.com>" \
438
	  --copyright-holder "Canonical" \
439
	  --from-code ISO-8859-1 --join --sort-by-file --add-comments=i18n: \
440
	  -d bzr -p po -o bzr.pot
441
442
4634.39.35 by Ian Clatworthy
put rules back in Makefile supporting plain-style docs
443
### Packaging Targets ###
444
4988.4.1 by Martin Pool
Delete obsolete makefile targets about escudero
445
.PHONY: dist check-dist-tarball
3346.2.3 by Martin Pool
Add dist-upload-escudero target
446
4676.7.1 by Martin Pool
Stop building a source zip; it's not very useful
447
# build a distribution source tarball
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
448
#
449
# this method of copying the pyrex generated files is a bit ugly; it would be
450
# nicer to generate it from distutils.
451
dist: 
452
	version=`./bzr version --short` && \
453
	echo Building distribution of bzr $$version && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
454
	expbasedir=`mktemp -t -d tmp_bzr_dist.XXXXXXXXXX` && \
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
455
	expdir=$$expbasedir/bzr-$$version && \
456
	tarball=$$PWD/../bzr-$$version.tar.gz && \
457
	$(MAKE) clean && \
458
	$(MAKE) && \
459
	bzr export $$expdir && \
4736.2.1 by John Arbash Meinel
Start adding the .h files to the release tarballs as well.
460
	cp bzrlib/*.c bzrlib/*.h $$expdir/bzrlib/. && \
3346.2.2 by Martin Pool
Add a simple 'make dist' rule
461
	tar cfz $$tarball -C $$expbasedir bzr-$$version && \
462
	gpg --detach-sign $$tarball && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
463
	rm -rf $$expbasedir
3346.2.3 by Martin Pool
Add dist-upload-escudero target
464
3346.2.5 by Martin Pool
Add check-dist-tarball to run tests from the packaged source
465
# run all tests in a previously built tarball
466
check-dist-tarball:
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
467
	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
468
	version=`./bzr version --short` && \
469
	tarball=$$PWD/../bzr-$$version.tar.gz && \
470
	tar Cxz $$tmpdir -f $$tarball && \
3421.2.1 by John Arbash Meinel
Update make targets for distribution.
471
	$(MAKE) -C $$tmpdir/bzr-$$version check && \
472
	rm -rf $$tmpdir