dist-docs: New utility to generate a documentation bundle for the website.
[cascardo/ovs.git] / Makefile.am
1 # Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
2 #
3 # Copying and distribution of this file, with or without modification,
4 # are permitted in any medium without royalty provided the copyright
5 # notice and this notice are preserved.  This file is offered as-is,
6 # without warranty of any kind.
7
8 AUTOMAKE_OPTIONS = foreign subdir-objects
9 ACLOCAL_AMFLAGS = -I m4
10 SUBDIRS = datapath
11
12 AM_CPPFLAGS = $(SSL_CFLAGS)
13 AM_LDFLAGS = $(SSL_LDFLAGS)
14 AM_LDFLAGS += $(OVS_LDFLAGS)
15
16 if WIN32
17 AM_CPPFLAGS += -I $(top_srcdir)/include/windows
18 AM_CPPFLAGS += -I $(top_srcdir)/datapath-windows/include
19 AM_CPPFLAGS += $(PTHREAD_INCLUDES)
20 AM_CPPFLAGS += $(MSVC_CFLAGS)
21 AM_LDFLAGS += $(PTHREAD_LDFLAGS)
22 endif
23
24 AM_CPPFLAGS += -I $(top_srcdir)/include
25 AM_CPPFLAGS += -I $(top_builddir)/include
26 AM_CPPFLAGS += -I $(top_srcdir)/lib
27 AM_CPPFLAGS += -I $(top_builddir)/lib
28
29 AM_CPPFLAGS += $(SSL_INCLUDES)
30
31 AM_CFLAGS = -Wstrict-prototypes
32 AM_CFLAGS += $(WARNING_FLAGS)
33 AM_CFLAGS += $(OVS_CFLAGS)
34
35 if NDEBUG
36 AM_CPPFLAGS += -DNDEBUG
37 AM_CFLAGS += -fomit-frame-pointer
38 endif
39
40 if WIN32
41 psep=";"
42 else
43 psep=":"
44 endif
45 # PYTHONDONTWRITEBYTECODE=yes keeps Python from creating .pyc and .pyo
46 # files.  Creating .py[co] works OK for any given version of Open
47 # vSwitch, but it causes trouble if you switch from a version with
48 # foo/__init__.py into an (older) version with plain foo.py, since
49 # foo/__init__.pyc will cause Python to ignore foo.py.
50 if INCLUDE_PYTHON_COMPAT
51 run_python = PYTHONPATH=$(top_srcdir)/python$(psep)$(top_srcdir)/python/compat$(psep)$$PYTHONPATH
52 else
53 run_python = PYTHONPATH=$(top_srcdir)/python$(psep)$$PYTHONPATH
54 endif
55 run_python += PYTHONDONTWRITEBYTECODE=yes $(PYTHON)
56
57
58 ALL_LOCAL =
59 BUILT_SOURCES =
60 CLEANFILES =
61 CLEAN_LOCAL =
62 DISTCLEANFILES =
63 PYCOV_CLEAN_FILES = build-aux/check-structs,cover
64
65 # A list of Markdown-formatted documentation that will automatically be
66 # included in the "make dist-docs" output.
67 docs = \
68         CONTRIBUTING.md \
69         CodingStyle.md \
70         DESIGN.md \
71         FAQ.md \
72         INSTALL.md \
73         INSTALL.Debian.md \
74         INSTALL.Docker.md \
75         INSTALL.DPDK.md \
76         INSTALL.Fedora.md \
77         INSTALL.KVM.md \
78         INSTALL.Libvirt.md \
79         INSTALL.NetBSD.md \
80         INSTALL.RHEL.md \
81         INSTALL.SSL.md \
82         INSTALL.XenServer.md \
83         INSTALL.userspace.md \
84         INSTALL.Windows.md \
85         IntegrationGuide.md \
86         OPENFLOW-1.1+.md \
87         PORTING.md \
88         README.md \
89         README-lisp.md \
90         README-native-tunneling.md \
91         REPORTING-BUGS.md \
92         TODO.md \
93         WHY-OVS.md
94 EXTRA_DIST = \
95         $(docs) \
96         NOTICE \
97         .travis.yml \
98         .travis/build.sh \
99         .travis/prepare.sh \
100         boot.sh \
101         build-aux/cccl \
102         build-aux/dist-docs \
103         build-aux/sodepends.pl \
104         build-aux/soexpand.pl \
105         $(MAN_FRAGMENTS) \
106         $(MAN_ROOTS)
107 bin_PROGRAMS =
108 sbin_PROGRAMS =
109 bin_SCRIPTS =
110 DIST_HOOKS =
111 dist_man_MANS =
112 dist_pkgdata_DATA =
113 dist_pkgdata_SCRIPTS =
114 dist_sbin_SCRIPTS =
115 dist_scripts_SCRIPTS =
116 dist_scripts_DATA =
117 INSTALL_DATA_LOCAL =
118 UNINSTALL_LOCAL =
119 man_MANS =
120 MAN_FRAGMENTS =
121 MAN_ROOTS =
122 noinst_DATA =
123 noinst_HEADERS =
124 lib_LTLIBRARIES =
125 noinst_man_MANS =
126 noinst_PROGRAMS =
127 noinst_SCRIPTS =
128 OVSIDL_BUILT =
129 pkgdata_DATA =
130 sbin_SCRIPTS =
131 scripts_SCRIPTS =
132 scripts_DATA =
133 SUFFIXES =
134 check_DATA =
135 pkgconfig_DATA =
136
137 scriptsdir = $(pkgdatadir)/scripts
138 pkgconfigdir = $(libdir)/pkgconfig
139
140 # This ensures that files added to EXTRA_DIST are always distributed,
141 # even if they are inside an Automake if...endif conditional block that is
142 # disabled by some particular "configure" run.  For more information, see:
143 # http://article.gmane.org/gmane.comp.sysutils.automake.general/10891
144 noinst_HEADERS += $(EXTRA_DIST)
145
146 ro_c = echo '/* -*- mode: c; buffer-read-only: t -*- */'
147 ro_shell = printf '\043 Generated automatically -- do not modify!    -*- buffer-read-only: t -*-\n'
148
149 SUFFIXES += .in
150 .in:
151         $(AM_V_GEN)$(PERL) $(srcdir)/build-aux/soexpand.pl -I$(srcdir) < $< | \
152             sed \
153                 -e 's,[@]PKIDIR[@],$(PKIDIR),g' \
154                 -e 's,[@]LOGDIR[@],$(LOGDIR),g' \
155                 -e 's,[@]DBDIR[@],$(DBDIR),g' \
156                 -e 's,[@]PERL[@],$(PERL),g' \
157                 -e 's,[@]PYTHON[@],$(PYTHON),g' \
158                 -e 's,[@]RUNDIR[@],$(RUNDIR),g' \
159                 -e 's,[@]VERSION[@],$(VERSION),g' \
160                 -e 's,[@]localstatedir[@],$(localstatedir),g' \
161                 -e 's,[@]pkgdatadir[@],$(pkgdatadir),g' \
162                 -e 's,[@]sysconfdir[@],$(sysconfdir),g' \
163                 -e 's,[@]bindir[@],$(bindir),g' \
164                 -e 's,[@]sbindir[@],$(sbindir),g' \
165                 -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \
166             > $@.tmp
167         @if head -n 1 $@.tmp | grep '#!' > /dev/null; then \
168             chmod +x $@.tmp; \
169         fi
170         $(AM_V_at) mv $@.tmp $@
171
172 .PHONY: clean-pycov
173 clean-pycov:
174         cd $(srcdir) && rm -f $(PYCOV_CLEAN_FILES)
175 CLEAN_LOCAL += clean-pycov
176
177 # If we're checked out from a Git repository, make sure that every
178 # file that is in Git is distributed.
179 #
180 # We only enable this check when GNU make is in use because the
181 # Makefile in datapath/linux, needed to get the list of files to
182 # distribute, requires GNU make extensions.
183 if GNU_MAKE
184 ALL_LOCAL += dist-hook-git
185 dist-hook-git: distfiles
186         @if test -e $(srcdir)/.git && (git --version) >/dev/null 2>&1; then \
187           (cd datapath && $(MAKE) distfiles);                               \
188           (cat distfiles; sed 's|^|datapath/|' datapath/distfiles) |        \
189             LC_ALL=C sort -u > all-distfiles;                               \
190           (cd $(srcdir) && git ls-files) | grep -v '\.gitignore$$' |        \
191             LC_ALL=C sort -u > all-gitfiles;                                \
192           LC_ALL=C comm -1 -3 all-distfiles all-gitfiles > missing-distfiles; \
193           if test -s missing-distfiles; then                                \
194             echo "The distribution is missing the following files:";        \
195             cat missing-distfiles;                                          \
196             exit 1;                                                         \
197           fi;                                                               \
198         fi
199 CLEANFILES += all-distfiles all-gitfiles missing-distfiles
200 # The following is based on commands for the Automake "distdir" target.
201 distfiles: Makefile
202         @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
203         topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
204         list='$(DISTFILES)'; \
205         for file in $$list; do echo $$file; done | \
206           sed -e "s|^$$srcdirstrip/||;t" \
207               -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t" | \
208           LC_ALL=C sort -u > $@
209 CLEANFILES += distfiles
210 endif
211 .PHONY: dist-hook-git
212
213 # Check that every .c file includes <config.h>.
214 ALL_LOCAL += config-h-check
215 config-h-check:
216         @cd $(srcdir); \
217         if test -e .git && (git --version) >/dev/null 2>&1 && \
218            git --no-pager grep -L '#include <config\.h>' `git ls-files | grep '\.c$$' | \
219                grep -vE '^datapath|^lib/sflow|^third-party|^datapath-windows'`; \
220         then \
221             echo "See above for list of violations of the rule that"; \
222             echo "every C source file must #include <config.h>."; \
223             exit 1; \
224         fi
225 .PHONY: config-h-check
226
227 # Check for printf() type modifiers that MSVC doesn't support.
228 ALL_LOCAL += printf-check
229 printf-check:
230         @cd $(srcdir); \
231         if test -e .git && (git --version) >/dev/null 2>&1 && \
232            git --no-pager grep -n -E -e '%[-+ #0-9.*]*([ztj]|hh)' --and --not -e 'ovs_scan' `git ls-files | grep '\.[ch]$$' | \
233                grep -vE '^datapath|^lib/sflow|^third-party'`; \
234         then \
235             echo "See above for list of violations of the rule that"; \
236             echo "'z', 't', 'j', 'hh' printf() type modifiers are"; \
237             echo "forbidden.  See CodingStyle.md for replacements."; \
238             exit 1; \
239         fi
240 .PHONY: printf-check
241
242 # Check that certain data structures are always declared "static".
243 ALL_LOCAL += static-check
244 static-check:
245         @if test -e $(srcdir)/.git && (git --version) >/dev/null 2>&1 && \
246             git --no-pager grep -n -E '^[       ]+(struct vlog_rate_limit|pthread_once_t|struct ovsthread_once).*=' $(srcdir); \
247          then \
248             echo "See above for list of violations of the rule that "; \
249             echo "certain data structures must always be 'static'"; \
250             exit 1; \
251          fi
252 .PHONY: static-check
253
254 # Check that assert.h is not used outside a whitelist of files.
255 ALL_LOCAL += check-assert-h-usage
256 check-assert-h-usage:
257         @if test -e $(srcdir)/.git && (git --version) >/dev/null 2>&1 && \
258             (cd $(srcdir) && git --no-pager grep -l -E '[<]assert.h[>]') | \
259             $(EGREP) -v '^lib/(sflow_receiver|vlog).c$$|^tests/'; \
260          then \
261             echo "Files listed above unexpectedly #include <""assert.h"">."; \
262             echo "Please use ovs_assert (from util.h) instead of assert."; \
263             exit 1; \
264          fi
265 .PHONY: check-assert-h-usage
266
267 # Check that LITTLE_ENDIAN and BIG_ENDIAN are not used unless BYTE_ORDER is
268 # also mentioned.  (<endian.h> always defines the former two constants.  They
269 # must be compared to BYTE_ORDER to get the machine's correct endianness.  But
270 # it is better to use WORDS_BIGENDIAN.)
271 ALL_LOCAL += check-endian
272 check-endian:
273         @if test -e $(srcdir)/.git && (git --version) >/dev/null 2>&1 && \
274             (cd $(srcdir) && git --no-pager grep -l -E \
275              -e 'BIG_ENDIAN|LITTLE_ENDIAN' --and --not -e 'BYTE_ORDER' | \
276             $(EGREP) -v '^datapath/'); \
277          then \
278             echo "See above for list of files that misuse LITTLE""_ENDIAN"; \
279             echo "or BIG""_ENDIAN.  Please use WORDS_BIGENDIAN instead."; \
280             exit 1; \
281          fi
282 .PHONY: check-endian
283
284 ALL_LOCAL += thread-safety-check
285 thread-safety-check:
286         @cd $(srcdir); \
287         if test -e .git && (git --version) >/dev/null 2>&1 && \
288            grep -n -f build-aux/thread-safety-blacklist \
289                `git ls-files | grep '\.[ch]$$' \
290                 | $(EGREP) -v '^datapath|^lib/sflow|^third-party'` /dev/null \
291                | $(EGREP) -v ':[        ]*/?\*'; \
292         then \
293             echo "See above for list of calls to functions that are"; \
294             echo "blacklisted due to thread safety issues"; \
295             exit 1; \
296         fi
297 EXTRA_DIST += build-aux/thread-safety-blacklist
298
299 if HAVE_GROFF
300 ALL_LOCAL += manpage-check
301 manpage-check: $(man_MANS) $(dist_man_MANS) $(noinst_man_MANS)
302         @error=false; \
303         for manpage in $?; do \
304                 LANG=en_US.UTF-8 groff -w mac -w delim -w escape -w input -w missing -w tab -T utf8 -man -p -z $$manpage >$@.tmp 2>&1; \
305                 if grep warning: $@.tmp; then error=:; fi; \
306                 rm -f $@.tmp; \
307         done; \
308         if $$error; then exit 1; else touch $@; fi
309         $(AM_V_GEN) touch -c $@
310 CLEANFILES += manpage-check
311 endif
312
313 include $(srcdir)/manpages.mk
314 $(srcdir)/manpages.mk: $(MAN_ROOTS) build-aux/sodepends.pl
315         @$(PERL) $(srcdir)/build-aux/sodepends.pl -I. -I$(srcdir) $(MAN_ROOTS) >$(@F).tmp
316         @if cmp -s $(@F).tmp $@; then \
317                 touch $@; \
318                 rm -f $(@F).tmp; \
319         else \
320                 mv $(@F).tmp $@; \
321         fi
322 CLEANFILES += manpage-dep-check
323
324 if VSTUDIO_DDK
325 ALL_LOCAL += ovsext_make
326 ovsext_make: datapath-windows/ovsext.sln
327         MSBuild.exe datapath-windows/ovsext.sln /target:Build /property:Configuration="$(VSTUDIO_CONFIG)"
328
329 CLEAN_LOCAL += ovsext_clean
330 ovsext_clean: datapath-windows/ovsext.sln
331         MSBuild.exe datapath-windows/ovsext.sln /target:Clean /property:Configuration="$(VSTUDIO_CONFIG)"
332 endif
333
334 dist-hook: $(DIST_HOOKS)
335 all-local: $(ALL_LOCAL)
336 clean-local: $(CLEAN_LOCAL)
337 install-data-local: $(INSTALL_DATA_LOCAL)
338 uninstall-local: $(UNINSTALL_LOCAL)
339 .PHONY: $(DIST_HOOKS) $(CLEAN_LOCAL) $(INSTALL_DATA_LOCAL) $(UNINSTALL_LOCAL)
340
341 modules_install:
342 if LINUX_ENABLED
343         cd datapath/linux && $(MAKE) modules_install
344 endif
345
346 dist-docs:
347         VERSION=$(VERSION) $(srcdir)/build-aux/dist-docs $(srcdir) $(docs)
348 .PHONY: dist-docs
349
350 include m4/automake.mk
351 include lib/automake.mk
352 include ofproto/automake.mk
353 include utilities/automake.mk
354 include tests/automake.mk
355 include include/automake.mk
356 include third-party/automake.mk
357 include debian/automake.mk
358 include vswitchd/automake.mk
359 include ovsdb/automake.mk
360 include rhel/automake.mk
361 include xenserver/automake.mk
362 include python/automake.mk
363 include python/compat/automake.mk
364 include tutorial/automake.mk
365 include vtep/automake.mk
366 include datapath-windows/automake.mk
367 include datapath-windows/include/automake.mk