← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

Merge from bzr.dev, resolving conflicts.

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)
 
1
all:
 
2
 
 
3
check:
 
4
        python -Werror ./bzr selftest -v $(tests)
33
5
        @echo "Running all tests with no locale."
34
 
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -1v $(tests) 2>&1 | sed -e 's/^/[ascii] /'
 
6
        LC_CTYPE= LANG=C LC_ALL= ./bzr selftest -v $(tests)
 
7
        python -O -Werror ./bzr selftest -v $(tests)
35
8
 
36
9
check-msgeditor:
37
10
        ./bzr --no-plugins selftest -v msgeditor
46
19
        pyflakes bzrlib | grep -v ' imported but unused'
47
20
 
48
21
clean:
49
 
        python setup.py clean
 
22
        ./setup.py clean
50
23
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
51
24
        rm -rf test????.tmp
52
25
 
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)
 
26
.PHONY: all
 
27
 
60
28
 
61
29
# build emacs cross-reference
62
30
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
64
32
        ctags-exuberant -e $(tag_files)
65
33
 
66
34
 
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
 
35
# Produce HTML docs to upload on Canonical server
 
36
HTMLDIR := html_docs
 
37
PRETTYDIR := pretty_docs
 
38
 
 
39
html-docs: docs
 
40
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
 
41
 
75
42
 
76
43
# 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 \
 
44
doc_dir := doc 
 
45
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
 
46
htm_files := $(patsubst %.txt, %.htm, $(txt_files)) 
 
47
 
 
48
pretty-html-docs: pretty_files
 
49
 
 
50
pretty_docs:
 
51
        python -c "import os; os.mkdir('$(PRETTYDIR)')"
 
52
 
 
53
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
 
54
 
 
55
doc/%.htm: doc/%.txt
 
56
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css doc/$*.txt doc/$*.htm
 
57
 
 
58
$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
 
59
        python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
 
60
        $(PRETTYDIR)/$*.htm
 
61
 
 
62
doc/bzr_man.txt: bzrlib/builtins.py \
102
63
                 bzrlib/bundle/commands.py \
103
64
                 bzrlib/conflicts.py \
104
65
                 bzrlib/sign_my_commits.py \
105
66
                 generate_docs.py \
106
67
                 tools/doc_generate/__init__.py \
107
 
                 tools/doc_generate/autodoc_man.py \
108
68
                 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)
 
69
        python generate_docs.py -o doc/bzr_man.txt rstx
 
70
 
 
71
docs: $(htm_files)
 
72
 
 
73
copy-docs: docs
 
74
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css NEWS README  win32_bzr.exe/doc
139
75
 
140
76
# clean produced docs
141
77
clean-docs:
142
 
        python tools/win32/ostools.py remove $(ALL_DOCS) \
143
 
        $(HTMLDIR) $(derived_txt_files)
144
 
 
145
 
 
146
 
### Windows Support ###
 
78
        python tools/win32/ostools.py remove doc/bzr_man.txt $(htm_files) \
 
79
        $(HTMLDIR) $(PRETTYDIR)
 
80
 
147
81
 
148
82
# make bzr.exe for win32 with py2exe
149
83
exe:
150
84
        @echo *** Make bzr.exe
151
 
        python setup.py build_ext -i -f
152
85
        python setup.py py2exe > py2exe.log
153
86
        python tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe
154
87
        python tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_bzr.exe
162
95
# win32 python's distutils-based installer
163
96
# require to have python interpreter installed on win32
164
97
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 .
 
98
        python setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
167
99
 
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
100
 
172
101
# clean on win32 all installer-related files and directories
173
 
clean-win32: clean-docs
 
102
clean-win32:
174
103
        python tools/win32/ostools.py remove build
175
104
        python tools/win32/ostools.py remove win32_bzr.exe
176
105
        python tools/win32/ostools.py remove py2exe.log
 
106
        python tools/win32/ostools.py remove doc/*.htm
 
107
        python tools/win32/ostools.py remove doc/bzr_man.txt
177
108
        python tools/win32/ostools.py remove tools/win32/bzr.iss
178
109
        python tools/win32/ostools.py remove bzr-setup*.exe
179
110
        python tools/win32/ostools.py remove bzr-*win32.exe