← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

move reference material out of User Guide into User Reference

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
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)
 
35
        @echo "Running all tests with no locale."
 
36
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
 
37
 
 
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.
 
42
pyflakes:
 
43
        pyflakes bzrlib
 
44
 
 
45
pyflakes-nounused:
 
46
        # There are many of these warnings at the moment and they're not a
 
47
        # high priority to fix
 
48
        pyflakes bzrlib | grep -v ' imported but unused'
 
49
 
 
50
clean:
 
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 
 
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/en/user-reference/hooks.txt \
 
91
        doc/index.txt
 
92
non_txt_files := \
 
93
       doc/default.css \
 
94
       doc/en/quick-reference/quick-start-summary.svg \
 
95
       doc/en/quick-reference/quick-start-summary.png \
 
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/developers/%.html: doc/developers/%.txt
 
102
        $(rst2html) --stylesheet=../default.css $< $@
 
103
 
 
104
doc/index.html: doc/index.txt
 
105
        $(rst2html) --stylesheet=default.css $< $@
 
106
 
 
107
%.html: %.txt
 
108
        $(rst2html) --stylesheet=../../default.css $< $@
 
109
 
 
110
USER_GUIDE_DEPENDENCIES = $(wildcard $(addsuffix /*.txt, doc/en/user-guide)) 
 
111
 
 
112
MAN_DEPENDENCIES = bzrlib/builtins.py \
 
113
                 bzrlib/bundle/commands.py \
 
114
                 bzrlib/conflicts.py \
 
115
                 bzrlib/sign_my_commits.py \
 
116
                 generate_docs.py \
 
117
                 tools/doc_generate/__init__.py \
 
118
                 tools/doc_generate/autodoc_man.py \
 
119
                 tools/doc_generate/autodoc_rstx.py
 
120
 
 
121
doc/en/user-guide/index.txt: $(USER_GUIDE_DEPENDENCIES)
 
122
 
 
123
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
 
124
        $(PYTHON) generate_docs.py -o $@ rstx
 
125
 
 
126
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
127
        $(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
128
 
 
129
doc/en/release-notes/NEWS.txt: NEWS
 
130
        $(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
 
131
 
 
132
MAN_PAGES = man1/bzr.1
 
133
man1/bzr.1: $(MAN_DEPENDENCIES)
 
134
        $(PYTHON) generate_docs.py -o $@ man
 
135
 
 
136
# build a png of our performance task list
 
137
doc/developers/performance.png: doc/developers/performance.dot
 
138
        @echo Generating $@
 
139
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
140
 
 
141
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
 
142
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
143
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
144
 
 
145
# the main target to build all the docs
 
146
docs: $(ALL_DOCS)
 
147
 
 
148
# produce a tree containing just the final docs, ready for uploading to the web
 
149
HTMLDIR := html_docs
 
150
html-docs: docs
 
151
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
 
152
 
 
153
# clean produced docs
 
154
clean-docs:
 
155
        $(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
 
156
        $(HTMLDIR) $(derived_txt_files)
 
157
 
 
158
 
 
159
### Windows Support ###
 
160
 
 
161
# make bzr.exe for win32 with py2exe
 
162
exe:
 
163
        @echo *** Make bzr.exe
 
164
        $(PYTHON) setup.py build_ext -i -f
 
165
        $(PYTHON) setup.py py2exe > py2exe.log
 
166
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
 
167
        $(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
 
168
 
 
169
# win32 installer for bzr.exe
 
170
installer: exe copy-docs
 
171
        @echo *** Make windows installer
 
172
        cog.py -d -o tools/win32/bzr.iss tools/win32/bzr.iss.cog
 
173
        iscc /Q tools/win32/bzr.iss
 
174
 
 
175
# win32 Python's distutils-based installer
 
176
# require to have Python interpreter installed on win32
 
177
py-inst-24: docs
 
178
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
179
 
 
180
py-inst-25: docs
 
181
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
 
182
 
 
183
python-installer: py-inst-24 py-inst-25
 
184
 
 
185
 
 
186
copy-docs: docs
 
187
        $(PYTHON) tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
188
        $(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
 
189
 
 
190
# clean on win32 all installer-related files and directories
 
191
clean-win32: clean-docs
 
192
        $(PYTHON) tools/win32/ostools.py remove build
 
193
        $(PYTHON) tools/win32/ostools.py remove win32_bzr.exe
 
194
        $(PYTHON) tools/win32/ostools.py remove py2exe.log
 
195
        $(PYTHON) tools/win32/ostools.py remove tools/win32/bzr.iss
 
196
        $(PYTHON) tools/win32/ostools.py remove bzr-setup*.exe
 
197
        $(PYTHON) tools/win32/ostools.py remove bzr-*win32.exe
 
198
        $(PYTHON) tools/win32/ostools.py remove dist