forked from varnishcache/varnish-cache
-
Notifications
You must be signed in to change notification settings - Fork 0
/
varnish.m4
658 lines (579 loc) · 19.3 KB
/
varnish.m4
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
# Copyright (c) 2016-2018 Varnish Software AS
# All rights reserved.
#
# Author: Dridi Boukelmoune <[email protected]>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above
# copyright notice, this list of conditions and the following
# disclaimer.
# 2. Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials
# provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
# OF THE POSSIBILITY OF SUCH DAMAGE.
# varnish.m4 - Macros to build against Varnish. -*- Autoconf -*-
# serial 10 (varnish-6.0.0)
#
# This collection of macros helps create VMODs or tools interacting with
# Varnish Cache using the GNU build system (autotools). In order to work
# from a source checkout, recommended versions of autotools are 2.68 for
# autoconf, 1.12 for automake and 2.2.6 for libtool. For pkg-config, at
# least version 0.21 is required ; it should be available even on old
# platforms. Only pkg-config is needed when building from a dist archive.
#
# Macros whose name start with an underscore are private and may change at
# any time. Public macros starting with VARNISH_ are documented and will
# maintain backwards compatibility with older versions of Varnish Cache.
# _VARNISH_CHECK_LIB(LIB, FUNC)
# -----------------------------
AC_DEFUN([_VARNISH_CHECK_LIB], [
save_LIBS="${LIBS}"
LIBS=""
AC_CHECK_LIB([$1], [$2])
AC_SUBST(m4_toupper($1_LIBS), "$LIBS")
LIBS="${save_LIBS}"
])
# _VARNISH_SEARCH_LIBS(VAR, FUNC, LIBS)
# -------------------------------------
AC_DEFUN([_VARNISH_SEARCH_LIBS], [
save_LIBS="${LIBS}"
LIBS=""
AC_SEARCH_LIBS([$2], [$3])
AC_SUBST(m4_toupper($1_LIBS), "$LIBS")
LIBS="${save_LIBS}"
])
# _VARNISH_CHECK_EXPLICIT_BZERO()
# -------------------------------
AC_DEFUN([_VARNISH_CHECK_EXPLICIT_BZERO], [
AC_CHECK_FUNCS([explicit_bzero])
])
# _VARNISH_PKG_CONFIG
# --------------------
AC_DEFUN([_VARNISH_PKG_CONFIG], [
PKG_PROG_PKG_CONFIG([0.21])
PKG_CHECK_MODULES([VARNISHAPI], [varnishapi])
AC_SUBST([VARNISH_VERSION], [$($PKG_CONFIG --modversion varnishapi)])
PKG_CHECK_VAR([VARNISHAPI_PREFIX], [varnishapi], [prefix])
PKG_CHECK_VAR([VARNISHAPI_DATAROOTDIR], [varnishapi], [datarootdir])
PKG_CHECK_VAR([VARNISHAPI_LIBDIR], [varnishapi], [libdir])
PKG_CHECK_VAR([VARNISHAPI_BINDIR], [varnishapi], [bindir])
PKG_CHECK_VAR([VARNISHAPI_SBINDIR], [varnishapi], [sbindir])
PKG_CHECK_VAR([VARNISHAPI_VCLDIR], [varnishapi], [vcldir])
PKG_CHECK_VAR([VARNISHAPI_VMODDIR], [varnishapi], [vmoddir])
PKG_CHECK_VAR([VMODTOOL], [varnishapi], [vmodtool])
PKG_CHECK_VAR([VSCTOOL], [varnishapi], [vsctool])
AC_SUBST([VARNISH_LIBRARY_PATH],
[$VARNISHAPI_LIBDIR:$VARNISHAPI_LIBDIR/varnish])
AC_SUBST([VARNISH_TEST_PATH],
[$VARNISHAPI_SBINDIR:$VARNISHAPI_BINDIR:$PATH])
dnl Inherit Varnish's prefix if undefined
dnl Also the libdir for multi-lib systems
if test "$prefix" = NONE
then
ac_default_prefix=$VARNISHAPI_PREFIX
libdir=$VARNISHAPI_LIBDIR
fi
dnl Define the VCL directory for automake
vcldir=$($PKG_CONFIG --define-variable=datadir=$datadir \
--variable=vcldir varnishapi)
AC_SUBST([vcldir])
dnl Define the VCL directory for this package
AC_SUBST([pkgvcldir], [\${vcldir}/\${PACKAGE}])
])
# _VARNISH_CHECK_DEVEL
# --------------------
AC_DEFUN([_VARNISH_CHECK_DEVEL], [
AC_REQUIRE([_VARNISH_PKG_CONFIG])
AC_REQUIRE([_VARNISH_CHECK_EXPLICIT_BZERO])
[_orig_cppflags=$CPPFLAGS]
[CPPFLAGS=$VARNISHAPI_CFLAGS]
AC_CHECK_HEADERS([vsha256.h cache/cache.h], [],
[AC_MSG_ERROR([Missing Varnish development files.])])
[CPPFLAGS=$_orig_cppflags]
])
# _VARNISH_CHECK_PYTHON
# ---------------------
AC_DEFUN([_VARNISH_CHECK_PYTHON], [
m4_define_default([_AM_PYTHON_INTERPRETER_LIST],
[python3.9 python3.8 python3.7 python3.6 python3.5 python3.4 python2.7 dnl
python python2 python3])
AM_PATH_PYTHON([2.7], [], [
AC_MSG_ERROR([Python >= 2.7 is required.])
])
])
# _VARNISH_VMOD_LDFLAGS
# ---------------------
AC_DEFUN([_VARNISH_VMOD_LDFLAGS], [
AC_SUBST([VMOD_LDFLAGS],
"-module -export-dynamic -avoid-version -shared")
])
# _VARNISH_VMOD_CONFIG
# --------------------
AC_DEFUN([_VARNISH_VMOD_CONFIG], [
AC_REQUIRE([_VARNISH_PKG_CONFIG])
AC_REQUIRE([_VARNISH_CHECK_DEVEL])
AC_REQUIRE([_VARNISH_CHECK_PYTHON])
AC_REQUIRE([_VARNISH_VMOD_LDFLAGS])
dnl Check the VMOD toolchain
AC_REQUIRE([AC_LANG_C])
AC_REQUIRE([AC_PROG_CC_C99])
AC_REQUIRE([AC_PROG_CPP])
AC_REQUIRE([AC_PROG_CPP_WERROR])
AS_IF([test -z "$RST2MAN"], [
AC_MSG_ERROR([rst2man is needed to build VMOD manuals.])
])
dnl Expose the location of the std and directors VMODs
AC_SUBST([VARNISHAPI_VMODDIR])
dnl Expose Varnish's aclocal directory to automake
AC_SUBST([VARNISHAPI_DATAROOTDIR])
dnl Define the VMOD directory for libtool
vmoddir=$($PKG_CONFIG --define-variable=libdir=$libdir \
--variable=vmoddir varnishapi)
AC_SUBST([vmoddir])
dnl Define an automake silent execution for vmodtool
[am__v_VMODTOOL_0='@echo " VMODTOOL" $''@;']
[am__v_VMODTOOL_1='']
[am__v_VMODTOOL_='$(am__v_VMODTOOL_$(AM_DEFAULT_VERBOSITY))']
[AM_V_VMODTOOL='$(am__v_VMODTOOL_$(V))']
AC_SUBST([am__v_VMODTOOL_0])
AC_SUBST([am__v_VMODTOOL_1])
AC_SUBST([am__v_VMODTOOL_])
AC_SUBST([AM_V_VMODTOOL])
dnl Substitute an alias for compatibility reasons
AC_SUBST([VMOD_TEST_PATH], [$VARNISH_TEST_PATH])
])
# _VARNISH_VMOD(NAME)
# -------------------
AC_DEFUN([_VARNISH_VMOD], [
AC_REQUIRE([_VARNISH_VMOD_CONFIG])
VMOD_FILE="\$(abs_builddir)/.libs/libvmod_$1.so"
AC_SUBST(m4_toupper(VMOD_$1_FILE), [$VMOD_FILE])
VMOD_IMPORT="$1 from \\\"$VMOD_FILE\\\""
AC_SUBST(m4_toupper(VMOD_$1), [$VMOD_IMPORT])
dnl Define the VCL directory for automake
AC_SUBST([vmod_$1_vcldir], [\${vcldir}/$1])
VMOD_RULES="
vmod_$1.lo: vcc_$1_if.c vcc_$1_if.h
vmod_$1.lo: \$(nodist_libvmod_$1_la_SOURCES)
vcc_$1_if.h vmod_$1.rst vmod_$1.man.rst: vcc_$1_if.c
vcc_$1_if.c: vmod_$1.vcc
\$(A""M_V_VMODTOOL) \$(PYTHON) \$(VMODTOOL) -o vcc_$1_if \$(srcdir)/vmod_$1.vcc
vmod_$1.3: vmod_$1.man.rst
\$(A""M_V_GEN) \$(RST2MAN) vmod_$1.man.rst vmod_$1.3
clean: clean-vmod-$1
distclean: clean-vmod-$1
clean-vmod-$1:
rm -f vcc_$1_if.c vcc_$1_if.h
rm -f vmod_$1.rst vmod_$1.man.rst vmod_$1.3
"
AC_SUBST(m4_toupper(BUILD_VMOD_$1), [$VMOD_RULES])
m4_ifdef([_AM_SUBST_NOTMAKE],
[_AM_SUBST_NOTMAKE(m4_toupper(BUILD_VMOD_$1))])
])
# VARNISH_VMODS(NAMES)
# --------------------
# Since: Varnish 4.1.4
#
# Since Varnish 5.1.0:
# - vmod_*_vcldir added
#
# Set up the VMOD tool-chain to build the collection of NAMES modules. The
# definition of key variables is made available for use in Makefile rules
# to build the modules:
#
# - VMOD_LDFLAGS (the recommended flags to link VMODs)
# - VMOD_TEST_PATH (an alias for VARNISH_TEST_PATH)
# - VMODTOOL (to generate a VMOD's interface)
# - vmoddir (the install prefix for VMODs)
# - vmod_*_vcldir (the install prefix for the VMODs VCL files)
#
# Configuring your VMOD build with libtool can be as simple as:
#
# AM_CFLAGS = $(VARNISHAPI_CFLAGS)
# AM_LDFLAGS = $(VARNISHAPI_LIBS) $(VMOD_LDFLAGS)
#
# vmod_LTLIBRARIES = libvmod_foo.la
#
# [...]
#
# Turnkey build rules are generated for each module, they are provided as
# a convenience mechanism but offer no means of customizations. They make
# use of the VMODTOOL variable automatically.
#
# For example, if you define the following in configure.ac:
#
# VARNISH_VMODS([foo bar])
#
# Two build rules will be available for use in Makefile.am for vmod-foo
# and vmod-bar:
#
# vmod_LTLIBRARIES = libvmod_foo.la libvmod_bar.la
#
# [...]
#
# @BUILD_VMOD_FOO@
# @BUILD_VMOD_BAR@
#
# These two set of make rules are independent and may be used in separate
# sub-directories. You still need to declare the generated VCC interfaces
# in your library's sources. The generated files should be declared this
# way:
#
# nodist_libvmod_foo_la_SOURCES = vcc_foo_if.c vcc_foo_if.h
# nodist_libvmod_bar_la_SOURCES = vcc_bar_if.c vcc_bar_if.h
#
# The generated rules also build the manual page, all you need to do is to
# declare the generated pages:
#
# dist_man_MANS = vmod_foo.3 vmod_bar.3
#
# However, it requires RST2MAN to be defined beforehand in configure.ac
# and it is for now the VMOD's maintainer job to manage it. On the other
# hand python detection is done and the resulting PYTHON variable to use
# the VMODTOOL. Since nothing requires RST2MAN to be written in python, it
# is left outside of the scope. You may even define a phony RST2MAN to
# skip man page generation as it is often the case from a dist archive
# (usually /bin/true when the manual is distributed).
#
# Two notable variables are exposed from Varnish's pkg-config:
#
# - VARNISHAPI_VMODDIR (locate vmod-std and vmod-directors in your tests)
# - VARNISHAPI_DATAROOTDIR (for when aclocal is called from a Makefile)
#
# For example in your root Makefile.am:
#
# ACLOCAL_AMFLAGS = -I m4 -I ${VARNISHAPI_DATAROOTDIR}/aclocal
#
# The VARNISH_VERSION variable will be set even if the VARNISH_PREREQ macro
# wasn't called. Although many things are set up to facilitate out-of-tree
# VMOD maintenance, initialization of autoconf, automake and libtool is
# still the maintainer's responsibility. It cannot be avoided.
#
# Once your VMOD is built, you can use varnishtest to run test cases. For
# that you can rely on automake's default test driver, and all you need
# is a minimal setup:
#
# AM_TESTS_ENVIRONMENT = \
# PATH="$(VARNISH_TEST_PATH):$(PATH)" \
# LD_LIBRARY_PATH="$(VARNISH_LIBRARY_PATH)"
# TEST_EXTENSIONS = .vtc
# VTC_LOG_COMPILER = varnishtest -v
# AM_VTC_LOG_FLAGS = -Dvmod_foo="$(VMOD_FOO)" -Dvmod_bar="$(VMOD_BAR)"
#
# Setting up the different paths is mostly relevant when you aren't building
# against the system installation of Varnish. In the case of the PATH, you
# may also need to preserve the original PATH if you run commands outside of
# the Varnish distribution in your test cases (as shown above).
#
# The $(VMOD_*) variables contain a proper import statement if the relevant
# VMOD was built in the same directory as the test runner. With the example
# above you could import VMODs this way in a test case:
#
# varnish v1 -vcl+backend {
# import std;
# import ${vmod_bar};
#
# [...]
# } -start
#
# Once your test suite is set up, all you need is to do is declare your test
# cases and `make check` will work out of the box.
#
# TESTS = <your VTC files>
#
# At this point almost everything is taken care of, and your autotools-based
# build is ready for prime time. However if you want your VMODs to build and
# run the test suite from a dist archive, don't forget to embed your VCC
# file and the test cases:
#
# EXTRA_DIST = vmod_foo.vcc vmod_bar.vcc $(TESTS)
#
# If a VMOD is actually a combination of both a library and VCL sub-routines,
# automake directories are available for installation:
#
# vmod_foo_vcl_DATA = some_addition.vcl
#
# This way the end-user's VCL only needs few lines of code to start using both
# VMODs and VCLs assuming Varnish's default vmod_path and vcl_path were not
# changed:
#
# vcl 4.0;
#
# import foo;
# import bar;
#
# include "foo/some_addition.vcl";
#
# Now, you can focus on writing this VMOD of yours.
#
AC_DEFUN([VARNISH_VMODS], [
m4_foreach([_vmod_name],
m4_split(m4_normalize([$1])),
[_VARNISH_VMOD(_vmod_name)])
])
# _VARNISH_VSC_CONFIG
# --------------------
AC_DEFUN([_VARNISH_VSC_CONFIG], [
AC_REQUIRE([_VARNISH_PKG_CONFIG])
AC_REQUIRE([_VARNISH_CHECK_DEVEL])
AC_REQUIRE([_VARNISH_CHECK_PYTHON])
dnl Define an automake silent execution for vmodtool
[am__v_VSCTOOL_0='@echo " VSCTOOL " $''@;']
[am__v_VSCTOOL_1='']
[am__v_VSCTOOL_='$(am__v_VSCTOOL_$(AM_DEFAULT_VERBOSITY))']
[AM_V_VSCTOOL='$(am__v_VSCTOOL_$(V))']
AC_SUBST([am__v_VSCTOOL_0])
AC_SUBST([am__v_VSCTOOL_1])
AC_SUBST([am__v_VSCTOOL_])
AC_SUBST([AM_V_VSCTOOL])
])
# _VARNISH_COUNTER(NAME)
# ----------------------
AC_DEFUN([_VARNISH_COUNTER], [
AC_REQUIRE([_VARNISH_VSC_CONFIG])
VSC_RULES="
VSC_$1.h: $1.vsc
\$(A""M_V_VSCTOOL) \$(PYTHON) \$(VSCTOOL) -h \$(srcdir)/$1.vsc
VSC_$1.c: $1.vsc
\$(A""M_V_VSCTOOL) \$(PYTHON) \$(VSCTOOL) -c \$(srcdir)/$1.vsc
VSC_$1.rst: $1.vsc
\$(A""M_V_VSCTOOL) \$(PYTHON) \$(VSCTOOL) -r \$(srcdir)/$1.vsc >VSC_$1.rst
clean: clean-vsc-$1
distclean: clean-vsc-$1
clean-vsc-$1:
rm -f VSC_$1.h VSC_$1.c VSC_$1.rst
"
AC_SUBST(m4_toupper(BUILD_VSC_$1), [$VSC_RULES])
m4_ifdef([_AM_SUBST_NOTMAKE],
[_AM_SUBST_NOTMAKE(m4_toupper(BUILD_VSC_$1))])
])
# VARNISH_COUNTERS(NAMES)
# -----------------------
# Since: Varnish 6.0.0
#
# In order to manipulate custom counters that tools like varnishstat can
# report, it is possible to do that via a VMOD. This macro allows you
# to declare sets of counters, but does not associates them automatically
# with their respective VMODs:
#
# VARNISH_UTILITIES([foo bar])
#
# Two build rules will be available for use in Makefile.am for the counters
# foo and bar:
#
# @BUILD_VSC_FOO@
# @BUILD_VSC_BAR@
#
# They take care of turning VSC_foo.vsc and VCS_bar.vcs into C code and
# RST documentation.
#
# Just like the vcc_*_if.[ch] files, you need to manually add the generated
# sources to the appropriate VMODs:
#
# nodist_libvmod_baz_la_SOURCES = \
# vcc_baz_if.c \
# vcc_baz_if.h \
# VSC_foo.c \
# VSC_foo.h
#
# You can then include the counters documentation somewhere in the VMOD's
# VCC descriptor:
#
# .. include:: VSC_foo.rst
#
# That should be all you need to do to start implementing custom counters.
#
AC_DEFUN([VARNISH_COUNTERS], [
m4_foreach([_vsc_name],
m4_split(m4_normalize([$1])),
[_VARNISH_COUNTER(_vsc_name)])
])
# _VARNISH_UTILITY(NAME)
# ----------------------
AC_DEFUN([_VARNISH_UTILITY], [
VUT_RULES="
$1_synopsis.rst: $1
\$(A""M_V_GEN) ./$1 --synopsis >$1_synopsis.rst
$1_options.rst: $1
\$(A""M_V_GEN) ./$1 --options >$1_options.rst
$1.rst: $1_synopsis.rst $1_options.rst
clean: clean-vut-$1
distclean: clean-vut-$1
clean-vut-$1:
rm -f $1_synopsis.rst $1_options.rst
"
AC_SUBST(m4_toupper(GENERATE_$1_DOCS), [$VUT_RULES])
m4_ifdef([_AM_SUBST_NOTMAKE],
[_AM_SUBST_NOTMAKE(m4_toupper(GENERATE_$1_DOCS))])
])
# VARNISH_UTILITIES(NAMES)
# ------------------------
# Since: Varnish 5.2.0
#
# To write programs that consume the VSM, and in particular the VSL, it is
# possible since Varnish 5.2.0 to use the VUT (Varnish UTility) API already
# used by varnishlog, varnishstat and the other utilities from the standard
# Varnish distribution.
#
# This API can optionally be used to generate part of the manual: the synopsis
# and the list of options. The generated RST files can then be included from
# the main RST file that is written manually.
#
# For example, if you define the following in configure.ac:
#
# VARNISH_UTILITIES([foo bar])
#
# Two build rules will be available for use in Makefile.am for the programs
# foo and bar:
#
# bin_PROGRAMS = foo bar
#
# [...]
#
# @GENERATE_FOO_DOCS@
# @GENERATE_BAR_DOCS@
#
# If the API is used in a way that enables the generation of the synopsis and
# the list of options, they will automatically be regenerated whenever the foo
# and bar programs are rebuilt, and marked as dependencies for RST manuals
# named foo.rst and bar.rst.
#
# In the manual you can then include the generated documentation in the
# relevant sections:
#
# SYNOPSIS
# ========
#
# .. include:: foo_synopsis.rst
# foo |synopsis|
#
# DESCRIPTION
# ===========
#
# [...]
#
# The following options are available:
#
# .. include:: foo_options.rst
#
# This however won't work in a VPATH build, so instead of authoring foo.rst
# and bar.rst, a better solution is to create foo.rst.in and bar.rst.in files
# and add them to the AC_CONFIG_FILES macro in configure.ac. For example, if
# foo.rst.in and bar.rst.in are located in the src/ directory:
#
# AC_CONFIG_FILES([
# [...]
# src/foo.rst
# src/bar.rst
# ])
#
# Then you can include the build directory, either relative or absolute, to
# the include directives:
#
# SYNOPSIS
# ========
#
# .. include:: @builddir@/foo_synopsis.rst
# foo |synopsis|
#
# DESCRIPTION
# ===========
#
# [...]
#
# The following options are available:
#
# .. include:: @builddir@/foo_options.rst
#
# This will ensure that foo.rst and bar.rst always find the generated files
# when the source directory is different from the build directory. It is the
# maintainer's responsibility to build the actual manuals.
#
AC_DEFUN([VARNISH_UTILITIES], [
m4_foreach([_vut_name],
m4_split(m4_normalize([$1])),
[_VARNISH_UTILITY(_vut_name)])
])
# VARNISH_PREREQ(MINIMUM-VERSION, [MAXIMUM-VERSION])
# --------------------------------------------------
# Since: Varnish 4.1.4
#
# Since Varnish 5.1.0:
# - VARNISH_TEST_PATH added
# - VARNISH_LIBRARY_PATH added
# - VARNISHAPI_LIBDIR added
# - VARNISHAPI_VCLDIR added
# - vcldir added
# - pkgvcldir added
#
# Since Varnish 5.2.0:
# - VSCTOOL added
#
# Verify that the version of Varnish Cache found by pkg-config is at least
# MINIMUM-VERSION. If MAXIMUM-VERSION is specified, verify that the version
# is strictly below MAXIMUM-VERSION.
#
# Once the requirements are met, the following variables can be used in
# Makefiles:
#
# - VARNISH_TEST_PATH (for the test suite environment)
# - VARNISH_LIBRARY_PATH (for both public and private libraries)
# - VARNISH_VERSION (also available in autoconf)
#
# The following variables are available in autoconf, read from the varnish
# pkg-config:
#
# - VARNISHAPI_CFLAGS
# - VARNISHAPI_LIBS
# - VARNISHAPI_PREFIX
# - VARNISHAPI_DATAROOTDIR
# - VARNISHAPI_LIBDIR
# - VARNISHAPI_BINDIR
# - VARNISHAPI_SBINDIR
# - VARNISHAPI_VCLDIR
# - VARNISHAPI_VMODDIR
# - VMODTOOL
# - VSCTOOL
#
# In addition, two directories are set up for installation in automake:
#
# - vcldir
# - pkgvcldir
#
# The vcldir is where Varnish will by default look up VCL files using relative
# paths not found in its sysconfdir (by default /etc/varnish). The pkgvcldir on
# the other hand is a recommended location for your package's VCL files, it
# defaults to "${vcldir}/${PACKAGE}".
#
# This provides a namespace facility for installed VCL files needing including
# other VCL files, which can be overridden if the package name is not desired.
#
AC_DEFUN([VARNISH_PREREQ], [
AC_REQUIRE([_VARNISH_PKG_CONFIG])
AC_REQUIRE([_VARNISH_CHECK_EXPLICIT_BZERO])
AC_MSG_CHECKING([for Varnish])
AC_MSG_RESULT([$VARNISH_VERSION])
AS_VERSION_COMPARE([$VARNISH_VERSION], [$1], [
AC_MSG_ERROR([Varnish version $1 or higher is required.])
])
test $# -gt 1 &&
AS_VERSION_COMPARE([$2], [$VARNISH_VERSION], [
AC_MSG_ERROR([Varnish version below $2 is required.])
])
])