- print the documentation per default
[platform/upstream/busybox.git] / Makefile.custom
1 # ==========================================================================
2 # Build system
3 # ==========================================================================
4
5 busybox.links: $(srctree)/applets/busybox.mkll $(objtree)/include/autoconf.h $(srctree)/include/applets.h
6         $(Q)-$(SHELL) $^ >$@
7
8 .PHONY: install
9 ifeq ($(CONFIG_INSTALL_APPLET_SYMLINKS),y)
10 INSTALL_OPTS:= --symlinks
11 endif
12 ifeq ($(CONFIG_INSTALL_APPLET_HARDLINKS),y)
13 INSTALL_OPTS:= --hardlinks
14 endif
15 ifeq ($(CONFIG_INSTALL_APPLET_SCRIPT_WRAPPERS),y)
16 ifeq ($(CONFIG_INSTALL_SH_APPLET_SYMLINK),y)
17 INSTALL_OPTS:= --sw-sh-sym
18 endif
19 ifeq ($(CONFIG_INSTALL_SH_APPLET_HARDLINK),y)
20 INSTALL_OPTS:= --sw-sh-hard
21 endif
22 ifeq ($(CONFIG_INSTALL_SH_APPLET_SCRIPT_WRAPPER),y)
23 INSTALL_OPTS:= --scriptwrapper
24 endif
25 endif
26 install: $(srctree)/applets/install.sh busybox busybox.links
27         $(Q)DO_INSTALL_LIBS="$(strip $(LIBBUSYBOX_SONAME) $(DO_INSTALL_LIBS))" \
28                 $(SHELL) $< $(CONFIG_PREFIX) $(INSTALL_OPTS)
29 ifeq ($(strip $(CONFIG_FEATURE_SUID)),y)
30         @echo
31         @echo
32         @echo --------------------------------------------------
33         @echo You will probably need to make your busybox binary
34         @echo setuid root to ensure all configured applets will
35         @echo work properly.
36         @echo --------------------------------------------------
37         @echo
38 endif
39
40 uninstall: busybox.links
41         rm -f $(CONFIG_PREFIX)/bin/busybox
42         for i in `cat busybox.links` ; do rm -f $(CONFIG_PREFIX)$$i; done
43 ifneq ($(strip $(DO_INSTALL_LIBS)),n)
44         for i in $(LIBBUSYBOX_SONAME) $(DO_INSTALL_LIBS); do \
45                 rm -f $(CONFIG_PREFIX)$$i; \
46         done
47 endif
48
49 # Not very elegant: copies testsuite to objdir...
50 # (cp -pPR is POSIX-compliant (cp -dpR or cp -a would not be))
51 .PHONY: check
52 .PHONY: test
53 check test: busybox busybox.links
54         test -d $(objtree)/testsuite || cp -pPR $(srctree)/testsuite $(objtree)
55         bindir=$(objtree) srcdir=$(srctree)/testsuite \
56         $(SHELL) -c "cd $(objtree)/testsuite && $(srctree)/testsuite/runtest $(if $(KBUILD_VERBOSE:0=),-v)"
57
58 .PHONY: release
59 release: distclean
60         cd ..; \
61         rm -r -f busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION); \
62         cp -pPR busybox busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION) && { \
63         find busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION)/ -type d \
64                 -name .svn \
65                 -print \
66                 -exec rm -r -f {} \; ; \
67         find busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION)/ -type f \
68                 -name .\#* \
69                 -print \
70                 -exec rm -f {} \; ; \
71         tar -czf busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION).tar.gz \
72                 busybox-$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION)/ ; }
73
74 .PHONY: checkhelp
75 checkhelp:
76         $(Q)$(srctree)/scripts/checkhelp.awk \
77                 $(patsubst %,$(srctree)/%,$(wildcard $(patsubst %,%/Config.in,$(busybox-dirs) ./)))
78
79 .PHONY: sizes
80 sizes: busybox_unstripped
81         $(NM) --size-sort $(<)
82
83 .PHONY: bloatcheck
84 bloatcheck: busybox_old busybox_unstripped
85         @$(srctree)/scripts/bloat-o-meter busybox_old busybox_unstripped
86         @$(CROSS_COMPILE)size busybox_old busybox_unstripped
87
88 .PHONY: baseline
89 baseline: busybox_unstripped
90         @mv busybox_unstripped busybox_old
91
92 .PHONY: objsizes
93 objsizes: busybox_unstripped
94         $(srctree)/scripts/objsizes
95
96 .PHONY: stksizes
97 stksizes: busybox_unstripped
98         $(CROSS_COMPILE)objdump -d busybox_unstripped | $(srctree)/scripts/checkstack.pl $(ARCH) | uniq
99
100 .PHONY: bigdata
101 bigdata: busybox_unstripped
102         $(CROSS_COMPILE)nm --size-sort busybox_unstripped | grep -vi ' [trw] '
103
104 # Documentation Targets
105 .PHONY: doc
106 doc: docs/busybox.pod docs/BusyBox.txt docs/BusyBox.1 docs/BusyBox.html
107
108 # FIXME: Doesn't belong here
109 disp_doc = \
110   @$(if $(quiet),echo "  DOC     $(@F)")
111
112 docs/busybox.pod: $(srctree)/docs/busybox_header.pod \
113                 $(srctree)/include/usage.h \
114                 $(srctree)/docs/busybox_footer.pod \
115                 $(srctree)/docs/autodocifier.pl
116         $(disp_doc)
117         $(Q)-mkdir -p docs
118         $(Q)-( cat $(srctree)/docs/busybox_header.pod ; \
119             $(srctree)/docs/autodocifier.pl $(srctree)/include/usage.h ; \
120             cat $(srctree)/docs/busybox_footer.pod ; ) > docs/busybox.pod
121
122 docs/BusyBox.txt: docs/busybox.pod
123         $(disp_doc)
124         $(Q)-mkdir -p docs
125         $(Q)-pod2text $< > $@
126
127 docs/BusyBox.1: docs/busybox.pod
128         $(disp_doc)
129         $(Q)-mkdir -p docs
130         $(Q)-pod2man --center=BusyBox --release="version $(VERSION)" \
131                 $< > $@
132
133 docs/BusyBox.html: docs/busybox.net/BusyBox.html
134         $(disp_doc)
135         $(Q)-mkdir -p docs
136         $(Q)-rm -f docs/BusyBox.html
137         $(Q)-cp docs/busybox.net/BusyBox.html docs/BusyBox.html
138
139 docs/busybox.net/BusyBox.html: docs/busybox.pod
140         $(Q)-mkdir -p docs/busybox.net
141         $(Q)-pod2html --noindex $< > \
142             docs/busybox.net/BusyBox.html
143         $(Q)-rm -f pod2htm*
144
145 # documentation, cross-reference
146 # Modern distributions already ship synopsis packages (e.g. debian)
147 # If you have an old distribution go to http://synopsis.fresco.org/
148 syn_tgt = $(wildcard $(patsubst %,%/*.c,$(busybox-alldirs)))
149 syn     = $(patsubst %.c, %.syn, $(syn_tgt))
150
151 comma:= ,
152 brace_open:= (
153 brace_close:= )
154
155 SYN_CPPFLAGS := $(strip $(CPPFLAGS) $(EXTRA_CPPFLAGS))
156 SYN_CPPFLAGS := $(subst $(brace_open),\$(brace_open),$(SYN_CPPFLAGS))
157 SYN_CPPFLAGS := $(subst $(brace_close),\$(brace_close),$(SYN_CPPFLAGS))
158 #SYN_CPPFLAGS := $(subst ",\",$(SYN_CPPFLAGS))
159 #")
160 #SYN_CPPFLAGS := [$(patsubst %,'%'$(comma),$(SYN_CPPFLAGS))'']
161
162 %.syn: %.c
163         synopsis -p C -l Comments.SSDFilter,Comments.Previous -Wp,preprocess=True,cppflags="'$(SYN_CPPFLAGS)'" -o $@ $<
164
165 .PHONY: html
166 html: $(syn)
167         synopsis -f HTML -Wf,title="'BusyBox Documentation'" -o $@ $^
168
169 -include $(srctree)/Makefile.local