Makefile: Document `full` more accurately
[nit.git] / Makefile
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2008 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 NITCOPT=
18
19 # Additional program directories (contrib and examples) that are buildable
20 PROGS=$(dir $(wildcard examples/*/Makefile contrib/*/Makefile))
21
22 all: tools man
23 @echo ""
24 @echo "Congratulations! Nit was succesfully compiled."
25 @echo "To configure your shell environment, execute the following command:"
26 @echo " source misc/nit_env.sh install"
27
28 # Compile all programs in `contrib`, `examples` and `src`.
29 #
30 # Furthermore, build the toolchain’s `man` pages.
31 full: all
32 for m in $(PROGS); do $(MAKE) -C "$$m" || exit 1; done
33
34 docs: doc/stdlib/index.html doc/nitc/index.html
35
36 tools:
37 cd src; make
38
39 bin/nitdoc:
40 cd src; make ../bin/nitdoc
41
42 bin/nitls:
43 cd src; make ../bin/nitls
44
45 doc/stdlib/index.html: bin/nitdoc bin/nitls
46 @echo '***************************************************************'
47 @echo '* Generate doc for NIT standard library *'
48 @echo '***************************************************************'
49 bin/nitdoc lib -d doc/stdlib \
50 --custom-title "Nit Standard Library" \
51 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
52 --custom-overview-text "<p>Documentation for the standard library of Nit<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
53 --custom-footer-text "Nit standard library. Version $$(git describe)." \
54 --github-upstream "nitlang:nit:master" \
55 --github-base-sha1 "$$(git rev-parse HEAD)" \
56 --github-gitdir "." \
57 --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
58 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
59 --piwik-site-id "2" \
60
61 doc/nitc/index.html: bin/nitdoc bin/nitls
62 bin/nitdoc lib src/nit*.nit src/test_*.nit -d doc/nitc \
63 --private \
64 --custom-title "Nit Compilers and Tools" \
65 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
66 --custom-overview-text "<p>Documentation for the Nit tools<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
67 --custom-footer-text "Nit tools. Version $$(git describe)." \
68 --github-upstream "nitlang:nit:master" \
69 --github-base-sha1 "$$(git rev-parse HEAD)" \
70 --github-gitdir "." \
71 --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
72 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
73 --piwik-site-id "3"
74
75 man:
76 # Setup PATH to find nitc
77 PATH=$$PWD/bin:$$PATH $(MAKE) -C share/man
78
79 clean:
80 rm -rf -- doc/stdlib doc/nitc || true
81 cd c_src; make clean
82 cd src; make clean
83 cd tests; make clean
84 cd share/man; make clean
85 for m in $(PROGS); do \
86 $(MAKE) clean -C "$$m"; \
87 done || true