← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
17
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
18
# building documentation, etc.
19
19
 
 
20
 
 
21
### Core Stuff ###
 
22
 
20
23
.PHONY: all clean extensions pyflakes api-docs
21
24
 
22
25
all: extensions
26
29
        python setup.py build_ext -i
27
30
 
28
31
check: docs extensions
29
 
        python -Werror ./bzr selftest -v $(tests)
 
32
        python -Werror -O ./bzr selftest -1v $(tests)
30
33
        @echo "Running all tests with no locale."
31
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
32
 
        python -O -Werror ./bzr selftest -v $(tests)
 
34
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
33
35
 
34
36
check-msgeditor:
35
37
        ./bzr --no-plugins selftest -v msgeditor
48
50
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
49
51
        rm -rf test????.tmp
50
52
 
 
53
# Build API documentation
51
54
docfiles = bzr bzrlib
52
55
api-docs:
53
56
        mkdir -p api/html
54
57
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
55
 
 
56
58
check-api-docs:
57
59
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
58
60
 
59
 
 
60
61
# build emacs cross-reference
61
62
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
62
63
TAGS: $(tag_files)
63
64
        ctags-exuberant -e $(tag_files)
64
65
 
65
66
 
66
 
# Produce HTML docs to upload on Canonical server
67
 
HTMLDIR := html_docs
68
 
PRETTYDIR := pretty_docs
69
 
 
70
 
html-docs: docs
71
 
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
72
 
 
 
67
### Documentation ###
 
68
 
 
69
# set PRETTY to get docs that look like the Bazaar web site
 
70
ifdef PRETTY
 
71
rst2html := python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
72
else
 
73
rst2html := python tools/rst2html.py --link-stylesheet --footnote-references=superscript 
 
74
endif
73
75
 
74
76
# translate txt docs to html
75
 
doc_dir := doc 
76
 
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
 
77
derived_txt_files := \
 
78
        doc/en/user-reference/bzr_man.txt \
 
79
        doc/en/developer-guide/HACKING.txt \
 
80
        doc/en/release-notes/NEWS.txt
 
81
doc_dir := doc/en/user-guide
 
82
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) $(derived_txt_files) \
 
83
        doc/en/mini-tutorial/index.txt \
 
84
        doc/index.txt
 
85
non_txt_files := \
 
86
       doc/default.css \
 
87
       doc/en/quick-reference/quick-start-summary.svg
77
88
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
78
89
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
79
90
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
80
91
 
81
 
pretty-html-docs: pretty_files
82
 
 
83
 
pretty_docs:
84
 
        python -c "import os; os.mkdir('$(PRETTYDIR)')"
85
 
 
86
 
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.html, $(txt_files))
87
 
 
88
92
doc/developers/%.html: doc/developers/%.txt
89
 
        python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
 
93
        $(rst2html) --stylesheet=../default.css $< $@
 
94
 
 
95
doc/index.html: doc/index.txt
 
96
        $(rst2html) --stylesheet=default.css $< $@
90
97
 
91
98
%.html: %.txt
92
 
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css --footnote-references=superscript $< $@
93
 
 
94
 
$(PRETTYDIR)/%.html: pretty_docs doc/%.txt
95
 
        python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
96
 
        $(PRETTYDIR)/$*.html
 
99
        $(rst2html) --stylesheet=../../default.css $< $@
97
100
 
98
101
MAN_DEPENDENCIES = bzrlib/builtins.py \
99
102
                 bzrlib/bundle/commands.py \
104
107
                 tools/doc_generate/autodoc_man.py \
105
108
                 tools/doc_generate/autodoc_rstx.py
106
109
 
107
 
doc/bzr_man.txt: $(MAN_DEPENDENCIES)
 
110
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
108
111
        python generate_docs.py -o $@ rstx
109
112
 
 
113
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
114
        python tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
115
 
 
116
doc/en/release-notes/NEWS.txt: NEWS
 
117
        python -c "import shutil; shutil.copyfile('$<', '$@')"
 
118
 
110
119
MAN_PAGES = man1/bzr.1
111
120
man1/bzr.1: $(MAN_DEPENDENCIES)
112
121
        python generate_docs.py -o $@ man
113
122
 
114
 
ALL_DOCS = $(htm_files) $(MAN_PAGES) $(dev_htm_files) doc/developers/performance.png
 
123
# build a png of our performance task list
 
124
doc/developers/performance.png: doc/developers/performance.dot
 
125
        @echo Generating $@
 
126
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
127
 
 
128
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
 
129
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
130
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
131
 
 
132
# the main target to build all the docs
115
133
docs: $(ALL_DOCS)
116
134
 
117
 
copy-docs: docs
118
 
        python tools/win32/ostools.py copytodir $(htm_files) \
119
 
                doc/default.css NEWS README \
120
 
                win32_bzr.exe/doc
121
 
        python tools/win32/ostools.py copytodir $(dev_htm_files) \
122
 
                win32_bzr.exe/doc/developers
 
135
# produce a tree containing just the final docs, ready for uploading to the web
 
136
HTMLDIR := html_docs
 
137
html-docs: docs
 
138
        python tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
123
139
 
124
140
# clean produced docs
125
141
clean-docs:
126
142
        python tools/win32/ostools.py remove $(ALL_DOCS) \
127
 
        $(HTMLDIR) $(PRETTYDIR) doc/bzr_man.txt
128
 
 
129
 
 
130
 
# build a png of our performance task list
131
 
doc/developers/performance.png: doc/developers/performance.dot
132
 
        @echo Generating $@
133
 
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
134
 
 
 
143
        $(HTMLDIR) $(derived_txt_files)
 
144
 
 
145
 
 
146
### Windows Support ###
135
147
 
136
148
# make bzr.exe for win32 with py2exe
137
149
exe:
153
165
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
154
166
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
155
167
 
 
168
copy-docs: docs
 
169
        python tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
170
        python tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
156
171
 
157
172
# clean on win32 all installer-related files and directories
158
173
clean-win32: clean-docs
159
174
        python tools/win32/ostools.py remove build
160
175
        python tools/win32/ostools.py remove win32_bzr.exe
161
176
        python tools/win32/ostools.py remove py2exe.log
162
 
        python tools/win32/ostools.py remove doc/bzr_man.txt
163
177
        python tools/win32/ostools.py remove tools/win32/bzr.iss
164
178
        python tools/win32/ostools.py remove bzr-setup*.exe
165
179
        python tools/win32/ostools.py remove bzr-*win32.exe