blob: 43478077703e787271f6e6668ab3fde03d72f43b [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
Neels Hofmeyr044f0cd2022-06-12 19:04:05 +02004SUBDIRS = \
5 include \
6 src \
Neels Hofmeyr044f0cd2022-06-12 19:04:05 +02007 utils \
8 tapset \
9 tests \
10 $(NULL)
Harald Welte3cae0392010-02-20 21:09:24 +010011
12pkgconfigdir = $(libdir)/pkgconfig
Harald Welte641f7ce2012-06-17 23:05:26 +080013pkgconfig_DATA = libosmocore.pc libosmocodec.pc libosmovty.pc libosmogsm.pc \
Harald Welteda432cd2019-12-15 19:13:26 +010014 libosmogb.pc libosmoctrl.pc libosmocoding.pc libosmosim.pc \
15 libosmousb.pc
Harald Welte4cd3d8a2010-03-23 00:30:19 +080016
Vasil Velichkov499510b2019-04-03 02:32:37 +030017aclocaldir = $(datadir)/aclocal
18dist_aclocal_DATA = m4/osmo_ac_code_coverage.m4 \
19 m4/osmo_ax_code_coverage.m4
20
Maxff932bb2017-07-04 18:19:38 +020021@RELMAKE@
Vasil Velichkov499510b2019-04-03 02:32:37 +030022@CODE_COVERAGE_RULES@
Maxff932bb2017-07-04 18:19:38 +020023
24relengdir = $(includedir)
25releng_DATA = osmo-release.mk
26
Harald Welteee497f22017-10-03 16:54:41 +080027dist_bin_SCRIPTS = osmo-release.sh
28
Maxff932bb2017-07-04 18:19:38 +020029osmo-release.mk: git-version-gen
30
Harald Welte4cd3d8a2010-03-23 00:30:19 +080031BUILT_SOURCES = $(top_srcdir)/.version
32$(top_srcdir)/.version:
33 echo $(VERSION) > $@-t && mv $@-t $@
34dist-hook:
35 echo $(VERSION) > $(distdir)/.tarball-version
Holger Hans Peter Freytherec4f1602011-07-17 12:13:31 +020036
Oliver Smitha2991392020-05-22 13:13:17 +020037EXTRA_DIST = \
38 .version \
39 README.md \
40 contrib/libosmocore.spec.in \
41 debian \
42 git-version-gen \
43 osmo-release.mk \
44 osmo-release.sh \
45 $(NULL)
Harald Welte21e73c22011-08-17 19:33:06 +020046
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010047HTML = \
48 $(top_builddir)/doc/core/html/index.html \
49 $(top_builddir)/doc/gsm/html/index.html \
50 $(top_builddir)/doc/vty/html/index.html \
51 $(top_builddir)/doc/codec/html/index.html \
52 $(top_builddir)/doc/coding/html/index.html \
53 $(top_builddir)/doc/ctrl/html/index.html \
54 $(top_builddir)/doc/gb/html/index.html
Harald Welte21e73c22011-08-17 19:33:06 +020055
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010056if HAVE_DOXYGEN
Diego Elio Pettenò200710e2012-06-29 13:01:26 -070057html_DATA = $(top_builddir)/doc/html.tar
Harald Welte21e73c22011-08-17 19:33:06 +020058
Neels Hofmeyr249fb712017-06-20 02:52:38 +020059doc: $(html_DATA)
60
Neels Hofmeyr44c15b72019-02-01 05:56:09 +010061$(html_DATA): apidoc
62else
63DOXYGEN=doxygen
64endif
65
66.PHONY: apidoc
67apidoc: $(HTML)
Harald Welte7992af02011-08-17 19:37:26 +020068 cd $(top_builddir)/doc && tar cf html.tar */html
Harald Welte21e73c22011-08-17 19:33:06 +020069
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010070# Support doxygen cross references from each library to each other library:
71# First generate the docs to make sure all .tag files are in place.
72# In a second run, generate the content with proper referencing.
73# For example, libosmocore references tags from libosmovty and vice versa,
74# so both need to generate tag files first, and then do another run.
75#
76# Generate each docs tree, and touch a libosmofoo.tag.prep file when done.
77# It means that a libosmofoo.tag file is up-to-date.
78# Touch a separate "*.prep" target: libosmofoo.tag as target would create
79# circular dependency: we would rebuild all every time 'make' is invoked.
80# The .prep file also depends on all the source files for that library.
81
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010082$(top_builddir)/doc/libosmocore.tag.prep: $(top_builddir)/Doxyfile.core \
83 $(top_srcdir)/include/osmocom/core/*.h \
Pau Espin Pedrold4c3dc82023-01-18 17:04:04 +010084 $(top_srcdir)/src/core/*.[hc] \
85 $(top_srcdir)/src/core/crcXXgen.c.tpl \
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010086 $(top_srcdir)/src/pseudotalloc/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010087 rm -rf $(top_builddir)/doc/core; mkdir -p $(top_builddir)/doc/core
88 rm -rf $(top_builddir)/doc/libosmocore.map
89 -$(DOXYGEN) $(top_builddir)/Doxyfile.core
90 touch "$@"
91
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +010092$(top_builddir)/doc/libosmogsm.tag.prep: $(top_builddir)/Doxyfile.gsm \
93 $(top_srcdir)/include/osmocom/gsm/*.h \
94 $(top_srcdir)/include/osmocom/gsm/protocol/*.h \
95 $(top_srcdir)/include/osmocom/crypt/*.h \
96 $(top_srcdir)/src/gsm/*.c \
97 $(top_srcdir)/src/gsm/milenage/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +010098 rm -rf $(top_builddir)/doc/gsm; mkdir -p $(top_builddir)/doc/gsm
99 rm -rf $(top_builddir)/doc/libosmogsm.map
100 -$(DOXYGEN) $(top_builddir)/Doxyfile.gsm
101 touch "$@"
102
Oliver Smith316d1e12019-06-28 09:13:22 +0200103# Don't delete the entire doc/vty, it contains example.xml and vtydoc.xsd (OS#3986)
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100104$(top_builddir)/doc/libosmovty.tag.prep: $(top_builddir)/Doxyfile.vty \
105 $(top_srcdir)/include/osmocom/vty/*.h \
106 $(top_srcdir)/src/vty/*.c
Oliver Smith316d1e12019-06-28 09:13:22 +0200107 rm -rf $(top_builddir)/doc/vty/html $(top_builddir)/doc/vty/latex
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100108 rm -rf $(top_builddir)/doc/libosmovty.map
109 -$(DOXYGEN) $(top_builddir)/Doxyfile.vty
110 touch "$@"
111
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100112$(top_builddir)/doc/libosmocodec.tag.prep: $(top_builddir)/Doxyfile.codec \
113 $(top_srcdir)/include/osmocom/codec/*.h \
114 $(top_srcdir)/src/codec/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100115 rm -rf $(top_builddir)/doc/codec; mkdir -p $(top_builddir)/doc/codec
116 rm -rf $(top_builddir)/doc/libosmocodec.map
117 -$(DOXYGEN) $(top_builddir)/Doxyfile.codec
118 touch "$@"
119
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100120$(top_builddir)/doc/libosmocoding.tag.prep: $(top_builddir)/Doxyfile.coding \
121 $(top_srcdir)/include/osmocom/coding/*.h \
122 $(top_srcdir)/src/coding/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100123 rm -rf $(top_builddir)/doc/coding; mkdir -p $(top_builddir)/doc/coding
124 rm -rf $(top_builddir)/doc/libosmocoding.map
125 -$(DOXYGEN) $(top_builddir)/Doxyfile.coding
126 touch "$@"
127
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100128$(top_builddir)/doc/libosmoctrl.tag.prep: $(top_builddir)/Doxyfile.ctrl \
129 $(top_srcdir)/include/osmocom/ctrl/*.h \
130 $(top_srcdir)/src/ctrl/*.c
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100131 rm -rf $(top_builddir)/doc/ctrl; mkdir -p $(top_builddir)/doc/ctrl
132 rm -rf $(top_builddir)/doc/libosmoctrl.map
133 -$(DOXYGEN) $(top_builddir)/Doxyfile.ctrl
134 touch "$@"
135
Neels Hofmeyr375bf6d2019-02-01 05:25:36 +0100136$(top_builddir)/doc/libosmogb.tag.prep: $(top_builddir)/Doxyfile.gb \
137 $(top_srcdir)/include/osmocom/gprs/*.h \
138 $(top_srcdir)/src/gb/*.[hc]
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100139 rm -rf $(top_builddir)/doc/gb; mkdir -p $(top_builddir)/doc/gb
140 rm -rf $(top_builddir)/doc/libosmogb.map
141 -$(DOXYGEN) $(top_builddir)/Doxyfile.gb
142 touch "$@"
143
144# Build for real once all depending .tag files are in place.
145# Depend on the own .tag.prep file to avoid concurrent builds of the same doc
146# tree, and to also depend on all the source files listed above.
147#
148# Each library should depend on all the tag.prep files of which it lists .tag
149# files in Doxyfile under TAGFILES.
150#
151# In turn, include all .tag files in TAGFILES of libraries to which "\ref"
152# references point.
153#
154# Easiest is to just depend on all tag.prep files all across everywhere.
155
156$(top_builddir)/doc/core/html/index.html: $(top_builddir)/doc/libosmocore.tag.prep \
157 $(top_builddir)/doc/libosmogsm.tag.prep \
158 $(top_builddir)/doc/libosmovty.tag.prep \
159 $(top_builddir)/doc/libosmocodec.tag.prep \
160 $(top_builddir)/doc/libosmocoding.tag.prep \
161 $(top_builddir)/doc/libosmoctrl.tag.prep \
162 $(top_builddir)/doc/libosmogb.tag.prep
163 rm -rf $(top_builddir)/doc/core; mkdir -p $(top_builddir)/doc/core
Harald Weltec7859ed2011-08-20 12:54:17 +0200164 $(DOXYGEN) Doxyfile.core
Harald Welte21e73c22011-08-17 19:33:06 +0200165
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100166$(top_builddir)/doc/gsm/html/index.html: $(top_builddir)/doc/libosmogsm.tag.prep \
167 $(top_builddir)/doc/libosmocore.tag.prep \
168 $(top_builddir)/doc/libosmovty.tag.prep \
169 $(top_builddir)/doc/libosmocodec.tag.prep \
170 $(top_builddir)/doc/libosmocoding.tag.prep \
171 $(top_builddir)/doc/libosmoctrl.tag.prep \
172 $(top_builddir)/doc/libosmogb.tag.prep
173 rm -rf $(top_builddir)/doc/gsm; mkdir -p $(top_builddir)/doc/gsm
Harald Welte21e73c22011-08-17 19:33:06 +0200174 $(DOXYGEN) Doxyfile.gsm
175
Oliver Smith316d1e12019-06-28 09:13:22 +0200176# Don't delete the entire doc/vty, it contains example.xml and vtydoc.xsd (OS#3986)
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100177$(top_builddir)/doc/vty/html/index.html: $(top_builddir)/doc/libosmovty.tag.prep \
178 $(top_builddir)/doc/libosmocore.tag.prep \
179 $(top_builddir)/doc/libosmogsm.tag.prep \
180 $(top_builddir)/doc/libosmocodec.tag.prep \
181 $(top_builddir)/doc/libosmocoding.tag.prep \
182 $(top_builddir)/doc/libosmoctrl.tag.prep \
183 $(top_builddir)/doc/libosmogb.tag.prep
Oliver Smith316d1e12019-06-28 09:13:22 +0200184 rm -rf $(top_builddir)/doc/vty/html $(top_builddir)/doc/vty/latex
Harald Welte21e73c22011-08-17 19:33:06 +0200185 $(DOXYGEN) Doxyfile.vty
186
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100187$(top_builddir)/doc/codec/html/index.html: $(top_builddir)/doc/libosmocodec.tag.prep \
188 $(top_builddir)/doc/libosmocore.tag.prep \
189 $(top_builddir)/doc/libosmogsm.tag.prep \
190 $(top_builddir)/doc/libosmovty.tag.prep \
191 $(top_builddir)/doc/libosmocoding.tag.prep \
192 $(top_builddir)/doc/libosmoctrl.tag.prep \
193 $(top_builddir)/doc/libosmogb.tag.prep
194 rm -rf $(top_builddir)/doc/codec; mkdir -p $(top_builddir)/doc/codec
Harald Welte21e73c22011-08-17 19:33:06 +0200195 $(DOXYGEN) Doxyfile.codec
196
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100197$(top_builddir)/doc/coding/html/index.html: $(top_builddir)/doc/libosmocoding.tag.prep \
198 $(top_builddir)/doc/libosmocore.tag.prep \
199 $(top_builddir)/doc/libosmogsm.tag.prep \
200 $(top_builddir)/doc/libosmovty.tag.prep \
201 $(top_builddir)/doc/libosmocodec.tag.prep \
202 $(top_builddir)/doc/libosmoctrl.tag.prep \
203 $(top_builddir)/doc/libosmogb.tag.prep
204 rm -rf $(top_builddir)/doc/coding; mkdir -p $(top_builddir)/doc/coding
Vadim Yanitskiy3262f822016-09-23 01:48:59 +0700205 $(DOXYGEN) Doxyfile.coding
206
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100207$(top_builddir)/doc/ctrl/html/index.html: $(top_builddir)/doc/libosmoctrl.tag.prep \
208 $(top_builddir)/doc/libosmocore.tag.prep \
209 $(top_builddir)/doc/libosmogsm.tag.prep \
210 $(top_builddir)/doc/libosmovty.tag.prep \
211 $(top_builddir)/doc/libosmocodec.tag.prep \
212 $(top_builddir)/doc/libosmocoding.tag.prep \
213 $(top_builddir)/doc/libosmogb.tag.prep
214 rm -rf $(top_builddir)/doc/ctrl; mkdir -p $(top_builddir)/doc/ctrl
Harald Welteb4186822018-05-26 17:25:11 +0200215 $(DOXYGEN) Doxyfile.ctrl
216
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100217$(top_builddir)/doc/gb/html/index.html: $(top_builddir)/doc/libosmogb.tag.prep \
218 $(top_builddir)/doc/libosmocore.tag.prep \
219 $(top_builddir)/doc/libosmogsm.tag.prep \
220 $(top_builddir)/doc/libosmovty.tag.prep \
221 $(top_builddir)/doc/libosmocodec.tag.prep \
222 $(top_builddir)/doc/libosmocoding.tag.prep \
223 $(top_builddir)/doc/libosmoctrl.tag.prep
224 rm -rf $(top_builddir)/doc/gb; mkdir -p $(top_builddir)/doc/gb
Neels Hofmeyr249fb712017-06-20 02:52:38 +0200225 $(DOXYGEN) Doxyfile.gb
226
Neels Hofmeyr44c15b72019-02-01 05:56:09 +0100227if HAVE_DOXYGEN
Harald Welte21e73c22011-08-17 19:33:06 +0200228install-data-hook:
Diego Elio Pettenò200710e2012-06-29 13:01:26 -0700229 cd $(DESTDIR)$(htmldir) && tar xf html.tar && rm -f html.tar
Harald Welte21e73c22011-08-17 19:33:06 +0200230
231uninstall-hook:
Harald Welteb4186822018-05-26 17:25:11 +0200232 cd $(DESTDIR)$(htmldir) && rm -rf {core,gsm,vty,codec,coding,ctrl,gb}
Harald Welte21e73c22011-08-17 19:33:06 +0200233
Neels Hofmeyr2fe50ac2019-02-01 05:25:36 +0100234DX_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 +0200235endif
Harald Welte47945f02011-08-20 13:00:37 +0200236
237MOSTLYCLEANFILES = $(DX_CLEAN)