← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Patrick Regan
  • Date: 2009-12-02 20:34:07 UTC
  • mto: (4852.3.3 2.1.0b4-doc-updates)
  • mto: This revision was merged to the branch mainline in revision 4856.
  • Revision ID: patrick.rubbs.regan@gmail.com-20091202203407-fjd0mshgn3j3foel
Removed trailing whitespace from files in doc directory

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