← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Martin Pool
  • Date: 2008-04-09 03:29:23 UTC
  • mto: (3360.2.3 prepare-1.4)
  • mto: This revision was merged to the branch mainline in revision 3385.
  • Revision ID: mbp@sourcefrog.net-20080409032923-uh6hxeubehsb9zm0
Update developer documentation for new makefile dist targets

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
1
 
all:
2
 
 
3
 
check:
4
 
        ./bzr selftest -v $(tests)
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
 
18
# building documentation, etc.
 
19
 
 
20
 
 
21
### Core Stuff ###
 
22
 
 
23
PYTHON=python
 
24
 
 
25
.PHONY: all clean extensions pyflakes api-docs 
 
26
 
 
27
all: extensions
 
28
 
 
29
extensions:
 
30
        @echo "building extension modules."
 
31
        $(PYTHON) setup.py build_ext -i
 
32
 
 
33
check: docs extensions
 
34
        $(PYTHON) -Werror -O ./bzr selftest -1v $(tests)
5
35
        @echo "Running all tests with no locale."
6
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
7
 
 
8
 
check-msgeditor:
9
 
        ./bzr --no-plugins selftest -v msgeditor
 
36
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
10
37
 
11
38
# Run Python style checker (apt-get install pyflakes)
 
39
#
 
40
# Note that at present this gives many false warnings, because it doesn't
 
41
# know about identifiers loaded through lazy_import.
12
42
pyflakes:
13
43
        pyflakes bzrlib
14
44
 
18
48
        pyflakes bzrlib | grep -v ' imported but unused'
19
49
 
20
50
clean:
21
 
        ./setup.py clean
22
 
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
23
 
        rm -rf test????.tmp
24
 
 
25
 
.PHONY: all
26
 
 
27
 
 
28
 
# build emacs cross-reference
29
 
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
30
 
TAGS: $(tag_files)
31
 
        ctags-exuberant -e $(tag_files)
32
 
 
 
51
        $(PYTHON) setup.py clean
 
52
        -find . -name "*.pyc" -o -name "*.pyo" -o -name "*.so" | xargs rm -f
 
53
 
 
54
# Build API documentation
 
55
docfiles = bzr bzrlib
 
56
api-docs:
 
57
        mkdir -p api/html
 
58
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
59
check-api-docs:
 
60
        PYTHONPATH=$(PWD) $(PYTHON) tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
 
61
 
 
62
# build tags for emacs and vim
 
63
TAGS:
 
64
        ctags -R -e bzrlib
 
65
 
 
66
tags:
 
67
        ctags -R bzrlib
 
68
 
 
69
# these are treated as phony so they'll always be rebuilt - it's pretty quick
 
70
.PHONY: TAGS tags
 
71
 
 
72
### Documentation ###
 
73
 
 
74
# set PRETTY to get docs that look like the Bazaar web site
 
75
ifdef PRETTY
 
76
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
77
else
 
78
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
 
79
endif
 
80
 
 
81
# translate txt docs to html
 
82
derived_txt_files := \
 
83
        doc/en/user-reference/bzr_man.txt \
 
84
        doc/en/developer-guide/HACKING.txt \
 
85
        doc/en/release-notes/NEWS.txt
 
86
doc_dir := doc/en/tutorials
 
87
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) $(derived_txt_files) \
 
88
        doc/en/user-guide/index.txt \
 
89
        doc/en/mini-tutorial/index.txt \
 
90
        doc/index.txt
 
91
non_txt_files := \
 
92
       doc/default.css \
 
93
       doc/en/quick-reference/quick-start-summary.svg \
 
94
       doc/en/quick-reference/quick-start-summary.png \
 
95
       doc/en/quick-reference/quick-start-summary.pdf \
 
96
       $(wildcard doc/en/user-guide/images/*.png)
 
97
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
 
98
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
 
99
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
100
 
 
101
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
 
102
        $(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
 
103
 
 
104
doc/developers/%.html: doc/developers/%.txt
 
105
        $(rst2html) --stylesheet=../default.css $< $@
 
106
 
 
107
doc/index.html: doc/index.txt
 
108
        $(rst2html) --stylesheet=default.css $< $@
 
109
 
 
110
%.html: %.txt
 
111
        $(rst2html) --stylesheet=../../default.css $< $@
 
112
 
 
113
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
114
                 bzrlib/bundle/commands.py \
 
115
                 bzrlib/conflicts.py \
 
116
                 bzrlib/help_topics/__init__.py \
 
117
                 bzrlib/sign_my_commits.py \
 
118
                 bzrlib/bugtracker.py \
 
119
                 generate_docs.py \
 
120
                 tools/doc_generate/__init__.py \
 
121
                 tools/doc_generate/autodoc_man.py \
 
122
                 tools/doc_generate/autodoc_rstx.py \
 
123
                 $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en)) 
 
124
 
 
125
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
126
        $(PYTHON) generate_docs.py -o $@ rstx
 
127
 
 
128
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
129
        $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
130
 
 
131
doc/en/release-notes/NEWS.txt: NEWS
 
132
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
133
 
 
134
MAN_PAGES = man1/bzr.1
 
135
man1/bzr.1: $(MAN_DEPENDENCIES)
 
136
        $(PYTHON) generate_docs.py -o $@ man
 
137
 
 
138
# build a png of our performance task list
 
139
doc/developers/performance.png: doc/developers/performance.dot
 
140
        @echo Generating $@
 
141
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
142
 
 
143
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
 
144
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
145
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
146
 
 
147
# the main target to build all the docs
 
148
docs: $(ALL_DOCS)
 
149
 
 
150
# produce a tree containing just the final docs, ready for uploading to the web
 
151
HTMLDIR := html_docs
 
152
html-docs: docs
 
153
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
 
154
 
 
155
# clean produced docs
 
156
clean-docs:
 
157
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
 
158
        $(HTMLDIR) $(derived_txt_files)
 
159
 
 
160
 
 
161
### Windows Support ###
33
162
 
34
163
# make bzr.exe for win32 with py2exe
35
164
exe:
36
165
        @echo *** Make bzr.exe
37
 
        python setup.py py2exe > py2exe.log
38
 
        python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
39
 
        python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
40
 
 
41
 
# translate txt docs to html
42
 
doc_dir := doc 
43
 
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir)))
44
 
htm_files := $(patsubst %.txt, %.htm, $(txt_files)) doc/bzr_man.htm
45
 
 
46
 
%.htm: %.txt
47
 
        rst2html.py --link-stylesheet --stylesheet=default.css $*.txt $*.htm
48
 
 
49
 
doc/bzr_man.txt:
50
 
        generate_docs.py -o doc/bzr_man.txt rstx
51
 
 
52
 
docs: $(htm_files)
53
 
 
54
 
copy_docs: docs
55
 
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css NEWS README  win32_bzr.exe/doc
 
166
        $(PYTHON) setup.py build_ext -i -f
 
167
        $(PYTHON) setup.py py2exe > py2exe.log
 
168
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
169
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
56
170
 
57
171
# win32 installer for bzr.exe
58
 
installer: exe copy_docs
 
172
installer: exe copy-docs
59
173
        @echo *** Make windows installer
60
174
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
61
175
        iscc /Q tools/win32/bzr.iss
62
176
 
63
 
# win32 python's distutils-based installer
64
 
# require to have python interpreter installed on win32
65
 
python-installer: docs
66
 
        python setup.py bdist_wininst --title="Bazaar" --install-script="bzr-win32-bdist-postinstall.py"
67
 
 
 
177
# win32 Python's distutils-based installer
 
178
# require to have Python interpreter installed on win32
 
179
py-inst-24: docs
 
180
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
181
 
 
182
py-inst-25: docs
 
183
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
184
 
 
185
python-installer: py-inst-24 py-inst-25
 
186
 
 
187
 
 
188
copy-docs: docs
 
189
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
190
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
68
191
 
69
192
# clean on win32 all installer-related files and directories
70
 
clean_win32:
71
 
        python tools/win32/ostools.py remove build
72
 
        python tools/win32/ostools.py remove win32_bzr.exe
73
 
        python tools/win32/ostools.py remove py2exe.log
74
 
        python tools/win32/ostools.py remove doc/*.htm
75
 
        python tools/win32/ostools.py remove doc/bzr_man.txt
76
 
        python tools/win32/ostools.py remove tools/win32/bzr.iss
77
 
        python tools/win32/ostools.py remove bzr-setup*.exe
78
 
        python tools/win32/ostools.py remove dist
 
193
clean-win32: clean-docs
 
194
        $(PYTHON) tools/win32/ostools.py remove build
 
195
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
 
196
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
 
197
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
 
198
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
 
199
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
 
200
        $(PYTHON) tools/win32/ostools.py remove dist
 
201
 
 
202
.PHONY: dist dist-upload-escudero
 
203
 
 
204
# build a distribution tarball.
 
205
#
 
206
# this method of copying the pyrex generated files is a bit ugly; it would be
 
207
# nicer to generate it from distutils.
 
208
dist: 
 
209
        version=`./bzr version --short` && \
 
210
        echo Building distribution of bzr $$version && \
 
211
        expbasedir=`mktemp -d` && \
 
212
        expdir=$$expbasedir/bzr-$$version && \
 
213
        tarball=$$PWD/../bzr-$$version.tar.gz && \
 
214
        $(MAKE) clean && \
 
215
        $(MAKE) && \
 
216
        bzr export $$expdir && \
 
217
        cp bzrlib/*.c $$expdir/bzrlib/. && \
 
218
        tar cfz $$tarball -C $$expbasedir bzr-$$version && \
 
219
        gpg --detach-sign $$tarball && \
 
220
        echo $$tarball done.
 
221
 
 
222
# upload previously built tarball to the download directory on bazaar-vcs.org,
 
223
# and verify that it can be downloaded ok.
 
224
dist-upload-escudero:
 
225
        version=`./bzr version --short` && \
 
226
        tarball=../bzr-$$version.tar.gz && \
 
227
        scp $$tarball $$tarball.sig \
 
228
            escudero.ubuntu.com:/srv/bazaar.canonical.com/www/releases/src \
 
229
                && \
 
230
        echo verifying over http... && \
 
231
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz \
 
232
                | diff -s - $$tarball && \
 
233
        curl http://bazaar-vcs.org/releases/src/bzr-$$version.tar.gz.sig \
 
234
                | diff -s - $$tarball.sig