Consistent use of 'void *opaque' to refer to opaque pointer in C API.
[libguestfs.git] / src / Makefile.am
1 # libguestfs
2 # Copyright (C) 2009 Red Hat Inc.
3 #
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 2 of the License, or
7 # (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 include $(top_srcdir)/subdir-rules.mk
19
20 generator_built = \
21         guestfs_protocol.x \
22         guestfs-structs.h \
23         guestfs-actions.h \
24         guestfs-internal-actions.h \
25         actions.c \
26         bindtests.c \
27         guestfs-actions.pod \
28         guestfs-availability.pod \
29         guestfs-structs.pod \
30         libguestfs.syms
31
32 $(generator_built): stamp-generator
33
34 BUILT_SOURCES = \
35   $(generator_built) \
36   guestfs_protocol.c \
37   guestfs_protocol.h
38
39 EXTRA_DIST = \
40         $(BUILT_SOURCES) \
41         MAX_PROC_NR \
42         stamp-generator \
43         generator.ml \
44         libguestfs.3 \
45         guestfs.pod
46
47 # Rerun the generator if it has changed.
48 # Git removes empty directories, so in cases where the
49 # generator is creating the sole file in a directory, we
50 # have to create the directory first.
51 noinst_DATA = stamp-generator
52
53 stamp-generator: generator.ml ../images/test.iso
54         mkdir -p $(top_srcdir)/perl/lib/Sys
55         mkdir -p $(top_srcdir)/ruby/ext/guestfs
56         mkdir -p $(top_srcdir)/java/com/redhat/et/libguestfs
57         mkdir -p $(top_srcdir)/csharp
58         cd $(top_srcdir) && ocaml -warn-error A src/generator.ml
59
60 ../images/test.iso:
61         make -C ../images test.iso
62
63 include_HEADERS = guestfs.h guestfs-actions.h guestfs-structs.h
64
65 lib_LTLIBRARIES = libguestfs.la
66
67 # This convenience library is solely to avoid compiler warnings
68 # in its generated sources.
69 libprotocol_la_SOURCES = \
70   guestfs_protocol.c \
71   guestfs_protocol.h
72
73 libprotocol_la_CFLAGS =
74
75 # From the libtool info file, with comments:
76 #
77 # |  1. Start with version information of `0:0:0' for each libtool library.
78 # |
79 # |  2. Update the version information only immediately before a public
80 # |     release of your software.  More frequent updates are unnecessary,
81 # |     and only guarantee that the current interface number gets larger
82 # |     faster.
83 # |
84 # |  3. If the library source code has changed at all since the last
85 # |     update, then increment REVISION (`C:R:A' becomes `C:r+1:A').
86 #
87 # [So it seems like we should always update the middle 'R' field
88 # for any release.]
89 #
90 # |  4. If any interfaces have been added, removed, or changed since the
91 # |     last update, increment CURRENT, and set REVISION to 0.
92 # |
93 # |  5. If any interfaces have been added since the last public release,
94 # |     then increment AGE.
95 #
96 # [These two rules seem to mean that if any change is made to the
97 # generator, we should increment C and A, and set R to 0, so:
98 # C+1:0:A+1.]
99 #
100 # |  6. If any interfaces have been removed since the last public release,
101 # |     then set AGE to 0.
102 #
103 # [Our ABI guarantee means we won't remove interfaces except in
104 # very exceptional circumstances.]
105 #
106 # The maximum proc number (see guestfs_protocol.x:guestfs_procedure) is
107 # a mostly accurate stand-in for C & A in rules 5 & 6, so we use that.  It
108 # is always incremented when we add a new appliance interface, and easy to
109 # calculate.
110 #
111 # The middle number is hard to increment-and-reset as described in rules
112 # 4 & 5, so for the moment it is always set to 0.
113 #
114 # Note that this scheme means the real library version will always be
115 # 'libguestfs.so.0.$(MAX_PROC_NR).0'.
116 libguestfs_la_LDFLAGS = -version-info $(MAX_PROC_NR):0:$(MAX_PROC_NR)
117
118 libguestfs_la_LDFLAGS += $(VERSION_SCRIPT_FLAGS)libguestfs.syms
119
120 libguestfs_la_SOURCES = \
121         guestfs.c \
122         guestfs.h \
123         guestfs-actions.h \
124         guestfs-internal.h \
125         guestfs_protocol.h \
126         gettext.h \
127         actions.c \
128         appliance.c \
129         bindtests.c \
130         inspect.c \
131         launch.c \
132         proto.c \
133         libguestfs.syms
134
135 libguestfs_la_LIBADD = $(HIVEX_LIBS) $(LIBPCRE) $(LIBMAGIC) $(LTLIBTHREAD) ../gnulib/lib/libgnu.la
136
137 # Make libguestfs include the convenience library.
138 noinst_LTLIBRARIES = libprotocol.la
139 libguestfs_la_LIBADD += libprotocol.la
140
141 libguestfs_la_CFLAGS = \
142   -DGUESTFS_DEFAULT_PATH='"$(libdir)/guestfs"' \
143   $(HIVEX_CFLAGS) \
144   $(WARN_CFLAGS) $(WERROR_CFLAGS)
145
146 libguestfs_la_CPPFLAGS = -I$(top_srcdir)/gnulib/lib
147
148 if HAVE_RPCGEN
149 guestfs_protocol.c: guestfs_protocol.x
150         rm -f $@-t $@-t2
151         $(RPCGEN) -c -o $@-t $<
152         sed 's,\.\./\.\./src/,,' < $@-t > $@-t2
153         rm $@-t
154         mv $@-t2 $@
155
156 guestfs_protocol.h: guestfs_protocol.x
157         rm -f $@-t
158         $(RPCGEN) -h -o $@-t $<
159         mv $@-t $@
160 endif
161
162 # Manual page.
163 # guestfs-actions.pod, guestfs-availability.pod and guestfs-structs
164 # are autogenerated.  There is no include mechanism for POD, so we
165 # have to do it by hand.
166
167 man_MANS = guestfs.3 libguestfs.3
168
169 guestfs.3: guestfs.pod \
170                 guestfs-actions.pod \
171                 guestfs-availability.pod \
172                 guestfs-structs.pod
173         sed \
174           -e '/@ACTIONS@/rguestfs-actions.pod' \
175           -e 's/@ACTIONS@//' \
176           -e '/@AVAILABILITY@/rguestfs-availability.pod' \
177           -e 's/@AVAILABILITY@//' \
178           -e '/@STRUCTS@/rguestfs-structs.pod' \
179           -e 's/@STRUCTS@//' \
180           < $< | \
181         $(POD2MAN) \
182           --section 3 \
183           -c "Virtualization Support" \
184           --name "guestfs" \
185           --release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
186           > $@
187
188 # Check user doesn't try to do 'make all' or 'make check' as root.
189 # https://www.redhat.com/archives/libguestfs/2010-April/msg00098.html
190
191 all-local: checkroot
192 check-local: checkroot
193 checkroot:
194         @if [ "`id -u`" = 0 ]; then \
195             echo "*** Error: Don't run 'make' or 'make check' as root."; \
196             exit 1; \
197         fi