← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Martin Pool
  • Date: 2007-09-19 13:12:32 UTC
  • mto: (2592.3.153 repository)
  • mto: This revision was merged to the branch mainline in revision 2933.
  • Revision ID: mbp@sourcefrog.net-20070919131232-0gtp1q90fxz10ctn
move commit_write_group to RepositoryPackCollection

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
 
1
# Copyright (C) 2005, 2006, 2007 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
.PHONY: all clean extensions pyflakes api-docs
 
24
 
 
25
all: extensions
 
26
 
 
27
extensions:
 
28
        @echo "building extension modules."
 
29
        python setup.py build_ext -i
 
30
 
 
31
check: docs extensions
 
32
        python -Werror -O ./bzr selftest -1v $(tests)
 
33
        @echo "Running all tests with no locale."
 
34
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
 
35
 
 
36
check-msgeditor:
 
37
        ./bzr --no-plugins selftest -v msgeditor
 
38
 
 
39
# Run Python style checker (apt-get install pyflakes)
 
40
pyflakes:
 
41
        pyflakes bzrlib
 
42
 
 
43
pyflakes-nounused:
 
44
        # There are many of these warnings at the moment and they're not a
 
45
        # high priority to fix
 
46
        pyflakes bzrlib | grep -v ' imported but unused'
 
47
 
 
48
clean:
 
49
        python setup.py clean
 
50
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
 
51
        rm -rf test????.tmp
 
52
 
 
53
# Build API documentation
 
54
docfiles = bzr bzrlib
 
55
api-docs:
 
56
        mkdir -p api/html
 
57
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
 
58
check-api-docs:
 
59
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
 
60
 
 
61
# build emacs cross-reference
 
62
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
 
63
TAGS: $(tag_files)
 
64
        ctags-exuberant -e $(tag_files)
 
65
 
 
66
 
 
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
 
75
 
 
76
# translate txt docs to html
 
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
 
88
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
 
89
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
 
90
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
 
91
 
 
92
doc/developers/%.html: doc/developers/%.txt
 
93
        $(rst2html) --stylesheet=../default.css $< $@
 
94
 
 
95
doc/index.html: doc/index.txt
 
96
        $(rst2html) --stylesheet=default.css $< $@
 
97
 
 
98
%.html: %.txt
 
99
        $(rst2html) --stylesheet=../../default.css $< $@
 
100
 
 
101
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
102
                 bzrlib/bundle/commands.py \
 
103
                 bzrlib/conflicts.py \
 
104
                 bzrlib/sign_my_commits.py \
 
105
                 generate_docs.py \
 
106
                 tools/doc_generate/__init__.py \
 
107
                 tools/doc_generate/autodoc_man.py \
 
108
                 tools/doc_generate/autodoc_rstx.py
 
109
 
 
110
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
111
        python generate_docs.py -o $@ rstx
 
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
 
 
119
MAN_PAGES = man1/bzr.1
 
120
man1/bzr.1: $(MAN_DEPENDENCIES)
 
121
        python generate_docs.py -o $@ man
 
122
 
 
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
 
133
docs: $(ALL_DOCS)
 
134
 
 
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)
 
139
 
 
140
# clean produced docs
 
141
clean-docs:
 
142
        python tools/win32/ostools.py remove $(ALL_DOCS) \
 
143
        $(HTMLDIR) $(derived_txt_files)
 
144
 
 
145
 
 
146
### Windows Support ###
 
147
 
 
148
# make bzr.exe for win32 with py2exe
 
149
exe:
 
150
        @echo *** Make bzr.exe
 
151
        python setup.py build_ext -i -f
 
152
        python setup.py py2exe > py2exe.log
 
153
        python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
154
        python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
 
155
 
 
156
# win32 installer for bzr.exe
 
157
installer: exe copy-docs
 
158
        @echo *** Make windows installer
 
159
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
 
160
        iscc /Q tools/win32/bzr.iss
 
161
 
 
162
# win32 python's distutils-based installer
 
163
# require to have python interpreter installed on win32
 
164
python-installer: docs
 
165
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
166
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
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
 
171
 
 
172
# clean on win32 all installer-related files and directories
 
173
clean-win32: clean-docs
 
174
        python tools/win32/ostools.py remove build
 
175
        python tools/win32/ostools.py remove win32_bzr.exe
 
176
        python tools/win32/ostools.py remove py2exe.log
 
177
        python tools/win32/ostools.py remove tools/win32/bzr.iss
 
178
        python tools/win32/ostools.py remove bzr-setup*.exe
 
179
        python tools/win32/ostools.py remove bzr-*win32.exe
 
180
        python tools/win32/ostools.py remove dist