blob: 7390f982b2d7d0a5dbc1d70702f9255b838fa4fc [file] [log] [blame]
Harald Welte4cd3d8a2010-03-23 00:30:19 +08001ACLOCAL_AMFLAGS = -I m4
Harald Welte3cae0392010-02-20 21:09:24 +01002
Harald Welted54c2ee2012-01-17 18:25:50 +01003AM_CPPFLAGS = $(all_includes) -I$(top_srcdir)/include
Harald Welteda432cd2019-12-15 19:13:26 +01004SUBDIRS = include src src/vty src/codec src/gsm src/coding src/gb src/ctrl src/sim src/pseudotalloc src/usb utils tests
Harald Welte3cae0392010-02-20 21:09:24 +01005
6pkgconfigdir = $(libdir)/pkgconfig
Harald Welte641f7ce2012-06-17 23:05:26 +08007pkgconfig_DATA = libosmocore.pc libosmocodec.pc libosmovty.pc libosmogsm.pc \
Harald Welteda432cd2019-12-15 19:13:26 +01008 libosmogb.pc libosmoctrl.pc libosmocoding.pc libosmosim.pc \
9 libosmousb.pc
Harald Welte4cd3d8a2010-03-23 00:30:19 +080010
Vasil Velichkov499510b2019-04-03 02:32:37 +030011aclocaldir = $(datadir)/aclocal
12dist_aclocal_DATA = m4/osmo_ac_code_coverage.m4 \
13 m4/osmo_ax_code_coverage.m4
14
Maxff932bb2017-07-04 18:19:38 +020015@RELMAKE@
Vasil Velichkov499510b2019-04-03 02:32:37 +030016@CODE_COVERAGE_RULES@
Maxff932bb2017-07-04 18:19:38 +020017
18relengdir = $(includedir)
19releng_DATA = osmo-release.mk
20
Harald Welteee497f22017-10-03 16:54:41 +080021dist_bin_SCRIPTS = osmo-release.sh
22
Maxff932bb2017-07-04 18:19:38 +020023osmo-release.mk: git-version-gen
24
Harald Welte4cd3d8a2010-03-23 00:30:19 +080025BUILT_SOURCES = $(top_srcdir)/.version
26$(top_srcdir)/.version:
27 echo $(VERSION) > $@-t && mv $@-t $@
28dist-hook:
29 echo $(VERSION) > $(distdir)/.tarball-version
Holger Hans Peter Freytherec4f1602011-07-17 12:13:31 +020030
Harald Welteee497f22017-10-03 16:54:41 +080031EXTRA_DIST = git-version-gen .version README.md osmo-release.mk osmo-release.sh
Harald Welte21e73c22011-08-17 19:33:06 +020032
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010033HTML = \
34 $(top_builddir)/doc/core/html/index.html \
35 $(top_builddir)/doc/gsm/html/index.html \
36 $(top_builddir)/doc/vty/html/index.html \
37 $(top_builddir)/doc/codec/html/index.html \
38 $(top_builddir)/doc/coding/html/index.html \
39 $(top_builddir)/doc/ctrl/html/index.html \
40 $(top_builddir)/doc/gb/html/index.html
Harald Welte21e73c22011-08-17 19:33:06 +020041
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010042if HAVE_DOXYGEN
Diego Elio Pettenò200710e2012-06-29 13:01:26 -070043html_DATA = $(top_builddir)/doc/html.tar
Harald Welte21e73c22011-08-17 19:33:06 +020044
Neels Hofmeyr249fb712017-06-20 02:52:38 +020045doc: $(html_DATA)
46
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010047$(html_DATA): apidoc
48else
49DOXYGEN=doxygen
50endif
51
52.PHONY: apidoc
53apidoc: $(HTML)
Harald Welte7992af02011-08-17 19:37:26 +020054 cd $(top_builddir)/doc && tar cf html.tar */html
Harald Welte21e73c22011-08-17 19:33:06 +020055
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010056# Support doxygen cross references from each library to each other library:
57# First generate the docs to make sure all .tag files are in place.
58# In a second run, generate the content with proper referencing.
59# For example, libosmocore references tags from libosmovty and vice versa,
60# so both need to generate tag files first, and then do another run.
61#
62# Generate each docs tree, and touch a libosmofoo.tag.prep file when done.
63# It means that a libosmofoo.tag file is up-to-date.
64# Touch a separate "*.prep" target: libosmofoo.tag as target would create
65# circular dependency: we would rebuild all every time 'make' is invoked.
66# The .prep file also depends on all the source files for that library.
67
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010068$(top_builddir)/doc/libosmocore.tag.prep: $(top_builddir)/Doxyfile.core \
69 $(top_srcdir)/include/osmocom/core/*.h \
70 $(top_srcdir)/src/*.[hc] \
71 $(top_srcdir)/src/pseudotalloc/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010072 rm -rf $(top_builddir)/doc/core; mkdir -p $(top_builddir)/doc/core
73 rm -rf $(top_builddir)/doc/libosmocore.map
74 -$(DOXYGEN) $(top_builddir)/Doxyfile.core
75 touch "$@"
76
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010077$(top_builddir)/doc/libosmogsm.tag.prep: $(top_builddir)/Doxyfile.gsm \
78 $(top_srcdir)/include/osmocom/gsm/*.h \
79 $(top_srcdir)/include/osmocom/gsm/protocol/*.h \
80 $(top_srcdir)/include/osmocom/crypt/*.h \
81 $(top_srcdir)/src/gsm/*.c \
82 $(top_srcdir)/src/gsm/milenage/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010083 rm -rf $(top_builddir)/doc/gsm; mkdir -p $(top_builddir)/doc/gsm
84 rm -rf $(top_builddir)/doc/libosmogsm.map
85 -$(DOXYGEN) $(top_builddir)/Doxyfile.gsm
86 touch "$@"
87
Oliver Smith316d1e12019-06-28 09:13:22 +020088# Don't delete the entire doc/vty, it contains example.xml and vtydoc.xsd (OS#3986)
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010089$(top_builddir)/doc/libosmovty.tag.prep: $(top_builddir)/Doxyfile.vty \
90 $(top_srcdir)/include/osmocom/vty/*.h \
91 $(top_srcdir)/src/vty/*.c
Oliver Smith316d1e12019-06-28 09:13:22 +020092 rm -rf $(top_builddir)/doc/vty/html $(top_builddir)/doc/vty/latex
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010093 rm -rf $(top_builddir)/doc/libosmovty.map
94 -$(DOXYGEN) $(top_builddir)/Doxyfile.vty
95 touch "$@"
96
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010097$(top_builddir)/doc/libosmocodec.tag.prep: $(top_builddir)/Doxyfile.codec \
98 $(top_srcdir)/include/osmocom/codec/*.h \
99 $(top_srcdir)/src/codec/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100100 rm -rf $(top_builddir)/doc/codec; mkdir -p $(top_builddir)/doc/codec
101 rm -rf $(top_builddir)/doc/libosmocodec.map
102 -$(DOXYGEN) $(top_builddir)/Doxyfile.codec
103 touch "$@"
104
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100105$(top_builddir)/doc/libosmocoding.tag.prep: $(top_builddir)/Doxyfile.coding \
106 $(top_srcdir)/include/osmocom/coding/*.h \
107 $(top_srcdir)/src/coding/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100108 rm -rf $(top_builddir)/doc/coding; mkdir -p $(top_builddir)/doc/coding
109 rm -rf $(top_builddir)/doc/libosmocoding.map
110 -$(DOXYGEN) $(top_builddir)/Doxyfile.coding
111 touch "$@"
112
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100113$(top_builddir)/doc/libosmoctrl.tag.prep: $(top_builddir)/Doxyfile.ctrl \
114 $(top_srcdir)/include/osmocom/ctrl/*.h \
115 $(top_srcdir)/src/ctrl/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100116 rm -rf $(top_builddir)/doc/ctrl; mkdir -p $(top_builddir)/doc/ctrl
117 rm -rf $(top_builddir)/doc/libosmoctrl.map
118 -$(DOXYGEN) $(top_builddir)/Doxyfile.ctrl
119 touch "$@"
120
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100121$(top_builddir)/doc/libosmogb.tag.prep: $(top_builddir)/Doxyfile.gb \
122 $(top_srcdir)/include/osmocom/gprs/*.h \
123 $(top_srcdir)/src/gb/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100124 rm -rf $(top_builddir)/doc/gb; mkdir -p $(top_builddir)/doc/gb
125 rm -rf $(top_builddir)/doc/libosmogb.map
126 -$(DOXYGEN) $(top_builddir)/Doxyfile.gb
127 touch "$@"
128
129# Build for real once all depending .tag files are in place.
130# Depend on the own .tag.prep file to avoid concurrent builds of the same doc
131# tree, and to also depend on all the source files listed above.
132#
133# Each library should depend on all the tag.prep files of which it lists .tag
134# files in Doxyfile under TAGFILES.
135#
136# In turn, include all .tag files in TAGFILES of libraries to which "\ref"
137# references point.
138#
139# Easiest is to just depend on all tag.prep files all across everywhere.
140
141$(top_builddir)/doc/core/html/index.html: $(top_builddir)/doc/libosmocore.tag.prep \
142 $(top_builddir)/doc/libosmogsm.tag.prep \
143 $(top_builddir)/doc/libosmovty.tag.prep \
144 $(top_builddir)/doc/libosmocodec.tag.prep \
145 $(top_builddir)/doc/libosmocoding.tag.prep \
146 $(top_builddir)/doc/libosmoctrl.tag.prep \
147 $(top_builddir)/doc/libosmogb.tag.prep
148 rm -rf $(top_builddir)/doc/core; mkdir -p $(top_builddir)/doc/core
Harald Weltec7859ed2011-08-20 12:54:17 +0200149 $(DOXYGEN) Doxyfile.core
Harald Welte21e73c22011-08-17 19:33:06 +0200150
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100151$(top_builddir)/doc/gsm/html/index.html: $(top_builddir)/doc/libosmogsm.tag.prep \
152 $(top_builddir)/doc/libosmocore.tag.prep \
153 $(top_builddir)/doc/libosmovty.tag.prep \
154 $(top_builddir)/doc/libosmocodec.tag.prep \
155 $(top_builddir)/doc/libosmocoding.tag.prep \
156 $(top_builddir)/doc/libosmoctrl.tag.prep \
157 $(top_builddir)/doc/libosmogb.tag.prep
158 rm -rf $(top_builddir)/doc/gsm; mkdir -p $(top_builddir)/doc/gsm
Harald Welte21e73c22011-08-17 19:33:06 +0200159 $(DOXYGEN) Doxyfile.gsm
160
Oliver Smith316d1e12019-06-28 09:13:22 +0200161# Don't delete the entire doc/vty, it contains example.xml and vtydoc.xsd (OS#3986)
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100162$(top_builddir)/doc/vty/html/index.html: $(top_builddir)/doc/libosmovty.tag.prep \
163 $(top_builddir)/doc/libosmocore.tag.prep \
164 $(top_builddir)/doc/libosmogsm.tag.prep \
165 $(top_builddir)/doc/libosmocodec.tag.prep \
166 $(top_builddir)/doc/libosmocoding.tag.prep \
167 $(top_builddir)/doc/libosmoctrl.tag.prep \
168 $(top_builddir)/doc/libosmogb.tag.prep
Oliver Smith316d1e12019-06-28 09:13:22 +0200169 rm -rf $(top_builddir)/doc/vty/html $(top_builddir)/doc/vty/latex
Harald Welte21e73c22011-08-17 19:33:06 +0200170 $(DOXYGEN) Doxyfile.vty
171
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100172$(top_builddir)/doc/codec/html/index.html: $(top_builddir)/doc/libosmocodec.tag.prep \
173 $(top_builddir)/doc/libosmocore.tag.prep \
174 $(top_builddir)/doc/libosmogsm.tag.prep \
175 $(top_builddir)/doc/libosmovty.tag.prep \
176 $(top_builddir)/doc/libosmocoding.tag.prep \
177 $(top_builddir)/doc/libosmoctrl.tag.prep \
178 $(top_builddir)/doc/libosmogb.tag.prep
179 rm -rf $(top_builddir)/doc/codec; mkdir -p $(top_builddir)/doc/codec
Harald Welte21e73c22011-08-17 19:33:06 +0200180 $(DOXYGEN) Doxyfile.codec
181
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100182$(top_builddir)/doc/coding/html/index.html: $(top_builddir)/doc/libosmocoding.tag.prep \
183 $(top_builddir)/doc/libosmocore.tag.prep \
184 $(top_builddir)/doc/libosmogsm.tag.prep \
185 $(top_builddir)/doc/libosmovty.tag.prep \
186 $(top_builddir)/doc/libosmocodec.tag.prep \
187 $(top_builddir)/doc/libosmoctrl.tag.prep \
188 $(top_builddir)/doc/libosmogb.tag.prep
189 rm -rf $(top_builddir)/doc/coding; mkdir -p $(top_builddir)/doc/coding
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700190 $(DOXYGEN) Doxyfile.coding
191
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100192$(top_builddir)/doc/ctrl/html/index.html: $(top_builddir)/doc/libosmoctrl.tag.prep \
193 $(top_builddir)/doc/libosmocore.tag.prep \
194 $(top_builddir)/doc/libosmogsm.tag.prep \
195 $(top_builddir)/doc/libosmovty.tag.prep \
196 $(top_builddir)/doc/libosmocodec.tag.prep \
197 $(top_builddir)/doc/libosmocoding.tag.prep \
198 $(top_builddir)/doc/libosmogb.tag.prep
199 rm -rf $(top_builddir)/doc/ctrl; mkdir -p $(top_builddir)/doc/ctrl
Harald Welteb4186822018-05-26 17:25:11 +0200200 $(DOXYGEN) Doxyfile.ctrl
201
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100202$(top_builddir)/doc/gb/html/index.html: $(top_builddir)/doc/libosmogb.tag.prep \
203 $(top_builddir)/doc/libosmocore.tag.prep \
204 $(top_builddir)/doc/libosmogsm.tag.prep \
205 $(top_builddir)/doc/libosmovty.tag.prep \
206 $(top_builddir)/doc/libosmocodec.tag.prep \
207 $(top_builddir)/doc/libosmocoding.tag.prep \
208 $(top_builddir)/doc/libosmoctrl.tag.prep
209 rm -rf $(top_builddir)/doc/gb; mkdir -p $(top_builddir)/doc/gb
Neels Hofmeyr249fb712017-06-20 02:52:38 +0200210 $(DOXYGEN) Doxyfile.gb
211
Neels Hofmeyr44c15b72019-02-01 05:56:09 +0100212if HAVE_DOXYGEN
Harald Welte21e73c22011-08-17 19:33:06 +0200213install-data-hook:
Diego Elio Pettenò200710e2012-06-29 13:01:26 -0700214 cd $(DESTDIR)$(htmldir) && tar xf html.tar && rm -f html.tar
Harald Welte21e73c22011-08-17 19:33:06 +0200215
216uninstall-hook:
Harald Welteb4186822018-05-26 17:25:11 +0200217 cd $(DESTDIR)$(htmldir) && rm -rf {core,gsm,vty,codec,coding,ctrl,gb}
Harald Welte21e73c22011-08-17 19:33:06 +0200218
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100219DX_CLEAN = doc/{core,gsm,vty,codec,coding,ctrl,gb}/html/search/* doc/{core,gsm,vty,codec,coding,ctrl,gb}/{html,latex}/* doc/html.tar doc/{core,gsm,vty,codec,coding,ctrl,gb}/doxygen_sqlite3.db doc/*.tag doc/*.tag.prep
Harald Welte21e73c22011-08-17 19:33:06 +0200220endif
Harald Welte47945f02011-08-20 13:00:37 +0200221
222MOSTLYCLEANFILES = $(DX_CLEAN)